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
{
    "href": "string",
    "relations": {
        "total": 0,
        "start": 0,
        "link": [
            {
                "attribute": [
                    {
                        "displayValue": "string",
                        "value": "string",
                        "name": "string"
                    }
                ],
                "href": "string",
                "type": "string",
                "rel": "string"
            }
        ]
    },
    "id": "string",
    "schema-workflow": {
        "display-name": "string",
        "description": "string",
        "ref-types": "string",
        "error-handler": [
            {
                "position": {
                    "y": "number",
                    "x": "number"
                },
                "name": "string",
                "throw-bind-name": "string"
            }
        ],
        "position": {
            "y": "number",
            "x": "number"
        },
        "input": {
            "param": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string"
                }
            ]
        },
        "output": {
            "param": [
                {
                    "description": "string",
                    "name": "string",
                    "type": "string"
                }
            ]
        },
        "attrib": [
            {
                "description": "string",
                "value": {
                    "objectType": "string"
                },
                "type": "string",
                "name": "string",
                "scope": "string",
                "updated": false,
                "encrypt-value": false
            }
        ],
        "workflow-item": [
            {
                "display-name": "string",
                "script": {
                    "value": "string",
                    "encoded": false
                },
                "in-binding": {
                    "bind": [
                        {
                            "description": "string",
                            "name": "string",
                            "type": "string",
                            "export-name": "string"
                        }
                    ]
                },
                "out-binding": {
                    "bind": [
                        {
                            "description": "string",
                            "name": "string",
                            "type": "string",
                            "export-name": "string"
                        }
                    ]
                },
                "description": "string",
                "conditions": {
                    "condition": [
                        {
                            "value": "string",
                            "name": "string",
                            "type": "string",
                            "comparator": "string",
                            "label": "string"
                        }
                    ]
                },
                "condition": [
                    {
                        "value": "string",
                        "name": "string",
                        "type": "string",
                        "comparator": "string",
                        "label": "string"
                    }
                ],
                "reference": {
                    "id": "string",
                    "type": "string"
                },
                "iteration-catch-block": {
                    "script": {
                        "value": "string",
                        "encoded": false
                    }
                },
                "workflow-subelements-list": {
                    "workflow-subelement": [
                        {
                            "name": "string",
                            "display-name": "string",
                            "linked-workflow-id": "string",
                            "in-binding": {
                                "bind": [
                                    {
                                        "description": "string",
                                        "name": "string",
                                        "type": "string",
                                        "export-name": "string"
                                    }
                                ]
                            },
                            "out-binding": {
                                "bind": [
                                    {
                                        "description": "string",
                                        "name": "string",
                                        "type": "string",
                                        "export-name": "string"
                                    }
                                ]
                            }
                        }
                    ]
                },
                "presentation": {
                    "desc": "string",
                    "p-step": [
                        {
                            "title": "string",
                            "desc": "string",
                            "p-group": [
                                {
                                    "title": "string",
                                    "desc": "string",
                                    "p-param": [
                                        {
                                            "desc": "string",
                                            "p-qual": [
                                                {
                                                    "value": "string",
                                                    "kind": "string",
                                                    "name": "string",
                                                    "type": "string"
                                                }
                                            ],
                                            "name": "string"
                                        }
                                    ],
                                    "p-qual": [
                                        {
                                            "value": "string",
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string"
                                        }
                                    ]
                                }
                            ],
                            "p-param": [
                                {
                                    "desc": "string",
                                    "p-qual": [
                                        {
                                            "value": "string",
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string"
                                        }
                                    ],
                                    "name": "string"
                                }
                            ],
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ]
                        }
                    ],
                    "p-group": [
                        {
                            "title": "string",
                            "desc": "string",
                            "p-param": [
                                {
                                    "desc": "string",
                                    "p-qual": [
                                        {
                                            "value": "string",
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string"
                                        }
                                    ],
                                    "name": "string"
                                }
                            ],
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ]
                        }
                    ],
                    "p-param": [
                        {
                            "desc": "string",
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ],
                            "name": "string"
                        }
                    ],
                    "p-qual": [
                        {
                            "value": "string",
                            "kind": "string",
                            "name": "string",
                            "type": "string"
                        }
                    ]
                },
                "position": {
                    "y": "number",
                    "x": "number"
                },
                "name": "string",
                "out-name": "string",
                "alt-out-name": "string",
                "catch-name": "string",
                "throw-bind-name": "string",
                "type": "string",
                "end-mode": "string",
                "script-module": "string",
                "business-status": "string",
                "color": "string",
                "prototype-id": "string",
                "content-mode": "string",
                "launched-workflow-id": "string",
                "interaction": "string",
                "linked-workflow-id": "string",
                "comparator": 0
            }
        ],
        "presentation": {
            "desc": "string",
            "p-step": [
                {
                    "title": "string",
                    "desc": "string",
                    "p-group": [
                        {
                            "title": "string",
                            "desc": "string",
                            "p-param": [
                                {
                                    "desc": "string",
                                    "p-qual": [
                                        {
                                            "value": "string",
                                            "kind": "string",
                                            "name": "string",
                                            "type": "string"
                                        }
                                    ],
                                    "name": "string"
                                }
                            ],
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ]
                        }
                    ],
                    "p-param": [
                        {
                            "desc": "string",
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ],
                            "name": "string"
                        }
                    ],
                    "p-qual": [
                        {
                            "value": "string",
                            "kind": "string",
                            "name": "string",
                            "type": "string"
                        }
                    ]
                }
            ],
            "p-group": [
                {
                    "title": "string",
                    "desc": "string",
                    "p-param": [
                        {
                            "desc": "string",
                            "p-qual": [
                                {
                                    "value": "string",
                                    "kind": "string",
                                    "name": "string",
                                    "type": "string"
                                }
                            ],
                            "name": "string"
                        }
                    ],
                    "p-qual": [
                        {
                            "value": "string",
                            "kind": "string",
                            "name": "string",
                            "type": "string"
                        }
                    ]
                }
            ],
            "p-param": [
                {
                    "desc": "string",
                    "p-qual": [
                        {
                            "value": "string",
                            "kind": "string",
                            "name": "string",
                            "type": "string"
                        }
                    ],
                    "name": "string"
                }
            ],
            "p-qual": [
                {
                    "value": "string",
                    "kind": "string",
                    "name": "string",
                    "type": "string"
                }
            ]
        },
        "workflow-note": [
            {
                "description": "string",
                "x": "number",
                "y": "number",
                "w": "number",
                "h": "number",
                "color": "string"
            }
        ],
        "schemaLocation": "string",
        "root-name": "string",
        "object-name": "string",
        "id": "string",
        "icon-id": "string",
        "version": "string",
        "api-version": "string",
        "allowed-operations": "string",
        "restartMode": 0,
        "resumeFromFailedMode": 0
    },
    "inputParameters": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "outputParameters": [
        {
            "description": "string",
            "value": {
                "objectType": "string"
            },
            "type": "string",
            "name": "string",
            "scope": "string",
            "updated": false,
            "encrypt-value": false
        }
    ],
    "customized-icon": false,
    "name": "string",
    "version": "string",
    "description": "string"
}
string
href
Optional

href

relations
Optional

relations

string
id
Optional

id

schema-workflow
Optional

schema-workflow

array of parameter
inputParameters
Optional

inputParameters

array of parameter
outputParameters
Optional

outputParameters

boolean
customized-icon
Optional

customized-icon

string
name
Optional

name

string
version
Optional

version

string
description
Optional

description


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