Run workflow

Run workflow

POST /api/orchestration/v2/workflows/{workflowID}/instances

Try it

Run workflow

cURL

curl --request POST \
  --url http://localhost/api/orchestration/v2/workflows/{workflowID}/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

201

{
  "data": {
    "workflowID": "<string>",
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "terminated": true,
    "status": [
      {
        "stage": 123,
        "instanceID": "<string>",
        "startedAt": "2023-11-07T05:31:56Z",
        "terminatedAt": "2023-11-07T05:31:56Z",
        "error": "<string>"
      }
    ],
    "terminatedAt": "2023-11-07T05:31:56Z",
    "error": "<string>",
    "workflow": {
      "config": {
        "stages": [
          {}
        ],
        "name": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "id": "<string>"
    }
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

workflowID · string · required

The flow id

Query Parameters

wait · boolean

Wait end of the workflow before return

Body

application/json

{key} · string

Response

201

application/json

The workflow instance

data · object · required

Show child attributes

data. workflowID · string · required

data. id · string · required

data. createdAt · string<date-time> · required

data. updatedAt · string<date-time> · required

data. terminated · boolean · required

data. status · object[]

Show child attributes

data.status. stage · number · required

data.status. instanceID · string · required

data.status. startedAt · string<date-time> · required

data.status. terminatedAt · string<date-time>

data.status. error · string

data. terminatedAt · string<date-time>

data. error · string

data. workflow · object

Show child attributes

data.workflow. config · object · required

Show child attributes

data.workflow.config. stages · object[] · required

Show child attributes

data.workflow.config.stages. {key} · any

data.workflow.config. name · string

data.workflow. createdAt · string<date-time> · required

data.workflow. updatedAt · string<date-time> · required

data.workflow. id · string · required