Reference: Tasks

URL Endpoint

Supported HTTP VERB(s)

GET <TASK DETAILS>

Request URI

/api/rest/v1/{tenant}/tasks: Retrieves the details of integration tasks defined in the instance.

Retrieves all integration tasks of the tenant.

Sample Request URI:

https://api.adaptiveinsights.com/api/rest/tasks/v1/<tenant>/tasks?instanceCode=<instanceCode>

Sample Request Header

Authorization: Basic or Token based

Sample Request Body

N/A

Path Parameters

Name	Description
tenant	The customer instance code

Query Parameters

Name	Description	Required
limit	The number of integration tasks to include in the result. type: number min: 1 max: 100 example: limit=50	N
offset	The number of tasks to skip before starting to include tasks in the results. min: 0 example: offset=0	N
taskType	Filter the retrieved tasks by their task type. Integration example: taskType=integration	N

Response

List of tasks

Sample successful tasks GET Response

HTTP/1.1 200 Ok Content-Type: application/json { "count": 3, "data": [ { "id": "integration4", "taskType": "integration", "name": "An Integration Task" }, { "id": "integration111", "taskType": "integration", "name": "Another Integration Task" }, { "id": "integration43", "taskType": "integration", "name": "Also Another Integration Task" } ] }

Response Payload

name	description
count	The total number of customer integration tasks (not just those included in this response). Type: number
data	A collection of integration tasks. Type: Array Type definition: Id: The integration task’s unique identifier. Name: The integration task’s name.

Unsuccessful Response

Sample bad tasks request response

{ "type" : "validation-error", "title": "invalid request", "errors" : [ { "message" : "must be a non-negative integer", "parameter" : "offset" }, { "message" : "must be positive integer no greater than 100", "parameter" : "limit" }, { "message" : "must be a valid task type", "parameter" : "kind" } ] }

Where the response payload is

Response Payload

Name	Description
type	The type of error.
title	Text describing the error.
errors	A collection of errors found in the request. Type: array Type definition: message: A message describing the error. parameter: The parameter to which the error is related.

POST

Request URI

Trigger a run of the task represented by the passed task identifier.

/{taskId}/runs

Sample Request URI:

https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs?instanceCode=<instanceCode>

In this example, the taskId is integration111.

Sample Request Header

Authorization: Basic or Token based

Content-Type: application/json

Sample Request Body

Request body required. It must not be empty.

Request Body

{ }

Path Parameter

Name	Description	Required
taskId	The task id of the task being triggered.	Y

Sample Response

Successful Trigger Task Run Response

HTTP/1.1 201 Created Content-Type: application/json { "id": "taskrun456", "status": "Completed" }

GET <TASK RUN DETAILS>

Request URI

Retrieve the details of the task run represented by the passed task identifier.

/{taskId}/runs/{taskRunId}

Sample Request URI:

https://api.adaptiveinsights.com/api/rest/tasks/v1/{tenant}/tasks/integration111/runs/taskrun456?instanceCode=<instanceCode>

In this example, we use these IDs:

ID	Value
taskId	integration111
taskRunId	taskrun456

Path Parameters

Name	Description
taskId	The unique identifier of the integration task that was run.
taskRunId	The unique identifier of the task run.

Sample Response

Successful Get Task Run Response

{ "id": "taskrun456", "status": "Completed" }

Response Payload

Name	Description
id	The unique identifier of this integration task run.
status	The task run’s status, either: None Pending InProgress Canceling Canceled Completed Failed