Contents:
Get list of all jobGroups accessible to the authenticated user.
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.0/index.html#section/Authentication.
Request
Request Type: GET
Endpoint:
/v4/jobGroups
Endpoint with embedded reference:
/v4/jobGroups/?embed=jobs,wrangledDataset
For more information, see API JobGroups Get v4.
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:
/v4/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": 20,
"status": "Complete",
"ranfrom": "ui",
"ranfor": "recipe",
"createdAt": "2019-02-11T23:55:31.804Z",
"profilingEnabled": true,
"updatedAt": "2019-02-11T23:55:35.445Z",
"runParameterReferenceDate": "2019-02-11T23:55:31.000Z",
"name": null,
"wrangledDataset": {
"id": 45,
"flow": {
"id": 11,
"name": "2013 POS",
"associatedPeople": {
"data": [
{
"id": 1,
"isAdmin": true,
"flowPermission": {
"role": "owner",
"person": {
"id": 1
},
"flow": {
"id": 11
}
}
}
]
}
}
},
"jobGroupRunParameterOverrides": {
"data": []
},
"runParameterEdits": {
"data": []
},
"creator": {
"id": 1
},
"updater": {
"id": 1
}
},
{
"id": 2,
"status": "Complete",
"ranfrom": "ui",
"ranfor": "recipe",
"createdAt": "2019-02-11T11:49:44.642Z",
"profilingEnabled": true,
"updatedAt": "2019-02-11T11:51:30.325Z",
"runParameterReferenceDate": "2019-02-11T11:49:44.000Z",
"name": null,
"wrangledDataset": {
"id": 8
},
"jobGroupRunParameterOverrides": {
"data": []
},
"runParameterEdits": {
"data": []
},
"creator": {
"id": 3
},
"updater": {
"id": 3
}
}
]
}
Reference
Some properties related to the jobGroup appear only in this endpoint. They are listed below.
For more information on the properties of a jobGroup, see API JobGroups Get v4.
| Property | Description |
|---|---|
| wrangledDataset.flow.id | Internal identifier for the flow containing the recipe that was executed with the job. |
| wrangledDataset.flow.name | Name of the flow containing the recipe that was executed with the job. |
| wrangledDataset.flow.associatedPeople.* | All users who have access to the flow and their roles |
| jobGroupRunParameterOverrides.* | These values define any parameter overrides that were applied during the job in the following key-value form: "jobGroupRunParameterOverrides": {
"data": [
{
"value": {
"variable": {
"value": "basic_types1"
}
},
"id": 1,
"overrideKey": "name",
"isImplicit": false,
"createdAt": "2018-03-21T06:56:57.042Z",
"updatedAt": "2018-03-21T06:56:57.042Z",
"jobGroup": {
"id": 93
}
}
]
},
|
| runParameterEdits.* |
|
This page has no comments.