Workflow create request

Request of create workflow

Endpoint

POST /api/workflow/

Auth

Authorization: Bearer ${token}

Query Parameters

Key	Default	Description
identity		Optional; auto-generated when empty
source		Optional scheme-prefixed locator; when omitted, send the YAML in the request body
start	false	Optional; starts the workflow in the same request once it is prepared
link	false	Optional; assigns a link to every step declaring one, alongside a start

Response

Json

[
    {
        "kind": "status",
        "payload": {
            "code": 0,
            "message": ""
        }
    },
    {
        "kind": "",
        "payload": ""
    },
    {
        "kind": "entity",
        "payload": {
            "created_at": 0,
            "identity": "",
            "links": [
                {
                    "host": "",
                    "name": "",
                    "port": "",
                    "step": ""
                }
            ],
            "name": "",
            "status": "",
            "tags": [
                ""
            ]
        }
    }
]

Notes

Workflow Permission Required
Read-Only Permission Restricted
source schemes: file://<path> (engine host filesystem), hub://<name> (dxflow hub, Configuration block extracted), http(s)://<url> (fetched). Without source, the request body is the YAML definition.
start uses the workflow's existing workflow.ini; per-run overrides are supplied through the start endpoint.
link rides along with start; the assigned links are listed under links in the returned entity, each entry carrying step, port, name and host.

Workflow list request

Request of list workflow

Workflow events request

Request of events workflow