Get a flow by id

Get a flow by id

GET /api/orchestration/v2/workflows/{flowId}

Try it

Get a flow by id

cURL

curl --request GET \
  --url http://localhost/api/orchestration/v2/workflows/{flowId} \
  --header 'Authorization: Bearer <token>'

200

{
  "data": {
    "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

flowId · string · required

The flow id

Response

200

application/json

The workflow

data · object · required

Show child attributes

data. config · object · required

Show child attributes

data.config. stages · object[] · required

Show child attributes

data.config.stages. {key} · any

data.config. name · string

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

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

data. id · string · required