Skip to main content

    UnifiedViews Method - Execute a Pipeline with Parameters

    Abstract

    UnifiedViews Method - Execute a Pipeline with Parameters

    Description

    Creates a pipeline execution for one pipeline including parameters.

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

    Content Type

    application/x-www-form-urlencoded

    Request

    Supported Method

    POST

    HTTP Parameters

    Parameter

    Type

    Required

    Description

    owner

    string

    true

    Username of the user credentials the execution should be run under.

    isDebugging

    boolean

    parameterList

    array of parameters

    Example Request

    Sample cURL request to run in normal mode:

    curl --location ‘https://<your poolparty server>/master/api/1/pipelines/<pipeline ID>/executions’ \
--header ‘Authorization: Basic *****’ \
--form ‘params=“{\“owner\” : \“admin\“,
\“isDebugging\” : true,
\“parameterList\” : [{\“key\” : \“uuid\“,
 \“value\” : \“f123123123f123123123123f1234\“}]}“’ \
--form 
‘file1=@“/<path to your stored data>/<your data>.md”’
    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: <yyyy-mm-dd>T<hh:mm:ss.ms>

    end

    string

    Values are date and time.

    Format: <yyyy-mm-dd>T<hh:mm:ss.ms>

    schedule

    string

    Possible values: true, false

    stop

    string

    Possible values: true, false

    lastChange

    string

    Values are date and time.

    Format: <yyyy-mm-dd>T<hh:mm:ss.ms>

    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": "<timestamp>",
   "asUser": "<creator of the execution>",
   "userActorExternalId": null,
   "debugging": false
}