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.
When a request is sent to this endpoint with "" or "" as the desired response content type, this operation is the equivalent to "Export/Download a workflow": Exports a workflow by its ID. If the request is successful, the workflow binary content is available as an attachment with MIME type application/zip (that is, a normal ZIP file) with a default file name {workflowname}.workflow. It is up to the client application to properly fetch and process this attachment, for example by saving it to local file system. The exported workflow has the same internal format as the workflows exported by using the VCF Operations Orchestrator client.Request
URI
GET
https://{api_host}/vco/api/workflows/{id}
COPY
Path Parameters
string
id
Required
id
Responses
200
The request is successful
Returns
WsWorkflow
of type(s)
application/json
{
"relations": {
"startIndex": 0,
"count": 0,
"total": 0,
"link": [
{
"rel": "string",
"type": "string",
"attributes": [
{
"name": "string",
"displayName": "string",
"value": "string",
"displayValue": "string"
}
],
"href": "string"
}
]
},
"id": "string",
"name": "string",
"version": "string",
"description": "string",
"href": "string",
"schema-workflow": {
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"input": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"output": {
"param": [
{
"description": "string",
"name": "string",
"type": "string"
}
]
},
"attrib": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"schemaLocation": "string",
"id": "string",
"version": "string",
"restartMode": 0,
"resumeFromFailedMode": 0,
"display-name": "string",
"category-id": "string",
"ref-types": "string",
"error-handler": [
{
"position": {
"y": "number",
"x": "number"
},
"name": "string",
"throw-bind-name": "string"
}
],
"workflow-item": [
{
"description": "string",
"position": {
"y": "number",
"x": "number"
},
"runtime": "string",
"script": {
"encoded": false,
"text": "string"
},
"conditions": {
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
]
},
"condition": [
{
"name": "string",
"type": "string",
"comparator": "string",
"label": "string",
"text": "string"
}
],
"reference": {
"id": "string",
"type": "string"
},
"presentation": {
"desc": "string",
"p-step": [
{
"title": "string",
"desc": "string",
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-group": [
{
"title": "string",
"desc": "string",
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-param": [
{
"desc": "string",
"name": "string",
"pqual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
}
],
"p-qual": [
{
"kind": "string",
"name": "string",
"type": "string",
"text": "string"
}
]
},
"name": "string",
"type": "string",
"color": "string",
"interaction": "string",
"comparator": 0,
"environment": {
"id": "string",
"name": "string"
},
"display-name": "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"
}
]
},
"iteration-catch-block": {
"script": {
"encoded": false,
"text": "string"
}
},
"workflow-subelements-list": {
"workflow-subelement": [
{
"name": "string",
"linked-workflow-id": "string",
"display-name": "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"
}
]
}
}
]
},
"out-name": "string",
"alt-out-name": "string",
"catch-name": "string",
"throw-bind-name": "string",
"end-mode": "string",
"script-module": "string",
"business-status": "string",
"prototype-id": "string",
"content-mode": "string",
"launched-workflow-id": "string",
"linked-workflow-id": "string",
"validation-message": "string"
}
],
"workflow-note": [
{
"description": "string",
"x": "number",
"y": "number",
"w": "number",
"h": "number",
"color": "string"
}
],
"root-name": "string",
"object-name": "string",
"icon-id": "string",
"api-version": "string",
"allowed-operations": "string",
"editor-version": "string"
},
"inputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"outputParameters": [
{
"name": "string",
"type": "Example types are: SecureString, MimeAttachment, Regexp, Array/VC:VirtualMachine, boolean, string and etc.",
"description": "string",
"scope": "string",
"updated": false,
"encrypt-value": false
}
],
"customized-icon": false,
"category-id": "string"
}
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
version
Optional
version
string
description
Optional
description
string
href
Optional
href
object
schema-workflow
Optional
schema-workflow
array of
object
inputParameters
Optional
inputParameters
array of
object
outputParameters
Optional
outputParameters
boolean
customized-icon
Optional
customized-icon
string
category-id
Optional
category-id
401
The user is not authorized
Returns
WsWorkflow
of type(s)
application/json
"WsWorkflow Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
version
Optional
version
string
description
Optional
description
string
href
Optional
href
object
schema-workflow
Optional
schema-workflow
array of
object
inputParameters
Optional
inputParameters
array of
object
outputParameters
Optional
outputParameters
boolean
customized-icon
Optional
customized-icon
string
category-id
Optional
category-id
404
Can not find a workflow with the specified id or the user does not have 'read' access rights for that workflow
Returns
WsWorkflow
of type(s)
application/json
"WsWorkflow Object"
object
relations
Optional
relations
string
id
Optional
id
string
name
Optional
name
string
version
Optional
version
string
description
Optional
description
string
href
Optional
href
object
schema-workflow
Optional
schema-workflow
array of
object
inputParameters
Optional
inputParameters
array of
object
outputParameters
Optional
outputParameters
boolean
customized-icon
Optional
customized-icon
string
category-id
Optional
category-id
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/workflows/{id}
Workflow Service Operations
GET
Get Workflow Schema
PUT
Update Workflow Schema Content
PUT
Validate
GET
Get All Workflows
POST
Create Workflow
GET
Validate Existing
GET
Get All Tasks For Workflow
GET
Get All User Interactions For Workflow
GET
Get Workflow
GET
Find Workflow Usages
GET
Get Workflow Schema Image
GET
Download Workflow Icon
GET
Find Workflow Dependencies
DELETE
Delete Workflow