Latest version of this endpoint: API JobGroups Get Jobs v4.
Contents:
Get list of jobs for the specified jobGroup. For more information on jobGroups, see API JobGroups Get v3.
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/6.4/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v3/jobGroups/<id>/jobs
where:
Parameter | Description |
---|---|
<id> | Internal identifier for the job group |
Request URI - Example:
/v3/jobGroups/2/jobs
Request Body:
Empty.
Response
Response Status Code - Success: 200 - OK
Response Body Example:
{ "data": [ { "id": 5, "writeSetting": { "id": 3 }, "scriptResult": { "id": 4 }, "createdAt": "2017-05-05T20:38:15.883Z", "updatedAt": "2017-05-05T20:38:19.411Z", "status": "Complete", "jobType": "filewriter", "sampleSize": 100, "percentComplete": 100, "cpJob": null, "createdBy": 1, "errorMessage": null, "jobGroup": { "id": 3 } }, { "id": 6, "writeSetting": { "id": 4 }, "scriptResult": { "id": 5 }, "createdAt": "2017-05-05T20:38:15.888Z", "updatedAt": "2017-05-05T20:38:19.007Z", "status": "Complete", "jobType": "filewriter", "sampleSize": 100, "percentComplete": 100, "cpJob": null, "createdBy": 1, "errorMessage": null, "jobGroup": { "id": 3 } }, { "id": 4, "executionLanguage": "photon", "createdAt": "2017-05-05T20:38:15.808Z", "updatedAt": "2017-05-05T20:38:18.433Z", "status": "Complete", "jobType": "wrangle", "sampleSize": 100, "percentComplete": 100, "cpJob": null, "createdBy": 1, "errorMessage": null, "jobGroup": { "id": 3 } } ] }
Reference
Property | Description |
---|---|
writeSetting | User-visible output settings. Contents may vary depending on the type of output. |
scriptResult | Internal identifier for job execution. Used by other dependent jobs to identify where to write results to or to collect results from. |
executionLanguage | Indicator for the running environment where the job was executed. Values:
For more information on running environments, see Running Environment Options. |
status | Current status of the job. See API JobGroups Get v3. |
jobType | Type of job. Values:
|
sampleSize | Size of sample as a percentage of the entire dataset. 100 means that the entire dataset is used as the sample. |
percentComplete | Percentage of completion of the job at the time of the request. 100 means that the job has finished or failed. |
createdBy | Internal identifier of the user who launched the job. |
errorMessage | If the job failed, any error message is displayed here. |
For more information on the other properties, see API JobGroups Get v3.
This page has no comments.