API Task - Run Job

Get authentication credentials. As part of each request, you must pass in authentication credentials to the platform. For more information, see Manage API Access Tokens.

For more information, see Designer Cloud Powered by Trifacta: API Reference docs

Verify job execution. Run the desired job through the Trifacta Application and verify that the output objects are properly generated.

Acquire recipe (wrangled dataset) identifier. In Flow View, click the icon for the recipe whose outputs you wish to generate. Acquire the numeric value for the recipe from the URL. In the following, the recipe Id is 28629:

http://<platform_base_url>/flows/5479?recipe=28629&tab=recipe

Create output object. A recipe must have at least one output object created for it before you can run a job via APIs. For more information, see Flow View Page.

Acquire the internal identifier for the recipe for which you wish to execute a job. In the previous example, this identifier was 28629.

Construct a request using the following:

<protocol>://<platform_base_url>/v4/jobGroups

POST

Request Body:

{
  "wrangledDataset": {
    "id": 28629
  },
  "overrides": {
    "publications": [
      {
        "path": [
          "prod_db"
        ],
        "tableName": "Table_CaseFctn2",
        "action": "createAndLoad",
        "targetType": "postgres",
        "connectionId": 3
      }
    ]
  },
  "ranfrom": null
}

In the above example, the job has been launched with the following overrides:

1. Output path is to the prod_db database, using table name is Table_CaseFctn2.

2. Output action is "create and load." See above for definitions.

3. Target table type is a PostgreSQL table.

A response code of 201 - Created is returned. The response body should look like the following:

{


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

Retain the id value, which is the job identifier, for monitoring.

Acquire the internal identifier for the recipe for which you wish to execute a job. In the previous example, this identifier was 28629.

Construct a request using the following:

<protocol>://<platform_base_url>/v4/jobGroups

POST

Request Body:

{
  "wrangledDataset": {
    "id": 28629
  },
  "overrides": {
    "webhooks": [{
      "name": "webhook override",
      "url": "http://example.com",
      "method": "post",
      "triggerEvent": "onJobFailure",
      "body": {
        "text": "override" 
       },
      "headers": {
        "testHeader": "val1" 
       },
      "sslVerification": true,
      "secretKey": "123"
  }]
 }
}

In the above example, the job has been launched with the following overrides:

A response code of 201 - Created is returned. The response body should look like the following:

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

Retain the id value, which is the job identifier, for monitoring.

Acquire the internal identifier for the recipe for which you wish to execute a job. In the previous example, this identifier was 28629.

Construct a request using the following:

<protocol>://<platform_base_url>/v4/jobGroups

POST

Request Body:

{
  "wrangledDataset": {
    "id": 28629
  },
  "overrides": {
    "runParameters": {
      "overrides": {
        "data": [
          {
            "key": "varRegion",
            "value": "02"
          }
        ]
      }
    }
  },
  "ranfrom": null
}

In the above example, the specified job has been launched for recipe 28629 . The run parameter varRegion has been set to 02 for this specific job. Depending on how it's defined in the flow, this parameter could influence change either of the following:

1. The source for the imported dataset.

2. The path for the generated output.

3. A flow parameter reference in the recipe

4. For more information, see Overview of Parameterization.

A response code of 201 - Created is returned. The response body should look like the following:

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

Retain the id value, which is the job identifier, for monitoring.