Skip to main content Skip to complementary content

GetTaskList

General

URL

https://{host}/attunityenterprisemanager/api/v1/servers/{ServerName}/tasks

Description

Receive a list of tasks per selected and authorized server. For each task, the API returns a few parameters.

Method

GET

Required user role

See Required Enterprise Manager permissions.

Request parameters

Request parameters
Location Name Required Example

URL

host [string]

Yes

computer.network.net

URL

ServerName [string]

Yes

myrepsrv1

Header

EnterpriseManager.APISessionID [string]

Yes

wCo0_KvjEUFROvfHF5KGrw

Response body

{

"taskList": [{

"name": "{string}",

"state": "{enum task_state}",

"stop_reason": "{enum stop_reason}",

"message": "{string}",

"assigned_tags": ["string", "string", "string", …]

}, {

"name": "{string}",

"state": "{enum task_state}",

"stop_reason": "{enum stop_reason }",

"message": "{string}",

"assigned_tags": ["string", "string", "string", …]

}, {

"name": "{string}",

"state": "{enum task_state}",

"stop_reason": "{enum stop_reason}",

"message": "{string}",

"assigned_tags": ["string", "string", "string", …]

}

]

}

Response parameters

Response parameters
Name Description
name
  • Replicate: - The name of the task.
  • Compose: - The name of the task or workflow appended with a double underscore and the project name.

    Example:  

    mytask__myproject

state

The current state of the task.

stop_reason

The reason the task has stopped. For Compose tasks, this will always be NONE.

message

The message if the task stopped due to an error.

assigned_tags

Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned.

cURL example

Request

curl -i -k --header "EnterpriseManager.APISessionID: wCo0_KvjEUFROvfHF5KGrw" https://computer.network.net/attunityenterprisemanager/
api/v1/servers/myrepsrv1/tasks

Response

Information note

For Compose tasks, the task"name" response will be in the following format: taskName__projectName.

Headers:

HTTP/1.1 200 OK

Cache-Control: no-cache, no-store

Content-Length: 205

Content-Type: application/json; charset=utf-8

Server: Microsoft-HTTPAPI/2.0

Date: Mon, 26 Dec 2016 11:18:53 GMT

Payload

{

"taskList": [{

"name": "Task1",

"state": "RUNNING",

"stop_reason": "NONE",

"message": "NONE",

"assigned_tags": ["MyTag1", "MyTag2", "MyTag3"]

}, {

"name": " Task2",

"state": "STOPPED",

"stop_reason": "FULL_LOAD_ONLY_FINISHED",

"message": "NONE,

"assigned_tags": ["MyTag5"]

}, {

"name": "Task3",

"state": "RUNNING",

"stop_reason": "NONE",

"message": "NONE",

"assigned_tags": []

}

]

}

Errors

See general errors.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!