Validate
Validate provided workflow content
Request
URI
PUT
https://{api_host}/vco/api/workflows/validate/schema
COPY
Request Body
schema-workflow
of type(s)
application/json
Required
Show optional properties
{
"display-name": "string",
"description": "string",
"ref-types": "string",
"position": {},
"input": {
"param": [
{
"description": "string"
}
]
},
"output": {
"param": [
{
"description": "string"
}
]
},
"attrib": [
{
"name": "string"
}
],
"workflow-item": [
{
"position": {}
}
],
"presentation": {},
"workflow-note": [
{}
]
}{
"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
array of
object
error-handler
Optional
error-handler
object
position
Required
position
object
input
Required
input
object
output
Required
output
array of
object
attrib
Required
attrib
array of
object
workflow-item
Required
workflow-item
object
presentation
Required
presentation
array of
object
workflow-note
Required
workflow-note
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
Responses
200
Validation completed
Returns
validation-messages
of type(s)
application/json
"validation-messages Object"
array of
object
messages
Optional
messages
Code Samples
COPY
curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"attrib":["object"],"description:"string","display-name:"string","input:"object","output:"object","position:"object","presentation:"object","ref-types:"string","workflow-item":["object"],"workflow-note":["object"]}' https://{api_host}/vco/api/workflows/validate/schema
Workflow Service Operations
GET
Get All Workflows
POST
Import Workflow
PUT
Validate
GET
Get Workflow
GET
Download Workflow Schema Content
GET
Download Workflow Icon
GET
Get Permissions For Object
POST
Insert Permissions For Object
DELETE
Delete Permissions For Object
GET
Get Permission Rule
PUT
Update Permission Rule
DELETE
Delete Permission Rule
GET
Download Workflow Schema
DELETE
Delete Workflow
GET
Get All User Interactions For Workflow
GET
Get All Tasks For Workflow
GET
Validate Existing