Version: v5.1

Workflows

The Workflow API allows you to list, search by ID, and start workflows.

Get list of workflows#

Endpoints#

GET workflowsvc/api/v1/workflows

Request parameters#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required
`_pagesize`	Integer	Number of workflows to be listed per page. Default is 10.	Optional
`_offset`	Integer	Position in list of workflows to begin listing. Default is 0.	Optional
`_name`	String	Partial search term for name of workflow	Optional
`_defId`	Integer	Partial search term for Workflow definition ID	Optional
`_status`	String	Filter by Workflow status	Optional
`startDate`	String	Start date of Workflow to begin listing	Optional
`enddate`	String	End date of Workflows to list	Optional
`sort`	String	Option to sort listing of Workflows	Optional

Request example#

GET /workflowsvc/api/v1/workflows?nsfilter={{nsfilter}}&_pageSize=10&_offset=0&_name=ActiveMQ&_defId=824beec4-4a58-4bf8-b9df-b86172a2d5d5&_status=FAILED&startDate=2026-02-01&endDate=2026-02-29&sort=%7B%22_updatedAt%22%3A-1%2C%22_name%22%3A1%7D

Response#

Codes#

Code	Description
`200`	Success
`400`	Bad Request
`404`	Not Found

Response example#

{  "_offset": 0,  "_pageSize": 10,  "_total": 1,  "_list": [    {      "_id": "94bcf41e-8d05-4011-a64b-d5a5164b0155",      "_workflowDefId": "824beec4-4a58-4bf8-b9df-b86172a2d5d5",      "_name": "rest_connector_workflow",      "_namespaces": ["first_tchgt1VU"],      "_userType": "iaq_realtime_setup",      "_tasks": [        {          "_id": "f99d9656-f424-450d-b638-fbb28bc22490",          "_name": "REST_CONNECTOR",          "_sequenceno": 1,          "_type": "REST_CONNECTOR",          "_status": "QUEUED"        }      ],      "_timeoutSeconds": null,      "_timeoutPolicy": null,      "_status": "QUEUED",      "_createdAt": "2026-02-24T02:32:22.148605220Z",      "_updatedAt": "2026-02-24T02:32:22.148606054Z",      "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",      "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",      "_inputParams": {        "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"      },      "_output": null    }  ]}

Get Workflow by ID#

Endpoints#

GET /workflowsvc/api/v1/workflows/{workflowid}

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required
`_includeLoopOverTasks`	Boolean	Determines if loop over tasks are included. Default value is false.	Optional

Path parameters#

Parameter	Type	Description	Required
`workflowRunid`	String	Workflow ID to search for	Required

Request example#

GET /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155?nsfilter={{nsfilter}}&_includeLoopOverTasks=false

Response#

Codes#

Code	Description
`200`	Success
`401`	Unauthorized
`403`	Forbidden
`500`	Internal Server Error

Response example#

{  "_id": "94bcf41e-8d05-4011-a64b-d5a5164b0155",  "_workflowDefId": "824beec4-4a58-4bf8-b9df-b86172a2d5d5",  "_name": "rest_connector_workflow",  "_namespaces": ["first_tchgt1VU"],  "_userType": "iaq_realtime_setup",  "_tasks": [    {      "_id": "f99d9656-f424-450d-b638-fbb28bc22490",      "_name": "REST_CONNECTOR",      "_sequenceno": 1,      "_type": "REST_CONNECTOR",      "_status": "QUEUED"    }  ],  "_timeoutSeconds": null,  "_timeoutPolicy": null,  "_status": "QUEUED",  "_createdAt": "2026-02-24T02:32:22.148605220Z",  "_updatedAt": "2026-02-24T02:32:22.148606054Z",  "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_inputParams": {    "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"  },  "_output": null}

Create (Run) a new workflow#

Endpoints#

POST /workflowsvc/api/v1/workflows

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required

Request body#

Parameter	Type	Description	Required
`_workflowDefId`	String	Workflow definition ID	Required

Request example#

POST /workflowsvc/api/v1/workflows?nsfilter={{nsfilter}}
{  "_workflowDefId": "824beec4-4a58-4bf8-b9df-b86172a2d5d5",  "_inputParams": {    "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"  }}

Response#

Codes#

Code	Description
`201`	Created

Response example#

{  "_id": "94bcf41e-8d05-4011-a64b-d5a5164b0155",  "_workflowDefId": "824beec4-4a58-4bf8-b9df-b86172a2d5d5",  "_name": "rest_connector_workflow",  "_namespaces": ["first_tchgt1VU"],  "_userType": "iaq_realtime_setup",  "_tasks": [    {      "_id": "f99d9656-f424-450d-b638-fbb28bc22490",      "_name": "REST_CONNECTOR",      "_sequenceno": 1,      "_type": "REST_CONNECTOR",      "_status": "QUEUED"    }  ],  "_timeoutSeconds": null,  "_timeoutPolicy": null,  "_status": "QUEUED",  "_createdAt": "2026-02-24T02:32:22.148605220Z",  "_updatedAt": "2026-02-24T02:32:22.148606054Z",  "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_inputParams": {    "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"  },  "_output": null}

Update workflow run status#

Endpoints#

PUT /workflowsvc/api/v1/workflows{workflowId}/status

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required

Path parameters#

Parameter	Type	Description	Required
`workflowId`	String	Workflow ID to search for	Required

Request body#

Parameter	Type	Description	Required
`_status`	String	New status to be updated to. Can be `PAUSED`, `RESUMED`, `RETRIED`, or `TERMINATED`	Required

Request example#

PUT /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155/status?nsfilter={{nsfilter}}

{  "_status": "PAUSED"}

Response#

Codes#

Code	Description
`200`	Success
`401`	Unauthorized
`403`	Forbidden
`500`	Internal Server Error

Response example#

{  "_id": "94bcf41e-8d05-4011-a64b-d5a5164b0155",  "_workflowDefId": "824beec4-4a58-4bf8-b9df-b86172a2d5d5",  "_name": "rest_connector_workflow",  "_namespaces": ["first_tchgt1VU"],  "_userType": "iaq_realtime_setup",  "_tasks": [    {      "_id": "f99d9656-f424-450d-b638-fbb28bc22490",      "_name": "REST_CONNECTOR",      "_sequenceno": 1,      "_type": "REST_CONNECTOR",      "_status": "PAUSED"    }  ],  "_timeoutSeconds": null,  "_timeoutPolicy": null,  "_status": "PAUSED",  "_createdAt": "2026-02-24T02:32:22.148605220Z",  "_updatedAt": "2026-02-24T02:32:22.148606054Z",  "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",  "_inputParams": {    "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"  },  "_output": null}