Get Workflow

Get Workflow

The returned definition contains base data for the workflow, as well the input and output parameter definitions. It also has links to the workflow presentation and workflow category in which this workflow is located.

To retrieve the input and output parameter definitions localized, add Accept-Language header, with the appropriate locale. In advance, localization resource should be present for the workflow, otherwise it defaults to the standard input and output parameter definitions.

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

id


Responses
200

The request is successful

Returns workflow of type(s) application/json
{
    "customized-icon": false,
    "name": "string",
    "description": "string",
    "href": "string",
    "id": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "rel": "string",
                "attribute": [
                    {
                        "displayValue": "string",
                        "name": "string",
                        "value": "string"
                    }
                ],
                "href": "string",
                "type": "string"
            }
        ]
    },
    "inputParameters": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ],
    "version": "string",
    "outputParameters": [
        {
            "scope": "string",
            "name": "string",
            "description": "string",
            "type": "string",
            "value": {
                "objectType": "string"
            },
            "updated": false
        }
    ]
}
boolean
customized-icon
Optional

customized-icon

string
name
Optional

name

string
description
Optional

description

string
href
Optional

href

string
id
Optional

id

relations
Optional

relations

array of parameter
inputParameters
Optional

inputParameters

string
version
Optional

version

array of parameter
outputParameters
Optional

outputParameters


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