Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Code Block
{
  "wrangledDataset": {
    "id": 7
  }
}

...

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

Code Block
{
    "wrangledDataset": {
  
 "id": 33   },   "overridesid": {33
    "execution": "photon"},
    "profileroverrides": false,{
      "writeSettingswritesettings": [
      {
        "path": "<path_to_output_file>",
        "action": "create",
        "format": "csv",
        "compression": "none",
        "header": false,
        "asSingleFile": false
      }
      ]
    },
    "runParameters": {
      "overrides": {
        "data": [{
          "key": "varRegionRegion",
          "value": "02"
        },
        {
          "key": "varReferenceType",
          "value": "PROD"
        }
       ]}
      },
    },
  "ranfrom": "ui"
}

Response


Response Status Code - Success:  201 - Created

...

PropertyDescription
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.
ranfrom

(optional) If this value is set to null, then the job does not show up in the Job Details page.

See Job Details Page.


Request overrides:

...

For more information on other override options, see API Workflow - Run Job.

Response reference:


PropertyDescription
reasonCurrent 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.
sessionIdSession identifier for the job group.
idInternal identifier of the job group.
jobGraphInternal identifiers of the internal objects executed for the job.
jobsInternal identifiers of the jobs within the job group that were executed as part of this run. Jobs are listed in order of execution.

...