Download Workflow Schema Content
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
{
"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
}string
display-name
Required
display-name
string
description
Required
description
string
ref-types
Required
ref-types
string
schemaLocation
Optional
schemaLocation
string
root-name
Optional
root-name
string
object-name
Optional
object-name
string
id
Optional
id
string
icon-id
Optional
icon-id
string
version
Optional
version
string
api-version
Optional
api-version
string
allowed-operations
Optional
allowed-operations
integer As int32 As int32
restartMode
Optional
restartMode
integer As int32 As int32
resumeFromFailedMode
Optional
resumeFromFailedMode
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