Get Workflow Schema
The schema data is returned and response Content-type is set to correct media type, for example "Content-Type:application/json"
Request
URI
GET
https://{api_host}/vco/api/workflows/{id}/content
COPY
Path Parameters
string
id
Required
id
Responses
200
The request is successful
Returns
schema-workflow
of type(s)
application/json
{
"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"
}
string
description
Required
description
object
position
Required
position
object
input
Required
input
object
output
Required
output
array of
object
attrib
Required
attrib
object
presentation
Required
presentation
string
schemaLocation
Optional
schemaLocation
string
id
Optional
id
string
version
Optional
version
integer As int32
As int32
restartMode
Optional
restartMode
integer As int32
As int32
resumeFromFailedMode
Optional
resumeFromFailedMode
string
display-name
Required
display-name
string
category-id
Optional
category-id
string
ref-types
Required
ref-types
array of
object
error-handler
Optional
error-handler
array of
object
workflow-item
Required
workflow-item
array of
object
workflow-note
Required
workflow-note
string
root-name
Optional
root-name
string
object-name
Optional
object-name
string
icon-id
Optional
icon-id
string
api-version
Optional
api-version
string
allowed-operations
Optional
allowed-operations
string
editor-version
Optional
editor-version
401
The user is not authorized
Returns
schema-workflow
of type(s)
application/json
"schema-workflow Object"
string
description
Required
description
object
position
Required
position
object
input
Required
input
object
output
Required
output
array of
object
attrib
Required
attrib
object
presentation
Required
presentation
string
schemaLocation
Optional
schemaLocation
string
id
Optional
id
string
version
Optional
version
integer As int32
As int32
restartMode
Optional
restartMode
integer As int32
As int32
resumeFromFailedMode
Optional
resumeFromFailedMode
string
display-name
Required
display-name
string
category-id
Optional
category-id
string
ref-types
Required
ref-types
array of
object
error-handler
Optional
error-handler
array of
object
workflow-item
Required
workflow-item
array of
object
workflow-note
Required
workflow-note
string
root-name
Optional
root-name
string
object-name
Optional
object-name
string
icon-id
Optional
icon-id
string
api-version
Optional
api-version
string
allowed-operations
Optional
allowed-operations
string
editor-version
Optional
editor-version
404
Can not find a workflow with the specified ID or the user does not have 'read' access rights for that workflow
Returns
schema-workflow
of type(s)
application/json
"schema-workflow Object"
string
description
Required
description
object
position
Required
position
object
input
Required
input
object
output
Required
output
array of
object
attrib
Required
attrib
object
presentation
Required
presentation
string
schemaLocation
Optional
schemaLocation
string
id
Optional
id
string
version
Optional
version
integer As int32
As int32
restartMode
Optional
restartMode
integer As int32
As int32
resumeFromFailedMode
Optional
resumeFromFailedMode
string
display-name
Required
display-name
string
category-id
Optional
category-id
string
ref-types
Required
ref-types
array of
object
error-handler
Optional
error-handler
array of
object
workflow-item
Required
workflow-item
array of
object
workflow-note
Required
workflow-note
string
root-name
Optional
root-name
string
object-name
Optional
object-name
string
icon-id
Optional
icon-id
string
api-version
Optional
api-version
string
allowed-operations
Optional
allowed-operations
string
editor-version
Optional
editor-version
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/vco/api/workflows/{id}/content
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