Version: v5.0

WorkflowDefs

The Workflow definition API allows you to list Workflow definitions, search Workflow definitions by ID, create new Workflow definitions, and update Workflow definitions. You can also use this API to perform operations on schedules, jobs, and triggers.

List workflowDefs#

Endpoints#

GET workflowsvc/api/v1/workflowdefs

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required
`_count`	Integer	Number of workflow definitions to be listed. Default is 10.	Required
`_offset`	Integer	Position in list of workflow definitions to begin listing.	Required

Request body example#

None

Response#

Codes#

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

Response#

{    "_offset": 0,    "_pageSize": 10,    "_total": 2,    "_list": [        {            "_id": "4b6525cc-9bea-4521-85bf-603c50521403",            "_name": "sample_workflow",            "_description": "Sample Workflow",            "_namespaces": [                "first_tchgt1VU"            ],            "_userType": "iaq_realtime_setup",            "_taskDefs": [                {                 "_id": "2a395e10-d9f5-40b3-aa75-55903e33245b",                 "_name": "rest_connector_task",                 "_type": "REST_CONNECTOR",                 "_sequenceno": 1,                 "_inputParams": {                 "_url": "<URL>",                 "_auth": {                 "_type": "NoAuth"              }          }                {                 "_id": "5f1d8dfd-dc2f-4b28-84f4-c3bd542f661b",                 "_name": "rest_connector_task_2",                 "_type": "REST_CONNECTOR",                 "_sequenceno": 2,                 "_inputParams": {                 "_url": "<URL>",                 "_auth": {                    "_type": "NoAuth                }            ],            "_createdAt": "2025-08-15T21:18:38.295172Z",            "_updatedAt": "2025-08-15T21:18:38.295177Z",            "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",            "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",            "_timeoutSeconds": 20        },        {            "_id": "1e7895b2-743a-4d43-be22-8e789c4f1649",            "_name": "sample_workflow",            "_description": "Sample Workflow",            "_namespaces": [                "first_tchgt1VU"            ],            "_userType": "iaq_realtime_setup",            "_taskDefs": [                {                  "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f42055",                  "_name": "rest_connector_task_1",                  "_type": "REST_CONNECTOR",                  "_sequenceno": 1,                  "_inputParams": {                  "_url": "<URL>",                  "_auth": {                  "_type": "NoAuth"            }                },                {                  "_id": "510ef01f-f646-4eb2-993f-cf28f4bb4a15",                  "_name": "rest_connector_task_1",                  "_type": "REST_CONNECTOR",                  "_sequenceno": 1,                  "_inputParams": {                  "_url": "<URL>",                  "_auth": {                  "_type": "NoAuth"                }            ],            "_createdAt": "2025-08-15T21:19:40.493812Z",            "_updatedAt": "2025-08-15T21:19:40.493813Z",            "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",            "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",            "_timeoutSeconds": 20        }    ]}

Get WorkflowDef by ID#

Endpoints#

GET workflowsvc/api/v1/workflowdefs/{id}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`id`	String	ID to search for	Required

Request body example#

None

Response#

Codes#

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

Response#

{    "_id": "5792091f-4ce6-4120-a0cf-9c696b13c750",    "_name": "sample_workflow",    "_description": "Sample Workflow",    "_namespaces": [        "first_tchgt1VU"    ],    "_userType": "iaq_realtime_setup",    "_taskDefs": [        {           "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f42055",           "_name": "rest_connector_task_1",           "_type": "REST_CONNECTOR",           "_sequenceno": 1,           "_inputParams": {             "_url": "<URL>",             "_auth": {                "_type": "NoAuth"            }        },        {            "_id": "5f1d8dfd-dc2f-4b28-84f4-c3bd542f661b",            "_name": "rest_connector_task_2",            "_type": "REST_CONNECTOR",            "_sequenceno": 2,            "_inputParams": {               "_url": "<URL>",               "_auth": {                    "_type": "NoAuth"               }             }        }       }    ],    "_createdAt": "2025-08-15T21:53:29.458161Z",    "_updatedAt": "2025-08-15T21:53:29.458163Z",    "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",    "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",    "_timeoutSeconds": 20}

Create a new WorkflowDef#

Endpoints#

POST workflowsvcsvc/api/v1/workflowdefs?nsfilter={{nsfilter}}

Request#

Query parameters#

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

Request body#

Parameter	Type	Description	Required
`_name`	String	Name of the workflow	Required
`_description`	String	Description of the workflow	Optional
`_userType`	String	User type or category	Required
`_namespaces`	Array	List of namespaces(filters)	Required
`_taskDefs`	Array	List of task definitions	Required
`_timeoutSeconds`	Integer	Timeout for the workflow in seconds	Optional

Request body example#

{    "_name": "sample_workflow",    "_description": "Sample Workflow",    "_userType": "iaq_realtime_setup",    "_namespaces": [        "{{nsfilter}}"    ],    "_taskDefs": [        {            "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f4200",            "_name": "rest_connector_task_1",            "_type": "REST_CONNECTOR",            "_sequenceno": 1,            "_inputParams": {            "_url": "<URL>",            "_auth": {                "_type": "NoAuth"            }        },        {            "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f4200",            "_name": "rest_connector_task_1",            "_type": "REST_CONNECTOR",            "_sequenceno": 1,            "_inputParams": {            "_url": "<URL>",            "_auth": {                "_type": "NoAuth"            }           }        }    ],    "_timeoutSeconds": 20}

Response#

Codes#

Code	Description
`201`	Created
`400`	Bad request
`401`	Unauthorized
`403`	Forbidden
`500`	Internal server error

Response#

{    "_id": "1e7895b2-743a-4d43-be22-8e789c4f1649",    "_name": "sample_workflow",    "_description": "Sample Workflow",    "_namespaces": [        "first_tchgt1VU"    ],    "_userType": "iaq_realtime_setup",    "_taskDefs": [        {            "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f42044",            "_name": "rest_connector_task_1",            "_type": "REST_CONNECTOR",            "_sequenceno": 1,            "_inputParams": {            "_url": "<URL>",            "_auth": {                "_type": "NoAuth"            }        },        {            "_id": "510ef01f-f646-4eb2-993f-cf28f4bb4a10",            "_name": "rest_connector_task_1",            "_type": "REST_CONNECTOR",            "_sequenceno": 1,            "_inputParams": {            "_url": "<URL>",            "_auth": {                "_type": "NoAuth"            }          }        }       }    ],    "_createdAt": "2025-08-15T21:19:40.493812263Z",    "_updatedAt": "2025-08-15T21:19:40.493813055Z",    "_createdBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",    "_updatedBy": "c9daff7e-b55b-41ec-aa46-d0150f3199dc",    "_timeoutSeconds": 20}

Update a WorkflowDef#

Endpoints#

PUT workflowsvc/api/v1/workflowdefs/{workflowdefid}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required

Request body#

Parameter	Type	Description	Required
`_name`	String	Name of the workflow definition	Required
`_description`	String	Description of the workflow definition	Optional
`_userType`	String	User type or category	Required
`_namespaces`	Array	List of namespaces (filters)	Required
`_taskDefs`	Array	List of task definitions	Required
`_timeoutSeconds`	Integer	Timeout for the workflow in seconds	Optional

Request body example#

{    "_name": "sample_workflow",    "_description": "Sample Workflow",    "_namespaces": [        "RefAppProject_w3MFXx7h"    ],    "_userType": "iaq_realtime_setup",    "_class": null,    "_taskDefs": [        {            "_id": "36ed7fcb-202e-4bf9-b9a3-866de1f41055",            "_name": "rest_connector_task_1",            "_type": "REST_CONNECTOR",            "_retryCount": null,            "_retryDelaySeconds": null,            "_retryLogic": null,            "_timeoutSeconds": null,            "_timeoutPolicy": null,            "_responseTimeoutSeconds": null,            "_inputParams": {                "param1": "Value11111",                "param2": "Value22222"            },            "_sequenceno": 1,            "_decisionCases": null,            "_forkTasks": null,            "_loopCondition": null,            "_loopOver": null        }    ],    "_createdAt": "2025-05-24T13:53:42.502944181Z",    "_updatedAt": "2025-05-24T13:53:42.502947953Z",    "_timeoutSeconds": null,    "_timeoutPolicy": null}

Response#

Codes#

Code	Description
`200`	OK
`400`	Bad request
`401`	Unauthorized
`403`	Forbidden
`500`	Internal server error

Response#

{    "_id": "b4c93f0e-ea76-4f6a-a5bc-1fcff621c6b9",    "_name": "sample_workflow",    "_description": "Sample Workflow",    "_namespaces": [        "RefAppProject_w3MFXx7h"    ],    "_userType": "iaq_realtime_setup",    "_class": null,    "_taskDefs": [          {            "_id": "2a395e10-d9f5-40b3-aa75-55903e33245b",            "_name": "rest_connector_task",            "_type": "REST_CONNECTOR",            "_sequenceno": 1,            "_inputParams": {            "_url": "<URL>",            "_auth": {            "_type": "NoAuth"            }           },          }            "_sequenceno": 1,            "_decisionCases": null,            "_forkTasks": null,            "_loopCondition": null,            "_loopOver": null        }    ],    "_createdAt": "2025-05-24T13:53:42.502944Z",    "_updatedAt": "2025-05-24T13:54:37.240714901Z",    "_timeoutSeconds": null,    "_timeoutPolicy": null}

Delete a WorkflowDef by ID#

Endpoints#

DELETE workflowsvc/api/v1/workflowdefs/{id}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`id`	String	ID of workflow	Required

Request body example#

None

Response#

Codes#

Code	Description
`204`	No content
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`500`	Internal Server Error

Response#

None

Get schedules#

Endpoints#

GET /workflowsvc/api/v1/workflowdefs/{workflowdefid}/schedules

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required

Request body example#

None

Response#

Codes#

Code	Description
`200`	Success

Response example#

{    "_schedules": [        {            "_triggerKey": "6da64b5bd2ee-8604f9b5-158c-4ea3-b8d9-4e34201dfd29",            "_runInterval": "0 0/5 11 16 8 ? 2025",            "_jobKey": "workflowRunJob-5792091f-4ce6-4120-a0cf-9c696b13c750-1755295126413",            "_nextFireTime": "Sat Aug 16 11:00:00 UTC 2025"        }    ],    "_workflowDefId": "5792091f-4ce6-4120-a0cf-9c696b13c750"}

Create a schedule#

Endpoints#

POST /workflowsvc/api/v1/workflowdefs/{workflowdefid}/schedules

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required

Request body parameters#

Parameter	Type	Description	Required
`_schedule`	Object	Schedule configuration details	Required
`_schedule._type`	String	Type of schedule (for example, COMPLETION_BASED, TIME_BASED)	Required
`_schedule._runInterval`	String	Cron expression specifying when to run the workflow	Required
`_namespaces`	Array	List of namespaces in this schedule	Required

Request body example#

{    "_workflowDefId": "{{workflowDefId}}",    "_schedule":{        "_type":"COMPLETION_BASED",        "_runInterval": "0 0/5 11 16 8 ? 2025"    },    "_namespaces": [        "{{nsfilter}}"    ],    "_inputParams":{        "param1": "test"    }}

Response#

Codes#

Code	Description
`201`	Created

Response example#

{    "_namespaces": [        "first_tchgt1VU"    ],    "_inputParams": {        "param1": "test"    },    "_workflowDefId": "5792091f-4ce6-4120-a0cf-9c696b13c750",    "workflowDefName": "sample_workflow",    "jobKey": "workflowRunJob-5792091f-4ce6-4120-a0cf-9c696b13c750-1755295126413",    "_schedule": {        "_runInterval": "0 0/5 11 16 8 ? 2025",        "_type": "COMPLETION_BASED"    }}

Get jobs#

Endpoints#

GET /workflowsvc/api/v1/workflowdefs/{workflowdefid}/jobs

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required

Request body example#

None

Response#

Codes#

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

Response example#

{    "_triggers": [        {            "_triggerKey": "6da64b5bd2ee-8604f9b5-158c-4ea3-b8d9-4e34201dfd29",            "_runInterval": "0 0/5 11 16 8 ? 2025",            "_nextFireTime": "2025-08-16T11:00:00.000+00:00"        }    ],    "_workflowDefId": "5792091f-4ce6-4120-a0cf-9c696b13c750",    "_jobKey": "workflowRunJob-5792091f-4ce6-4120-a0cf-9c696b13c750-1755295126413"}

Get triggers#

Endpoints#

GET /workflowsvc/api/v1/workflowdefs/{workflowdefid}/triggers

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required

Request body example#

None

Response#

Codes#

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

Response example#

{    "_triggers": [        {            "_triggerKey": "6da64b5bd2ee-8604f9b5-158c-4ea3-b8d9-4e34201dfd29",            "_runInterval": "0 0/5 11 16 8 ? 2025",            "_nextFireTime": "2025-08-16T11:00:00.000+00:00"        }    ],    "_workflowDefId": "5792091f-4ce6-4120-a0cf-9c696b13c750",    "_jobKey": "workflowRunJob-5792091f-4ce6-4120-a0cf-9c696b13c750-1755295126413"}

Delete a job#

Endpoints#

DELETE /workflowsvc/api/v1/workflowdefs/{workflowdefid}/jobs/{id}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required
`jobid`	String	ID of job	Required

Request body example#

None

Response#

Codes#

Code	Description
`204`	No content
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`500`	Internal Server Error

Response#

None

Delete a trigger#

Endpoints#

DELETE /workflowsvc/api/v1/workflowdefs/{workflowdefid}/triggers/{id}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowdefid`	String	ID of workflow definition	Required
`id`	String	ID of trigger	Required

Request body example#

None

Response#

Codes#

Code	Description
`204`	No content
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found
`500`	Internal Server Error

Response#

None

Note: If all triggers of a job are deleted, then the job will also get deleted.