Get User Interaction

Get User Interaction

Retrieves user interaction details for a workflow run. If a workflow run with ID: executionId has a user interaction request, the workflow run is suspended until a user answers the interaction request. This API call returns the user interaction parameter, which has to be filled to answer it.

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

workflowId

string
executionId
Required

executionId

Authentication
This operation uses the following authentication methods.
Responses
200

The request is successful

Returns WsUserInteraction 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"
            }
        ]
    },
    "assignees": [
        "string"
    ],
    "name": "string",
    "state": "string",
    "id": "string",
    "href": "string",
    "input-parameters": [
        {
            "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
        }
    ],
    "group-assignees": [
        "string"
    ],
    "user-assignees": [
        "string"
    ],
    "timeout-date": "string"
}
object
relations
Optional

relations

array of string
assignees
Optional

assignees

string
name
Optional

name

string
state
Optional

state

Possible values are : waiting, finished,
string
id
Optional

id

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

array of string
group-assignees
Optional

group-assignees

array of string
user-assignees
Optional

user-assignees

string As date-time As date-time
timeout-date
Optional

timeout-date


401

The user is not authorized

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

relations

array of string
assignees
Optional

assignees

string
name
Optional

name

string
state
Optional

state

Possible values are : waiting, finished,
string
id
Optional

id

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

array of string
group-assignees
Optional

group-assignees

array of string
user-assignees
Optional

user-assignees

string As date-time As date-time
timeout-date
Optional

timeout-date


404

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

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

relations

array of string
assignees
Optional

assignees

string
name
Optional

name

string
state
Optional

state

Possible values are : waiting, finished,
string
id
Optional

id

string
href
Optional

href

array of object
input-parameters
Optional

input-parameters

array of string
group-assignees
Optional

group-assignees

array of string
user-assignees
Optional

user-assignees

string As date-time As date-time
timeout-date
Optional

timeout-date


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/vco/api/workflows/{workflowId}/executions/{executionId}/interaction
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