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

None

Response

Codes

Code	Description
200	Success

Response

{
        "_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"
            }
        }
    }

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

{
    "_userInput": {
        "value": 2,
        "userChoice": "approved",
        "param2": "1234"
    }
} 

Response

None

Codes

Code	Description
200	OK

Get LoopOver tasks

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
_count	Number	Number of tasks to return	Optional
_offset	Number	Position in list of tasks to begin listing.	Optional

Path parameters

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

Request body example

None

Response

Codes

Code	Description
200	Success

Response

[
    {
        "_id": "1be3efc5-05dc-409b-bfd8-dd147282464b",
        "_name": "rest_connector_task__1",
        "_type": "REST_CONNECTOR",
        "_sequenceno": 1,
        "_status": "COMPLETED",
        "_result": {
            "rest_conn_result": {
                "data": {}
            }
        },
        "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
            }
        }
    }
    {
        "_id": "17ad3c23-ecbf-4881-a63f-495daf0770d6",
        "_name": "rest_connector_task__2",
        "_type": "REST_CONNECTOR",
        "_sequenceno": 1,
        "_status": "COMPLETED",
        "_result": {
            "rest_conn_result": {
                "data": {}
            }
        },
        "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
            }
        }
    }
    {
        "_id": "0b1e966d-52b3-44f0-a251-c6983213e9a0",
        "_name": "rest_connector_task__3",
        "_type": "REST_CONNECTOR",
        "_sequenceno": 1,
        "_status": "COMPLETED",
        "_result": {
            "rest_conn_result": {
                "data": {}
            }
        },
        "_inputParams": {
            "_url": "https://reqres.in/api/users/2",
            "_auth": {
                "_type": "NoAuth"
            }
        }
    }
]