Contents:
Get information on the specified job group. A job group is a job that is executed from a specific node in a flow. The job group may contain:
- Wrangling job on the dataset associated with the node
- Jobs on all datasets on which the selected job may depend
- A profiling job for the job group
Version: v3
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/5.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v3/jobGroups/<id>
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the job group |
Endpoint with embedded references:
Use the following endpoint to embed additional information:
| Embed Parameter | Description |
|---|---|
| jobs | Embed information about the child jobs within the job group. Array includes information on transformation, profiling, and publishing jobs that are part of the job group. |
| wrangledDataset | This field contains the internal identifier for the dataset on which the job was run. |
/v3/jobGroups/<id>?embed=jobs,wrangledDataset
Request URI - Example:
/v3/jobGroups/8
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"id": 8,
"name": null,
"description": null,
"ranfrom": "ui",
"status": "Complete",
"profilingEnabled": true,
"createdAt": "2017-01-31T19:59:23.804Z",
"updatedAt": "2017-01-31T20:00:28.278Z",
"createdBy": 2,
"updatedBy": 2,
"wrangledDataset": {
"id": 92
},
"snapshot": {
"id": 53
},
"wrangleScript": {
"id": 60
},
"jobs": {
"data": null
}
}
Response Body Example with embedded reference:
The following example response includes embedded information on jobs and the recipe associated with it.
{
"id": 11,
"name": null,
"description": null,
"ranfrom": "ui",
"status": "Complete",
"profilingEnabled": true,
"createdAt": "2017-02-22T23:24:46.247Z",
"updatedAt": "2017-02-22T23:24:48.627Z",
"createdBy": 1,
"updatedBy": 1,
"wrangledDataset": {
"id": 118,
"wrangled": true,
"createdAt": "2017-02-22T22:54:13.782Z",
"updatedAt": "2017-02-22T22:54:22.107Z",
"createdBy": 1,
"updatedBy": 1,
"activeSample": {
"id": 56
},
"flow": {
"id": 29
},
"script": {
"id": 107
}
},
"snapshot": {
"id": 65
},
"wrangleScript": {
"id": 79
},
"jobs": {
"data": [
{
"id": 23,
"jobId": 23,
"writesettingId": 12,
"scriptresultId": 41,
"createdAt": "2017-02-22T23:24:46.789Z",
"updatedAt": "2017-02-22T23:24:48.618Z",
"status": "Complete",
"jobType": "filewriter",
"sampleSize": 100,
"percentComplete": 100,
"cpJobId": null,
"createdBy": 1,
"errorMessage": null,
"jobGroup": {
"id": 11
}
},
{
"id": 22,
"executionLanguage": "photon",
"jobId": 22,
"createdAt": "2017-02-22T23:24:46.740Z",
"updatedAt": "2017-02-22T23:24:48.426Z",
"wranglescriptId": 80,
"status": "Complete",
"jobType": "wrangle",
"sampleSize": 100,
"percentComplete": 100,
"cpJobId": null,
"createdBy": 1,
"errorMessage": null,
"jobGroup": {
"id": 11
}
}
]
}
}
Reference
| Property | Description |
|---|---|
| id | Internal identifier for the job group |
| name | Internal name of the job group |
| description | User-friendly description for the job group |
| ranfrom | Where the job group was executed from:
|
| status | Current status of the job group:
|
| profilingEnabled | When true, a profiling job was executed as part of this job group. |
| createdAt | Timestamp for when the job group was launched |
| updatedAt | Timestamp for when the job group was last updated |
| createdBy | Internal identifier for the user who created the job group |
| updatedBy | Internal identifier for the user who last updated the job group |
| wrangledDataset | Internal identifier of the object from where the job group was executed. |
| snapshot | Internal identifier of the data snapshot for the job group |
| wrangleScript | Internal identifier of the Wrangle script to execute for the job group |
| jobs | A list of all jobs that were launched based on this job group |
This page has no comments.