Page tree

 

As of Release 6.4, the v3 APIs are End of Life (EOL). Before using this release or a later one, you should migrate to using the latest available API version. For more information, see API Version Support Matrix.
Latest version of this endpoint: API JobGroups Get List v4.

Contents:


Get list of all jobGroups accessible to the authenticated user.

Version: v3

Required Permissions

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

Request

Request Type: GET

Endpoint:

/v3/jobGroups

Endpoint with embedded reference:

/v3/jobGroups/?embed=jobs,wrangledDataset

For more information, API JobGroups Get v3.

Endpoint with paged retrieval:


By default, this endpoint returns results in sets of 25. 

You can apply query parameters to change the size of the default set and to page through result sets. The following example queries for results 100 at a time. In this case, the query asks for results 3-102:

/v3/jobGroups/?embed=jobs,wrangledDataset&limit=100&offset=2

If the count of retrieved results is less than the limit, you have reached the end of the results.

Request Body:

Empty.

Response

Response Status Code - Success: 200 - OK

Response Body Example:

{
  "data": [
    {
      "id": 9,
      "name": null,
      "description": null,
      "ranfrom": "ui",
      "status": "InProgress",
      "profilingEnabled": true,
      "createdAt": "2017-01-31T20:01:57.513Z",
      "updatedAt": "2017-01-31T20:01:58.984Z",
      "createdBy": 2,
      "updatedBy": 2,
      "wrangledDataset": {
        "id": 92
      },
      "snapshot": {
        "id": 54
      },
      "wrangleScript": {
        "id": 62
      },
      "jobs": {
        "data": null
      }
    },
    {
      "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
      }
    }
  ]
}

Reference

For more information on the properties of a jobGroup, see API JobGroups Get v3.

This page has no comments.