Version: v5.1

Tasks

Get task by ID#

Retrieves details of a specific task by its ID.

Endpoints#

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

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowid`	String	ID of workflow to search for	Required
`taskid`	String	ID of task to search for	Required

Request example#

GET /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155/tasks/f99d9656-f424-450d-b638-fbb28bc22490?nsfilter={{nsfilter}}

Response#

Codes#

Code	Description
`200`	Success

Response example#

{  "_id": "f99d9656-f424-450d-b638-fbb28bc22490",  "_name": "REST_CONNECTOR",  "_type": "REST_CONNECTOR",  "_sequenceno": 1,  "_status": "QUEUED",  "_inputParams": {    "_url": "https://api.spotify.com/v1/artists/0TnOYISbd1XYRBk9myaseg"  }}

Update task status - user input task#

Updates the status of a user input task.

Endpoints#

POST /workflowsvc/api/v1/workflow/{workflowid}/userinput/{userinputid}

Request#

Query parameters#

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

Path parameters#

Parameter	Type	Description	Required
`workflowid`	String	ID of Workflow	Required
`userinputid`	String	ID of user input ID	Required

Request example#

POST /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155/userinput/123e4567-e89b-12d3-a456-426614174000?nsfilter={{nsfilter}}Content-Type: application/json
{  "_userInput": {    "field1": "value1"  }}

Response example#

{  "message": "Task updated successfully"}

Codes#

Code	Description
`200`	OK

Get LoopOver tasks for a task#

Get the loop over list for DO While task.

Endpoints#

GET /workflowsvc/api/v1/workflow/{workflowid}/task/{taskid}/loopovertasks

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required
`_pageSize`	Number	Number of tasks to list per page. Default is 10.	Optional
`_offset`	Number	Position in list of tasks to begin listing. Default is 0.	Optional

Path parameters#

Parameter	Type	Description	Required
`taskid`	String	ID of task	Required
`workflowid`	String	ID of Workflow	Required

Request example#

GET /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155/tasks/f99d9656-f424-450d-b638-fbb28bc22490/loopovertasks?nsfilter={{nsfilter}}&_offset=0&_pageSize=10

Response#

Codes#

Code	Description
`200`	Success

Response example#

{  "_offset": 0,  "_pageSize": 10,  "_total": 0,  "_list": []}

Get Task logs#

Returns all task logs.

Endpoints#

GET /workflowsvc/api/v1/workflows/{workflowId}/tasks/{taskId}/logs

Request#

Query parameters#

Parameter	Type	Description	Required
`nsfilter`	String	Namespace filter to apply	Required
`plainText`	Boolean	Return task logs in plain text. Default is false.	Optional
`_offset`	Integer	Point at which to begin listing task logs. Default is 0.	Optional
`_pageSize`	Integer	Number of logs to list per page. Default is 10.	Optional

Path parameters#

Parameter	Type	Description	Required
`workflowid`	String	ID of Workflow	Required
`userinputid`	String	ID of user input ID	Required

Request example#

GET /workflowsvc/api/v1/workflows/94bcf41e-8d05-4011-a64b-d5a5164b0155/tasks/f99d9656-f424-450d-b638-fbb28bc22490/logs?nsfilter={{nsfilter}}&plainText=false&_offset=0&_pageSize=10

Request#

Response example#

{    "_offset": 0,    "_pageSize": 10,    "_total": 15,    "_list": [        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "In TaskExecutor.decryptInputData..."        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "paramsJson: {\n\"type\": \"object\",\n\"properties\": {\n\"_name\": {\"type\": \"string\", \"minLength\": 1},\n\"_type\": {\"type\": \"string\", \"minLength\": 1},\n\"_sequenceno\": {\"type\": \"integer\"},\n\"_inputParams\": {\n\"type\": \"object\",\n\"properties\": {\n\"_url\": {\"type\": \"string\", \"minLength\": 1},\n\"_auth\": {\n\"type\": \"object\",\n\"properties\": {\n\"_type\": {\"type\": \"string\", \"minLength\": 1},\n\"_params\": {\"type\": \"object\"}\n},\n\"required\": [\"_type\"],\n\"encrypt\": true\n},\n\"_args\": {\n\"type\": \"object\",\n\"properties\": {\n\"_headers\": {\"type\": \"object\"},\n\"headers\": {\"type\": \"object\"}\n}\n},\n\"_to\": {\"type\": \"string\"}\n},\n\"required\": [\"_url\", \"_auth\"]\n},\n\"_retryCount\": {\"type\": \"integer\"},\n\"_retryDelaySeconds\": {\"type\": \"integer\"},\n\"_retryLogic\": {\"type\": \"string\"},\n\"_timeoutSeconds\": {\"type\": \"integer\"},\n\"_timeoutPolicy\": {\"type\": \"string\"},\n\"_responseTimeoutSeconds\": {\"type\": \"integer\"}\n},\n\"required\": [\"_name\", \"_type\", \"_sequenceno\", \"_inputParams\"]\n}"        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "inputData: {_args={headers={x-api-key=reqres-free-v1}}, _url=https://dummy-json.mock.beeceptor.com/posts/1, _auth=sMb2DpFxV9UUwMEggfVFdeIljQdvgltMv5QQpkXLZ/g=}"        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "Formal params: {\"type\":\"object\",\"properties\":{\"_name\":{\"minLength\":1,\"type\":\"string\"},\"_inputParams\":{\"type\":\"object\",\"properties\":{\"_args\":{\"type\":\"object\",\"properties\":{\"_headers\":{\"type\":\"object\"},\"headers\":{\"type\":\"object\"}}},\"_to\":{\"type\":\"string\"},\"_url\":{\"minLength\":1,\"type\":\"string\"},\"_auth\":{\"encrypt\":true,\"type\":\"object\",\"properties\":{\"_type\":{\"minLength\":1,\"type\":\"string\"},\"_params\":{\"type\":\"object\"}},\"required\":[\"_type\"]}},\"required\":[\"_url\",\"_auth\"]},\"_type\":{\"minLength\":1,\"type\":\"string\"},\"_retryCount\":{\"type\":\"integer\"},\"_timeoutSeconds\":{\"type\":\"integer\"},\"_timeoutPolicy\":{\"type\":\"string\"},\"_retryLogic\":{\"type\":\"string\"},\"_sequenceno\":{\"type\":\"integer\"},\"_responseTimeoutSeconds\":{\"type\":\"integer\"},\"_retryDelaySeconds\":{\"type\":\"integer\"}},\"required\":[\"_name\",\"_type\",\"_sequenceno\",\"_inputParams\"]}"        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "Input params: {\"_args\":{\"headers\":{\"x-api-key\":\"reqres-free-v1\"}},\"_url\":\"https://dummy-json.mock.beeceptor.com/posts/1\",\"_auth\":\"sMb2DpFxV9UUwMEggfVFdeIljQdvgltMv5QQpkXLZ/g=\"}"        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "In Validator.decryptFields..."        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "In Validator.decryptFields..."        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "No _inputParams in formal params, skipping decryption..."        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "Logger initialized for RestConnectorTask"        },        {            "timestamp": "2026-03-10 17:26:08",            "level": "INFO",            "message": "Validating general parameters: {_args={headers={x-api-key=reqres-free-v1}}, _url=https://dummy-json.mock.beeceptor.com/posts/1, _auth={_type=NoAuth}}"        }    ]}