Latest version of this endpoint: API Deployments Run v4.
Contents:
Run the job for the active release of the specified deployment.
- At least one manual output must be specified for the main flow within the package. See Flow View Page.
- An active release must be specified for the deployment. See API Releases Patch v3.
NOTE: Deployments pertain to Production instances of the Designer Cloud Powered by Trifacta® platform. For more information, see Overview of Deployment Manager.
Version: v3
Required Permissions
NOTE: Each request to the Designer Cloud Powered by Trifacta® platform must include authentication credentials. See https://api.trifacta.com/ee/6.4/index.html#section/Authentication.
Request
Request Type: POST
Endpoint:
/v3/deployments/<id>/run
where:
| Parameter | Description |
|---|---|
<id> | Internal identifier for the deployment |
Request URI - Example:
/v3/deployments/4/run
Request Body:
Empty.
Request Body - dataset with parameters:
You can apply parameter overrides when running a deployment. Add the following structure to the request body:
{
"runParameters": {
"overrides": {
"data": [
{ "key": "myParamName", "value": "override value"
}]
}
}
}
where:
| Item | Description |
|---|---|
key | Name of parameter to apply to the job run. |
value | The string value to assign to the parameter for the job run. |
Response
Response Status Code - Success: 201 - Created
Response Body Example:
{
"data": [
{
"reason": "JobStarted",
"sessionId": "dd6a90e0-c353-11e7-ad4e-7f2dd2ae4621",
"id": 33,
"jobs": {
"data": [
{
"id": 68
},
{
"id": 69
},
{
"id": 70
}
]
}
}
]
}
Reference
| 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 v3. |
| jobs.data.id | Internal identifier for the individual jobs that compose the job group being executed. |
This page has no comments.