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

{
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    },
    "parameter": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "assignee": [
        "string"
    ],
    "name": "string",
    "state": "string",
    "id": "string"
}

string

href

Optional

href

Relations

relations

Optional

relations

array of parameter

parameter

Optional

parameter