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
Constraints: default: false

showDetails

string of array
expand
Optional

expand

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns WsWorkflowExecution of type(s) application/json 
{
    "relations": {
        "startIndex": 0,
        "count": 0,
        "total": 0,
        "link": [
            {
                "rel": "string",
                "type": "string",
                "attributes": [
                    {
                        "name": "string",
                        "displayName": "string",
                        "value": "string",
                        "displayValue": "string"
                    }
                ],
                "href": "string"
            }
        ]
    },
    "id": "string",
    "state": "string",
    "name": "string",
    "href": "string",
    "inputParameters": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "outputParameters": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "start-date": "string",
    "end-date": "string",
    "business-state": "string",
    "started-by": "string",
    "running-instance-id": "string",
    "content-exception": "string",
    "current-item-display-name": "string",
    "execution-stack": [
        {
            "relations": {
                "startIndex": 0,
                "count": 0,
                "total": 0,
                "link": [
                    {
                        "rel": "string",
                        "type": "string",
                        "attributes": [
                            {
                                "name": "string",
                                "displayName": "string",
                                "value": "string",
                                "displayValue": "string"
                            }
                        ],
                        "href": "string"
                    }
                ]
            },
            "name": "string",
            "displayName": "string",
            "workflowDisplayName": "string",
            "attributes": [
                {
                    "name": "string",
                    "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
                    "description": "string",
                    "scope": "string",
                    "updated": false,
                    "encrypt-value": false
                }
            ],
            "href": "string",
            "workflow-attributes": [
                {
                    "name": "string",
                    "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
                    "description": "string",
                    "scope": "string",
                    "updated": false,
                    "encrypt-value": false
                }
            ]
        }
    ],
    "workflowAttributes": [
        {
            "name": "string",
            "type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
            "description": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "current-item-for-display": "string",
    "statistic": {
        "id": "string",
        "activities": [
            {
                "id": "string",
                "total-time": 0,
                "number-of-executions": 0,
                "number-of-transitions": 0,
                "max-time": 0
            }
        ],
        "total-time": 0,
        "number-of-transitions": 0,
        "total-number-of-transitions": 0,
        "token-size": 0,
        "token-blocked": 0,
        "token-system": 0,
        "token-User": 0,
        "token-wait": 0,
        "plugins": [
            {
                "plugin-name": "string",
                "total-time": 0,
                "number-of-executions": 0
            }
        ]
    },
    "formInputs": [
        {}
    ]
}
object
relations
Optional

relations

string
id
Optional

id

string
state
Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,
string
name
Optional

name

string
href
Optional

href

array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string As date-time As date-time
start-date
Optional

start-date

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

end-date

string
business-state
Optional

business-state

string
started-by
Optional

started-by

string
running-instance-id
Optional

running-instance-id

string
content-exception
Optional

content-exception

string
current-item-display-name
Optional

current-item-display-name

array of object
execution-stack
Optional

execution-stack

array of object
workflowAttributes
Optional

workflowAttributes

string
current-item-for-display
Optional

current-item-for-display

object
statistic
Optional

statistic

array of object
formInputs
Optional

formInputs


400

The request is invalid(validation error)

Returns WsWorkflowExecution of type(s) application/json 
"WsWorkflowExecution Object"
object
relations
Optional

relations

string
id
Optional

id

string
state
Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,
string
name
Optional

name

string
href
Optional

href

array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string As date-time As date-time
start-date
Optional

start-date

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

end-date

string
business-state
Optional

business-state

string
started-by
Optional

started-by

string
running-instance-id
Optional

running-instance-id

string
content-exception
Optional

content-exception

string
current-item-display-name
Optional

current-item-display-name

array of object
execution-stack
Optional

execution-stack

array of object
workflowAttributes
Optional

workflowAttributes

string
current-item-for-display
Optional

current-item-for-display

object
statistic
Optional

statistic

array of object
formInputs
Optional

formInputs


401

The user is not authorized

Returns WsWorkflowExecution of type(s) application/json 
"WsWorkflowExecution Object"
object
relations
Optional

relations

string
id
Optional

id

string
state
Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,
string
name
Optional

name

string
href
Optional

href

array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string As date-time As date-time
start-date
Optional

start-date

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

end-date

string
business-state
Optional

business-state

string
started-by
Optional

started-by

string
running-instance-id
Optional

running-instance-id

string
content-exception
Optional

content-exception

string
current-item-display-name
Optional

current-item-display-name

array of object
execution-stack
Optional

execution-stack

array of object
workflowAttributes
Optional

workflowAttributes

string
current-item-for-display
Optional

current-item-for-display

object
statistic
Optional

statistic

array of object
formInputs
Optional

formInputs


404

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

Returns WsWorkflowExecution of type(s) application/json 
"WsWorkflowExecution Object"
object
relations
Optional

relations

string
id
Optional

id

string
state
Optional

state

Possible values are : canceled, completed, running, suspended, waiting, waiting-signal, failed, initializing,
string
name
Optional

name

string
href
Optional

href

array of object
inputParameters
Optional

inputParameters

array of object
outputParameters
Optional

outputParameters

string As date-time As date-time
start-date
Optional

start-date

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

end-date

string
business-state
Optional

business-state

string
started-by
Optional

started-by

string
running-instance-id
Optional

running-instance-id

string
content-exception
Optional

content-exception

string
current-item-display-name
Optional

current-item-display-name

array of object
execution-stack
Optional

execution-stack

array of object
workflowAttributes
Optional

workflowAttributes

string
current-item-for-display
Optional

current-item-for-display

object
statistic
Optional

statistic

array of object
formInputs
Optional

formInputs


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/workflows/{workflowId}/executions/{executionId}
On This Page
Workflow Run Service Operations
GET
Get All Executions For
POST
Start Workflow Execution
GET
Get User Interaction
POST
Answer User Interaction
DELETE
Cancel User Interaction
GET
Get Workflow Execution
DELETE
Delete Workflow Execution
GET
Export Execution Logs 1
GET
Get Workflow Execution Statistics
GET
Get Workflow Execution State
DELETE
Cancel Workflow Execution
GET
Get Workflow Execution Logs