UnifiedViews Method - Create a Pipeline Execution

Abstract

Description
Creates a pipeline execution for one pipeline.

URL: http://{server}/master/api/1/pipelines/{pipeline_id}/executions

Content Type

application/json

Request

Supported Method
POST

HTTP Parameters

Parameter	Type	Required	Description
asUser	string	true	Username of the user credentials the execution should be run under.

Example Request

Sample request to run in normal mode:

curl -H "Accept: application/json" -H "Content-type: application/json" -X POST --data '{  "asUser" : "http://www.johnadmin.cz" }' http://master:commander@localhost:8080/master/api/1/pipelines/33/executions

Sample request to run in debug mode:

curl -H "Accept: application/json" -H "Content-type: application/json" -X POST --data '{ "debugging" : "true", "asUser" : "http://www.johnadmin.cz" }' http://master:commander@localhost:8080/master/api/1/pipelines/33/executions

For UnifiedViews <2.3

For UnifiedViews < 2.3, please use "isDebugging" instead of "debugging"

ResponseContent-Type

application/json

Status: 200 - OK

Response Attributes

Attribute	Type	Required	Description
id	number	true	ID of the pipeline.
status	string	false	Returns the status of the execution. Possible values: FINISHED_WARNING FINISHED_SUCCESS QUEUED RUNNING FAILED CANCELLING CANCELLED
orderNumber	string	true	Position in the queue.
start	string		Values are date and time. Format: Format: <yyyy-mm-dd>T<hh:mm:ss.ms>Z
end	string		Values are date and time. Format: Format: <yyyy-mm-dd>T<hh:mm:ss.ms>Z
schedule	string		Possible values: true, false
stop	string		Possible values: true, false
lastChange	string		Values are date and time. Format: Format: <yyyy-mm-dd>T<hh:mm:ss.ms>Z
asUser	string		User who created the execution.
userActorExternalId	string	false	User with viewing permissions or this execution.
debugging	string		Possible values: true, false

Example Response

{
   "id": 321,
   "status": "QUEUED",
   "orderNumber": 1,
   "start": null,
   "end": null,
   "schedule": null,
   "stop": false,
   "lastChange": "2017-03-08T18:12:31.535+0100",
   "asUser": "http://www.johnadmin.cz",
   "userActorExternalId": null,
   "debugging": false
}

In this section: