Page tree

 

This is the latest version of the APIs.

Contents:


Get list of jobs for the specified jobGroup. For more information on jobGroups, see API JobGroups Get v4.

Version:  v4

Required Permissions

NOTE: Each request to the Trifacta® platform must include authentication credentials. See API Authentication.

Request

Request Type: GET

Endpoint:

/v4/jobGroups/<id>/jobs

where:

ParameterDescription
<id>Internal identifier for the job group

Request URI - Example:

/v4/jobGroups/20/jobs

Request Body:

Empty.

Response

Response Status Code - Success:  200 - OK

Response Body Example:

{
    "data": [
        {
            "id": 41,
            "status": "Complete",
            "jobType": "wrangle",
            "sampleSize": 100,
            "percentComplete": 100,
            "lastHeartbeatAt": "2019-02-11T23:55:32.604Z",
            "createdAt": "2019-02-11T23:55:32.044Z",
            "updatedAt": "2019-02-11T23:55:34.563Z",
            "creator": {
                "id": 1
            },
            "jobGroup": {
                "id": 20
            },
            "errorMessage": null
        },
        {
            "id": 42,
            "status": "Complete",
            "jobType": "filewriter",
            "sampleSize": 100,
            "percentComplete": 100,
            "lastHeartbeatAt": "2019-02-11T23:55:34.676Z",
            "createdAt": "2019-02-11T23:55:32.087Z",
            "updatedAt": "2019-02-11T23:55:35.006Z",
            "creator": {
                "id": 1
            },
            "jobGroup": {
                "id": 20
            },
            "errorMessage": null
        },
        {
            "id": 43,
            "status": "Complete",
            "jobType": "filewriter",
            "sampleSize": 100,
            "percentComplete": 100,
            "lastHeartbeatAt": "2019-02-11T23:55:34.708Z",
            "createdAt": "2019-02-11T23:55:32.089Z",
            "updatedAt": "2019-02-11T23:55:35.439Z",
            "creator": {
                "id": 1
            },
            "jobGroup": {
                "id": 20
            },
            "errorMessage": null
        }
    ]
}

Reference

PropertyDescription
idInternal identifier of the job within the job group.
status
Current status of the job. See API JobGroups Get v4.
jobType

Type of job. Values:

  • filewriter - output results to a specified file
  • ingest - internal job for transferring data into HDFS.
  • profile - job to compute statistical information about set of results.
  • publish - job to publish previously wrangled results to a new destination.
  • wrangle - execute the specified set of Wrangle steps on a dataset.
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.
lastHeartbeatAtTimestamp for last automated status check on the job
createdAtTimestamp for when the job was launched.
updatedAtTimestamp for when the job was last updated.
creator.id
Internal identifier of the user who launched the job.
jobGroup.idInternal identifier for the job group to which the job belongs.
errorMessage
If the job failed, any error message is displayed here.

For more information on the other properties, see API JobGroups Get v4.

This page has no comments.