| D toc |
|---|
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.
| Info |
|---|
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: v3
Required Permissions
| D s api auth |
|---|
Request
Request Type: POST
Endpoint:
| Code Block |
|---|
/v3/jobGroups |
Request Body - Re-run job:
If you are re-running a job that has already executed and do not need to modify any job settings, you can use the following simplified body to launch it:
| Code Block |
|---|
{
"wrangledDataset": {
"id": 7
}
} |
Request Body - Specify job:
If you are specifying a new job or must re-run a job with new settings, you must include a version of the following request body. Required parameters are listed below:
| Code Block |
|---|
{
"wrangledDataset": {
"id": 1
},
"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
}
]
},
"ranfrom": "cli"
} |
Response
Response Status Code - Success: 201 - Created
Response Body Example:
| Code Block |
|---|
{
"jobgroupId": 3,
"jobIds": [
5,
6
],
"reason": "JobStarted",
"sessionId": "9c2c6220-ef2d-11e6-b644-6dbff703bdfc"
} |
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. See below. |
ranfrom | (optional) If this value is set to If set to See Job Results Page. |
writesettings Reference:
The writesettings values allow you to specify aspects of the publication of results to the specified path location.
| Info |
|---|
NOTE: |
| Info |
|---|
NOTE: To specify multiple outputs, you can include additional |
These settings correspond to values that you can apply through the UI or through the command line interface.
- For UI information, see Run Job Page.
- For CLI information, see CLI for Jobs.
| Property | Description | ||||
|---|---|---|---|---|---|
path | (required) The fully qualified path to the output location where to write the results | ||||
action | (required) If the output file or directory exists, you can specify one of the following actions:
| ||||
format | (required) Output format for the results. Specify one of the following values:
| ||||
compression | (optional) For csv and json results, you can optionally compress them using bzip2 or gzip compression. Default is none. | ||||
header | (optional) For csv results with action set to create or append, this value determines if a header row with column names is inserted at the top of the results. Default is false. | ||||
asSingleFile | (optional) For csv and json results, this value determines if the results are concatenated into a single file or stored as multiple files. Default is false. |
