API JobGroups Create v4

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.

Version:  v4

Required Permissions

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": 1
  },
  "overrides": {
    "execution": "photon",
    "profiler": false,
    "writesettings": [
      {
        "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/cdr_txt.csv",
        "action": "create",
        "format": "csv",
        "compression": "none",
        "header": false,
        "asSingleFile": false
      }
    ]
  },
  "ranfrom": "ui"
}

Request Body - Specify job with parameter overrides:

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.

• You can also apply runtime parameters using the same request structure. For more information on creating datasets with parameters, see Overview of Parameterization.

In the following, the runParameters override has been specified for the varRegion. In this case, the value 02 is inserted for the specified variable as part of the job execution.

{
  "wrangledDataset": {
    "id": 33
  },
  "overrides": {
    "execution": "photon",
    "profiler": false,
    "writesettings": [
      {
        "path": "hdfs://hadoop:50070/trifacta/queryResults/admin@example.com/cdr_txt.csv",
        "action": "create",
        "format": "csv",
        "compression": "none",
        "header": false,
        "asSingleFile": false
      }
    ],
    "runParameters": {
      "overrides": {
        "data": [{
          "key": "varRegion",
          "value": "02"
        }
      ]}
    },
  },
  "ranfrom": "ui"
}

Response

Response Status Code - Success:  201 - Created

Response Body Example:

{

    "sessionId": "79276c31-c58c-4e79-ae5e-fed1a25ebca1",
    "reason": "JobStarted",
    "jobGraph": {
        "vertices": [
            21,
            22
        ],
        "edges": [
            {
                "source": 21,
                "target": 22
            }
        ]
    },
    "id": 9,
    "jobs": {
        "data": [
            {
                "id": 21
            },
            {
                "id": 22
            }
        ]
    }
}

Reference

Request Reference:

wrangledDataset

Response reference: