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,
"schema-workflow": {
"api-version": "string",
"icon-id": "string",
"object-name": "string",
"schemaLocation": "string",
"description": "string",
"workflow-item": [
{
"end-mode": "string",
"color": "string",
"description": "string",
"type": "string",
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"out-name": "string",
"prototype-id": "string",
"catch-name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"alt-out-name": "string",
"throw-bind-name": "string",
"business-status": "string",
"launched-workflow-id": "string",
"content-mode": "string",
"iteration-catch-block": {
"script": {
"value": "string",
"encoded": false
}
},
"script-module": "string",
"script": {
"value": "string",
"encoded": false
},
"linked-workflow-id": "string",
"comparator": 0,
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
],
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"display-name": "string",
"in-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"name": "string",
"out-binding": {
"bind": [
{
"export-name": "string",
"name": "string",
"description": "string",
"type": "string"
}
]
},
"linked-workflow-id": "string"
}
]
},
"name": "string",
"interaction": "string",
"position": {
"x": "number",
"y": "number"
},
"conditions": {
"condition": [
{
"comparator": "string",
"name": "string",
"label": "string",
"type": "string",
"value": "string"
}
]
}
}
],
"workflow-note": [
{
"color": "string",
"w": "number",
"x": "number",
"h": "number",
"description": "string",
"y": "number"
}
],
"version": "string",
"ref-types": "string",
"allowed-operations": "string",
"output": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"presentation": {
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-step": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"p-group": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"title": "string",
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
}
],
"p-param": [
{
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"value": "string"
}
],
"name": "string",
"desc": "string"
}
],
"desc": "string"
},
"input": {
"param": [
{
"name": "string",
"description": "string",
"type": "string"
}
]
},
"restartMode": 0,
"resumeFromFailedMode": 0,
"error-handler": [
{
"name": "string",
"position": {
"x": "number",
"y": "number"
},
"throw-bind-name": "string"
}
],
"display-name": "string",
"attrib": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"root-name": "string",
"position": {
"x": "number",
"y": "number"
},
"id": "string"
},
"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",
"encrypt-value": false,
"description": "string",
"type": "string",
"value": {
"objectType": "string"
},
"updated": false
}
],
"version": "string",
"outputParameters": [
{
"scope": "string",
"name": "string",
"encrypt-value": false,
"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
string
version
Optional
version
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 Service Operations
DELETE
Delete Permission Rule
DELETE
Delete Permissions For Object
DELETE
Delete Workflow
GET
Download Workflow Icon
GET
Download Workflow Schema
GET
Download Workflow Schema Content
GET
Get All Tasks For Workflow
GET
Get All User Interactions For Workflow
GET
Get All Workflows
GET
Get Permission Rule
GET
Get Permissions For Object
GET
Get Workflow
POST
Import Workflow
POST
Insert Permissions For Object
PUT
Update Permission Rule
PUT
Validate
GET
Validate Existing