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: v4
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/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. |
/v4/jobGroups/<id>?embed=jobs,wrangledDataset
Query parameter reference:
The following query parameters can be submitted with this endpoint:
| Query Parameter | Data Type | Description |
|---|---|---|
| embed | string | Comma-separated list of objects to include part of the response. |
| includeDeleted | string | If set to |
For more information, see API Common Query Parameters v4.
Request URI - Example:/v4/jobGroups/8
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{
"id": 8,
"name": null,
"description": null,
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2018-01-25T18:01:15.000Z",
"createdAt": "2018-01-25T18:01:16.456Z",
"updatedAt": "2018-01-25T18:01:21.082Z",
"workspace": {
"id": 1
},
"creator": {
"id": 1
},
"updater": {
"id": 1
},
"snapshot": {
"id": 8
},
"wrangledDataset": {
"id": 12
},
"flowRun": null
}
Response Body Example with embedded reference:
The following example response includes embedded information on jobs and the recipe associated with it.
{
"id": 8,
"name": null,
"description": null,
"ranfrom": "ui",
"ranfor": "recipe",
"status": "Complete",
"profilingEnabled": true,
"runParameterReferenceDate": "2018-01-25T18:01:15.000Z",
"createdAt": "2018-01-25T18:01:16.456Z",
"updatedAt": "2018-01-25T18:01:21.082Z",
"jobs": {
"data": [
{
"id": 2,
"createdAt": "2018-01-25T18:01:16.687Z",
"updatedAt": "2018-01-25T18:01:21.071Z",
"status": "Complete",
"jobType": "filewriter",
"sampleSize": 100,
"percentComplete": 100,
"creator": {
"id": 1
},
"jobGroup": {
"id": 1
},
"errorMessage": null,
"scriptResult": {
"id": 1
},
"writeSetting": {
"id": 2
}
},
{
"id": 1,
"executionLanguage": "<running_environment_name>",
"cpJobId": null,
"templateLocation": null,
"createdAt": "2018-01-25T18:01:16.652Z",
"updatedAt": "2018-01-25T18:01:19.558Z",
"status": "Complete",
"jobType": "wrangle",
"sampleSize": 100,
"percentComplete": 100,
"creator": {
"id": 1
},
"jobGroup": {
"id": 1
},
"errorMessage": null,
"wrangleScript": {
"id": 9
}
}
]
},
"wrangledDataset": {
"id": 12,
"wrangled": true,
"referenceName": null,
"referenceDescription": null,
"createdAt": "2018-01-25T17:53:54.703Z",
"updatedAt": "2018-01-25T17:53:54.741Z",
"activeSample": {
"id": 12
},
"creator": {
"id": 1
},
"updater": {
"id": 1
},
"recipe": {
"id": 12
},
"flow": {
"id": 4
}
},
"workspace": {
"id": 1
},
"creator": {
"id": 1
},
"updater": {
"id": 1
},
"snapshot": {
"id": 8
},
"flowRun": null
}
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:
|
| ranfor | Description of the object for which the job was run:
|
| status | Current status of the job group: Tip: Monitor the value in this field to get status on the specific jobGroup in progress.
|
| profilingEnabled | When true, a profiling job was executed as part of this job group. |
| runParameterReferenceDate | When a recipe is executed with dynamic parameters, this parameter is stored with the timestamp at the time of execution. It can be used in debugging execution issues. Do not modify this value. |
| createdAt | Timestamp for when the job group was launched |
| updatedAt | Timestamp for when the job group was last updated |
| jobs | A list of all jobs that were launched based on this job group.For more information, see API JobGroups Get Jobs v4. |
| wrangledDataset | Internal identifier of the object from where the job group was executed.For more information, see API WrangledDatasets Get v4. |
| workspace.id | Internal identifier for the workspace where the job was executed |
| creator.id | Internal identifier for the user who created the job group |
| updater.id | Internal identifier for the user who last updated the job group |
| snapshot.id | Internal identifier of the data snapshot for the job group |
| flowRun | NOTE: This parameter is used for internal platform purposes. Do not modify. |
This page has no comments.