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
_count	Integer	Number of workflows to be listed. Default is 10.	Required
_offset	Integer	Position in list of workflows to begin listing.	Required

Request body example

None

Response

Codes

Code	Description
200	Success
400	Bad Request
404	Not Found

Response example

[
    {
        "_id": "442b84d7-6327-42a3-971e-99c923e46322",
        "_workflowDefId": "cc2c728b-6ba5-4210-8a42-6f6079e8269e",
        "_name": "sample_workflow",
        "_namespaces": [
            "RefAppProject_w3MFXx7h"
        ],
        "_userType": "iaq_realtime_setup",
        "_tasks": [
            {
              "_id": "7df8cb79-32b9-43e8-abc8-88991f455bd5",
              "_name": "rest_connector_task",
              "_type": "REST_CONNECTOR",
              "_sequenceno": 1,
              "_status": "COMPLETED",
              "_result": {
              "rest_conn_result": {
                "data": {}
                  }
            },
            "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
                     }
            }
           }
        ],
        "_result": null,
        "_timeoutSeconds": null,
        "_timeoutPolicy": null,
        "_status": "RUNNING",
        "_createdAt": "2025-05-24T21:26:49.367573830Z",
        "_updatedAt": "2025-05-24T21:26:49.367574131Z"
    }
]

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

Path parameters

Parameter	Type	Description	Required
workflowid	String	Workflow ID to search for	Required

Request body example

None

Response

Codes

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

Response example

{
    "_id": "442b84d7-6327-42a3-971e-99c923e46322",
    "_workflowDefId": "cc2c728b-6ba5-4210-8a42-6f6079e8269e",
    "_name": "sample_workflow",
    "_namespaces": [
        "RefAppProject_w3MFXx7h"
    ],
    "_userType": "iaq_realtime_setup",
    "_tasks": [
        {
        "_id": "7df8cb79-32b9-43e8-abc8-88991f455bd5",
        "_name": "rest_connector_task",
        "_type": "REST_CONNECTOR",
        "_sequenceno": 1,
        "_status": "COMPLETED",
        "_result": {
            "rest_conn_result": {
                "data": {}
            }
        },
        "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
            }
        }
    }
    ],
    "_result": null,
    "_timeoutSeconds": null,
    "_timeoutPolicy": null,
    "_status": "RUNNING",
    "_createdAt": "2025-05-24T21:26:49.367573830Z",
    "_updatedAt": "2025-05-24T21:26:49.367574131Z"
}

Start 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 to search for	Required

Request body example

{
  "_workflowDefId": "6c81d2b0-540b-46c9-a719-1a6ec2cb77d8"
} 

Response

Codes

Code	Description
201	Created

Response example

{
    "_id": "442b84d7-6327-42a3-971e-99c923e46322",
    "_workflowDefId": "cc2c728b-6ba5-4210-8a42-6f6079e8269e",
    "_name": "sample_workflow",
    "_namespaces": [
        "RefAppProject_w3MFXx7h"
    ],
    "_userType": "iaq_realtime_setup",
    "_tasks": [
        {
        "_id": "7df8cb79-32b9-43e8-abc8-88991f455bd5",
        "_name": "rest_connector_task",
        "_type": "REST_CONNECTOR",
        "_sequenceno": 1,
        "_status": "COMPLETED",
        "_result": {
            "rest_conn_result": {
                "data": {}
            }
        },
        "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
            }
        }
        }
    ],
    "_result": null,
    "_timeoutSeconds": null,
    "_timeoutPolicy": null,
    "_status": "RUNNING",
    "_createdAt": "2025-05-24T21:26:49.367573830Z",
    "_updatedAt": "2025-05-24T21:26:49.367574131Z"
} 

Update workflow 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 body example

{
    "_status": "TERMINATED"
} 

Response

Codes

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

Response example

{
    "_id": "1e4a4a33-32a7-4032-b61e-4667b2c7591a",
    "_workflowDefId": "dc387699-bc7f-472f-95cd-60c7bdb53432",
    "_name": "longrun_workflow",
    "_namespaces": [
        "xxxxx"
    ],
    "_userType": "iaq_realtime_setup",
    "_tasks": [
        {
            "_id": "a7c51e59-9a59-4fef-ad69-3e09c57877da",
            "_name": "longrun_task_1",
            "_sequenceno": 1,
            "_type": "WAIT",
            "_status": "IN_PROGRESS"
        }
    ],
    "_timeoutSeconds": null,
    "_timeoutPolicy": null,
    "_status": "TERMINATED",
    "_createdAt": "2025-11-06T05:26:06.059196Z",
    "_updatedAt": "2025-11-06T05:31:22.778432671Z",
    "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",
    "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc"
}