Contents:
Create a jobGroup, which launches the specified job as the authenticated user.
The request specification depends on one of the following conditions:
- Dataset has already had a job run against it and just needs to be re-run.
- Dataset has not had a job run, or the job definition needs to be re-specified.
NOTE: Override values applied to a job are not validated. Invalid overrides may cause your job to fail.
NOTE: In this release, you cannot execute jobs sourced from datasets in Redshift or SQL DW or publish to these locations via the API. This known issue will be fixed in a future release.
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: POST
Endpoint:
/v4/jobGroups
Request Body - Run job:
To run a job, you just specify the recipe identifier (wrangledDataset.id). If the job is successful, all defined outputs are generated, as defined in the outputobject, publications, and writesettings objects associated with the recipe.
{
"wrangledDataset": {
"id": 7
}
}
Request Body - Specify job:
If you must change some outputs or other settings for the specific job, you can insert these changes in the overrides section of the request. Below, the running environment (photon), profiling option, and writesettings for the job are modified for this execution:
{
"wrangledDataset": {
"id": 33
},
"overrides": {
"execution": "photon",
"profiler": false,
"writesettings": [
{
"path": "hdfs://hadoop:50070/trifacta/queryResults/admin@trifacta.local/cdr_txt.csv",
"action": "create",
"format": "csv",
"compression": "none",
"header": false,
"asSingleFile": false
}
]
},
"runParameters": {
"overrides": {
"data": [{
"key": "varRegion",
"value": "02"
}
]}
},
"ranfrom": "cli"
}
Request Body - Specify job for dataset with parameters:
If you have created a dataset with parameters, you can specify overrides for parameter values during execution through the APIs. Through this method, you can iterate job executions across all matching sources of a parameterized dataset. For more information on creating datasets with parameters, see Overview of Parameterization.
In the following, the runParameters overrides have been specified for the varRegion and the varReferenceType variables.
{
"wrangledDataset": {
"id": 33
},
"overrides": {
"writesettings": [
{
"path": "<path_to_output_file>",
"action": "create",
"format": "csv",
"compression": "none",
"header": false,
"asSingleFile": false
}
]
},
"runParameters": {
"overrides": {
"data": [{
"key": "Region",
"value": "02"
},
{
"key": "varReferenceType",
"value": "PROD"
}
]
}
},
"ranfrom": "ui"
}
Response
Response Status Code - Success: 201 - Created
Response Body Example:
{
"reason": "JobStarted",
"sessionId": "eb3e98e0-02e3-11e8-a819-25c9559a2a2c",
"id": 9
}
Reference
Request Reference:
| Property | Description |
|---|---|
wrangledDataset | (required) Internal identifier for the object whose results you wish to generate. The recipes of all preceding datasets on which this dataset depends are executed as part of the job. |
overrides.execution | (required, if first time running the job) Indicates the running environment on which the job is executed. Accepted values:
For more information, see Running Environment Options. |
overrides.profiler | (required, if first time running the job) When set to |
overrides.writesettings | (required, if first time running the job) These settings define the publishing options for the job. |
ranfrom | (optional) If this value is set to If set to See Job Details Page. |
Response reference:
| Property | Description |
|---|---|
| reason | Current state of the job group at time of API call. Since this call creates the job group, this value is always Job started in the response to this call. |
| sessionId | Session identifier for the job group. |
| id | Internal identifier of the job group. |
This page has no comments.