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
Responses
200
The request is successful
Returns user-interaction of type(s) application/json
{
"parameter": [
{
"scope": "string",
"name": "string",
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"name": "string",
"href": "string",
"assignee": [
"string"
],
"state": "string",
"id": "string",
"relations": {
"total": 0,
"start": 0,
"link": [
{
"rel": "string",
"attribute": [
{
"displayValue": "string",
"name": "string",
"value": "string"
}
],
"href": "string",
"type": "string"
}
]
}
}
401
The user is not authorized
Operation doesn't return any data structure
404
Can not 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
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