Validate

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
{
    "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"
}
string
api-version
Optional

api-version

string
icon-id
Optional

icon-id

string
object-name
Optional

object-name

string
schemaLocation
Optional

schemaLocation

string
description
Required

description

workflow-item
Required

workflow-item

workflow-note
Required

workflow-note

string
version
Optional

version

string
ref-types
Required

ref-types

string
allowed-operations
Optional

allowed-operations

output
Required

output

presentation
Required

presentation

input
Required

input

integer As int32 As int32
restartMode
Optional

restartMode

integer As int32 As int32
resumeFromFailedMode
Optional

resumeFromFailedMode

error-handler
Optional

error-handler

string
display-name
Required

display-name

array of parameter
attrib
Required

attrib

string
root-name
Optional

root-name

position
Required

position

string
id
Optional

id

Responses
200

Validation completed

Returns validation-messages of type(s) application/json
{
    "messages": [
        {
            "owner": "string",
            "severity": "string",
            "text": "string",
            "title": "string"
        }
    ]
}
messages
Optional

messages