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

...

PropertyDescription
overrides.execution

(required, if first time running the job) Indicates the running environment on which the job is executed. Accepted values:

  • photon
  • spark

For more information, see Running Environment Options.

overrides.profiler

(required, if first time running the job) When set to true, a visual profile of the job is generated as specified by the profiling options for the platform. See Profiling Options.

overrides.writeSettings

(required, if first time running the job) These settings define the publishing options for the job. For more information, see API WriteSettings Get v4.

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.

...