Run the job for the active release of the specified deployment.
NOTE: Deployments pertain to Production instances of the |
Version: v4
Request Type: POST
Endpoint:
/v4/deployments/<id>/run |
where:
Parameter | Description |
---|---|
<id> | Internal identifier for the deployment |
Request URI - Example:
/v4/deployments/4/run |
Request Body:
Empty.
Request Body - Example for dataset with parameters:
In the following example, the request body contains overrides to the default job definition. In this case, the override is to set a new value for the parameter of the dataset:
{ "runParameters": { "overrides": { "data": [{ "key": "varRegion", "value": "02" } ]} } } |
Response Status Code - Success: 201 - Created
Response Body Example:
{ "data": [ { "reason": "JobStarted", "sessionId": "14337009-1637-4948-a36f-16479d7138c6", "id": 3 } ] } |
Property | Description |
---|---|
reason | Action undertaken on the endpoint. |
sessionId | Internal identifier for the session of the job run |
id | JobGroup identifier. For more information, see API JobGroups Get v4. |
jobs.data.id | Internal identifier for the individual jobs that compose the job group being executed. |