Get Workflow Execution

Get Workflow Execution

Retrieves a workflow run for a given workflow. When request parameter showDetails is set to true additional information will be retrieved. In this case the result contains current execution stack of the workflow run.

Request
URI
GET
https://{api_host}/vco/api/workflows/{workflowId}/executions/{executionId}
COPY
Path Parameters
string
workflowId
Required

workflowId

string
executionId
Required

executionId

Query Parameters
boolean
showDetails
Optional

showDetails

string of array
expand
Optional

expand

Responses
200

The request is successful

Returns workflow-execution of type(s) application/json 
{
    "start-date": "string",
    "workflow-item": [
        {
            "displayName": "string",
            "name": "string",
            "href": "string",
            "relations": {
                "total": 0,
                "start": 0,
                "link": [
                    {
                        "rel": "string",
                        "attribute": [
                            {
                                "displayValue": "string",
                                "name": "string",
                                "value": "string"
                            }
                        ],
                        "href": "string",
                        "type": "string"
                    }
                ]
            }
        }
    ],
    "started-by": "string",
    "content-exception": "string",
    "inputParameters": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ],
    "current-item-display-name": "string",
    "end-date": "string",
    "name": "string",
    "href": "string",
    "id": "string",
    "state": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    },
    "business-state": "string",
    "outputParameters": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ]
}
string As date-time As date-time
start-date
Optional

start-date

array of WsWorkflowExecutionStackItem
workflow-item
Optional

workflow-item

string
started-by
Optional

started-by

string
content-exception
Optional

content-exception

array of parameter
inputParameters
Optional

inputParameters

string
current-item-display-name
Optional

current-item-display-name

string As date-time As date-time
end-date
Optional

end-date

string
name
Optional

name

string
href
Optional

href

string
id
Optional

id

string
state
Optional

state

Possible values are : CANCELED, COMPLETED, RUNNING, SUSPENDED, WAITING, STATE_WAITING_ON_SIGNAL, FAILED, INITIALIZING,
Relations
relations
Optional

relations

string
business-state
Optional

business-state

array of parameter
outputParameters
Optional

outputParameters


204

No content

Operation doesn't return any data structure

400

The request is invalid(validation error)

Operation doesn't return any data structure

401

The user is not authorized

Operation doesn't return any data structure

404

Cannot find a workflow with the specified ID or the user does not have 'read' access rights for that workflow

Operation doesn't return any data structure

On This Page
Workflow Run Service Operations
POST
Answer User Interaction
DELETE
Cancel Workflow Execution
DELETE
Delete Workflow Execution
GET
Get All Executions For
GET
Get User Interaction
GET
Get Workflow Execution
GET
Get Workflow Execution Logs
GET
Get Workflow Execution State
POST
Start Workflow Execution