# GetTaskDetails

## General

### URL

Enterprise Manager May 2021:

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

From Enterprise Manager May 2021 SR1:

Replicate:

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

Compose:

https://{host}/attunityenterprisemanager/api/v1/servers/{ServerName}/tasks/{TaskName\_\_ProjectName|WorkflowName\_\_ProjectName}

### Description

Retrieves details about a selected and authorized task. The API returns full monitoring information related to the selected task.

### HTTP method

GET

### Required user role

See [Required Enterprise Manager permissions](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Introduction/AEMPermissions.htm).

## Request parameters

Request parameters

| Location | Name | Description | Required | Example |
| --- | --- | --- | --- | --- |
| URL | host [string] | The Hostname of the Enterprise Manager machine. | Yes | computer.network.net |
| URL | ServerName [string] | The display name of the Replicate or Compose Server defined in Enterprise Manager. | Yes | myserver1 |
| URL | May 2021:<br><br>TaskName [string]<br><br>From Enterprise Manager May 2021 SR1:<br><br>For Replicate:<br><br>TaskName<br><br>For Compose:<br><br>TaskName\_\_ProjectName\|WorkflowName\_\_ProjectName[string] | May 2021:<br><br>The name of the Replicate or Compose task.<br><br>From Enterprise Manager May 2021 SR1:<br><br>The name of the Replicate task or the name of the Compose task or workflow appended with a double underscore and the project name.<br><br>Compose task example:<br><br>mytask\_\_myproject | Yes | SalesDBBackup |
| Header | EnterpriseManager.APISessionID [string] |  | Yes | wCo0\_KvjEUFROvfHF5KGrw |

## Response body for a Replicate task

```
{
```

```
	"type":"{string}",
	"name":"{string}",
	"description":"{string}",
	"state":"{enum task_state}",
	"message": "{string}",
	"source_endpoint":{
		"name":"{string}",
		"type":"{string}"
	},
	"target_endpoint":{
		"name":"{string}",
		"type":"{string}"
	},
	"cdc_event_counters":{
		"applied_insert_count":”{int64}”,
		"applied_update_count":”{int64}”,
		"applied_delete_count":”{int64}”,
		"applied_ddl_count":”{int64}”
	},
	"full_load_counters":{
		"tables_completed_count":”{int64}”,
		"tables_loading_count":”{int64}”,
		"tables_queued_count":”{int64}”,
		"tables_with_error_count":”{int64}”,
		"records_completed_count":”{int64}”,
		"estimated_records_for_all_tables_count":”{int64}”
		},
	{
	"full_load_completed":”{bool}”,
	"full_load_start":"{string}",
	"full_load_end":"{string}",
	},{
	"full_load_throughput":{
		"source_throughput_records_count":"{int32}”,
		"source_throughput_volume":"{int32}”,
		"target_throughput_records_count":"{int32}”,
		"target_throughput_volume":"{int32}”
		},{
	"cdc_throughput": {
		"source_throughput_records_count": {
		"current": “{int32}”
		},
		"source_throughput_volume": {
		"current": “{int32}”
		},
		"target_throughput_records_count": {
		"current": “{int32}”
		},
		"target_throughput_volume": {
		"current": “{int32}”
		}
	},{
	"cdc_transactions_counters":{
		"commit_change_records_count":"{int64”,
		"rollback_transaction_count":"{int64}”,
		"rollback_change_records_count":"{int64}”,
		"rollback_change_volume_mb":"{int64}”,
		"applied_transactions_in_progress_count":"{int64}”,
		"applied_records_in_progress_count":"{int64}”,
		"applied_comitted_transaction_count":"{int64}”,
		"applied_records_comitted_count":"{int64}”,
		"applied_volume_comitted_mb":"{int64}”,
		"incoming_accumulated_changes_in_memory_count":"{int64}”,
		"incoming_accumulated_changes_on_disk_count":"{int64}”,
		"incoming_applying_changes_in_memory_count":"{int64}”,
		"incoming_applying_changes_on_disk_count":"{int64}”,
		},{
	"cdc_latency":{
		"source_latency":"{int32}",
		"total_latency":"{int32}",
		},{
	"profile":"{string}",
	"task_stop_reason":"{enum task_stop_reason}",
	"memory_mb":{int64},
	"cpu_percentage":"{int32}",
	"disk_usage_mb":"{int64}",
	"data_error_count":"{int64}",
	"options":"full_load_enabled"":”{bool}”,"apply_changes_enabled":”{bool}”,"store_changes_enabled":”{bool}”,"audit_changes_enabled":”{bool}”},
	"log_stream_staging":"{string}",
	"assigned_tags": ["string", "string", "string", …]
	}
```

## Response parameters for Replicate tasks

General parameters

| Name | Description |
| --- | --- |
| type | The task type: ReplicateTaskInfoDetailed |
| name | The name of the task. |
| description | The task description. If there is no description, an empty string will be returned. |
| [State](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#task_state) | The current state of the task. |
| message | The message returned if the task stopped due to error. |

Source endpoint parameters

| Name | Description |
| --- | --- |
| name | The name of the source endpoint. |
| [type](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#Source_type) | The source endpoint type. |

Target endpoint parameters

| Name | Description |
| --- | --- |
| name | The name of the target endpoint. |
| [type](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#Target_type) | The target endpoint type. |

cdc\_event\_counterscdc\_event\_counters parameters

| Name | Description |
| --- | --- |
| applied\_insert\_count | The number of records added in total for all tables. |
| applied\_update\_count | The number of records updated in total for all tables. |
| applied\_delete\_count | The number of records deleted in total for all tables. |
| applied\_ddl\_count | The total number of metadata changes, such as add column. |

full\_load\_countersfull\_load\_counters parameters

| Name | Description |
| --- | --- |
| tables\_completed\_count | The number of tables that have been loaded into the target endpoint. |
| tables\_loading count | The number of tables that are currently being loaded into the target endpoint. |
| tables\_queued\_count | The number of tables that are waiting to be loaded due to an error. |
| tables\_with\_error\_count | The number of tables that could not be loaded due to an error. |
| records\_completed\_count | The total number of records that have completed loading into the target endpoint. |
| estimated\_records\_for\_all\_tables\_count | The estimated number of records remaining to be loaded into the target endpoint. |
| full\_load\_completed | Indicates whether the full load process has ended. |
| full\_load\_start | The start time of the full load process.<br><br>Format: YYY MM DD<br><br>Timezone: UTC |

full\_load\_throughput indicates how fast the table records are being replicated to the target endpoint (by number or volume of records).

full\_load\_throughputfull\_load\_throughput parameters

| Name | Description |
| --- | --- |
| full\_load\_throughput | Indicates how fast the table records are being replicated to the target endpoint (by number or volume of records). |
| source\_throughput\_records\_count | The current source throughput, in rec/sec. |
| source\_throughput\_volume | The current source throughput, in kbyte/sec. |
| target\_throughput\_records\_count | The current target throughput, in rec/sec. |
| target\_throughput\_volume | The current target throughput, in kbyte/sec. |

cdc\_throughput indicates how fast the table records are being replicated to the target endpoint (by number or volume of records). Refers only to the current/last CDC.

cdc\_throughputcdc\_throughput parameters

| Name | Description |
| --- | --- |
| source\_throughput\_records\_count | The current source throughput, in rec/sec. |
| source\_throughput\_volume | The current source throughput, in kbyte/sec. |
| target\_throughput\_records\_count | The current target throughput, in rec/sec. |
| target\_throughput\_volume | The current target throughput, in kbyte/sec. |

cdc\_transaction\_counters contains all numeric data concerning CDC transactions.

cdc\_transaction\_counterscdc\_transaction\_counters parameters

| Name | Description |
| --- | --- |
| commit\_change\_records\_count | The number of COMMIT change records. |
| rollback\_tranaction\_count | The number of ROLLBACK transactions. |
| rollback\_change\_records\_count | The number of ROLLBACK change records. |
| rollback\_change\_volume\_mb | The volume of ROLLBACK change, in MB. |
| applied\_transactions\_in\_progress\_count | The number of transactions in progress. |
| applied\_records\_in\_progress\_count | The sum of all records/events in all In-Progress transactions. |
| applied\_committed\_transaction\_count | The number of transactions committed. |
| applied\_records\_committed\_count | The sum of all records/events in all Completed transactions. |
| applied\_volume\_committed\_mb | The sum of all volume/events in all Completed transactions, in MB. |
| incoming\_accumulated\_changes\_in\_memory\_count | The number of changes accumulated in memory until source commit. |
| incoming\_accumulated\_changes\_on\_disk\_count | The number of changes accumulated on disk until source commit. |
| incoming\_applying\_changes\_in\_memory\_count | The number of changes in memory during apply and until target commit. |
| incoming\_applying\_changes\_on\_disk\_count | The number of changes on disk during apply and until target commit |

cdc\_latencycdc\_latency parameters

| Name | Description |
| --- | --- |
| source\_latency | The time gap between the original change in the source endpoint and capturing it, in hh:mm:ss. |
| total\_latency | The overall latency (source latency + target latency + apply latency), in hh:mm:ss. |
| profile | See [Profile Parameters](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm). |
| [task_stop_reason](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#reason) | The reason the task stopped. |
| memory\_mb | The current utilization of memory, in MB. A task's memory utilization is sampled every 10 seconds. When the task is not running, the value is set to zero (0). |
| cpu\_percentage<br><br>Information note<br><br>Only available for Replicate tasks running on Replicate 6.2 and above. When not available, this parameter will be returned as -1. | The current CPU usage of the Replicate task process. |
| disk\_usage\_mb | The current utilization of disk space, in MB. A task's disk utilization is sampled every minute. |
| data\_error\_count | The total number of data errors in all tables involved in the task. The count is affected by data errors and the Reset Data Errors option available when you drill down to a task. |
| full\_load\_enabled | See [Task Options](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#task_options). |
| apply\_changes\_enabled | See [Task Options](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#options). |
| store\_changes\_enabled | See [Task Options](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#task_options). |
| audit\_changes\_enabled | See [Task Options](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#options). |
| log\_stream\_staging | If the task is writing to/reading from the Log Stream staging folder, the name of the associated Log Stream Staging task will be returned. Otherwise, an empty string will be returned. |
| assigned\_tags | Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned. |

## Response body for a Compose task

```
{
	"$type": "{string}",
	"project": "{string}",
	"profile": "{string}",		
	"loading_completed": "{bool}",
	"loading_start": "{string}",
	"loading_end": "{string}",
	"options": {
		"full_load_enabled": "{bool}",
		"apply_changes_enabled": "{bool}"
	},
	"loading_counters": {
		"tables_total_count": "{int64}",
		"tables_completed_count": "{int64}",
		"tables_loading_count": "{int64}",
		"tables_queued_count": "{int64}",
		"tables_with_error_count": "{int64}",
		"commands_total_count": "{int64}",
		"commands_completed_count": "{int64}" 
	},
	"name": "{string}",
 	"message": "{string}",
	"state": "{enum task_state}",
	"description": "{string}",
	"source_endpoint": {
		"name": "{string}",
		"type": "{string}"
	},
	"target_endpoint": {
		"name": "{string}"
		"type": "{string}"
	},
	"assigned_tags": ["string", "string", "string", …]
}	
```

## Response parameters for Compose tasks

General parameters

| Name | Description |
| --- | --- |
| type | One of the following:<br><br><ul> <li>AemComposeDWTaskInfoDetailed (for Data Warehouse tasks)</li> <li>AemComposeDMTaskInfoDetailed (for Data Mart tasks)</li> <li>AemComposeDLTaskInfoDetailed (for Data Lake tasks)</li> </ul> |
| project | The name of the Compose project. |
| profile | See [Profile Parameters](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm). |
| name | Enterprise Manager May 2021:<br><br>The name of the task.<br><br>From Enterprise Manager May 2021 SR1:<br><br>The name of the task appended with a double underscore and the project name.<br><br>Example:<br><br>mytask\_\_myproject |
| description | The task description. If there is no description, an empty string will be returned. |
| [state](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/Shared/aem_rest_api_response_params.htm#task_state) | The current task state. |
| message | The message returned if the task stopped due to error. |
| options:<br><br><ul> <li>full_load_enabled - Indicates whether the Full Load option is enabled. Can be "true" or "false".</li> </ul><br><br><ul> <li>apply_changes_enabled - Indicates whether the Change Processing option is enabled. Can be "true" or "false".</li> </ul> |  |

source\_endpoint source\_endpoint parameters

| Name | Description |
| --- | --- |
| name | The logical name of the landing database. |
| type | The landing database type. |

target\_endpointtarget\_endpoint parameters

| Name | Description |
| --- | --- |
| name | The logical name of the storage database. |
| type | The storage database type. |
| loading\_completed | Indicates whether the loading process has completed. Can be "true" or "false" |
| loading\_start | The start time of the loading process.<br><br>Format: YYY MM DD<br><br>Timezone: UTC |
| loading\_end | The end time of the loading process.<br><br>Format: YYY MM DD<br><br>Timezone: UTC |

loading\_countersloading\_counters parameters

| Name | Description |
| --- | --- |
| tables\_total\_count | The total number of tables. |
| tables\_completed\_count | The number of tables that have been loaded into the target endpoint. |
| tables\_loading count | The number of tables that are currently being loaded into the target endpoint. |
| tables\_queued\_count | The number of tables that are waiting to be loaded due to an error. |
| tables\_with\_error\_count | The number of tables that could not be loaded due to an error. |
| commands\_total\_count | The total number of commands executed. |
| commands\_completed\_count | The total number of commands completed. |
| 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 for Replicate tasks

### Request

`curl -i -k --header "EnterpriseManager.APISessionID: {SessionID}" https://{host}/attunityservices/api/v1/servers/myrepsrv1/tasks/SalesDBBackup`

### Response

Information note

For Compose tasks, from Enterprise Manager May 2021 SR1, 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: 1658`

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

`Server: Microsoft-HTTPAPI/2.0`

`Date: Mon, 26 Dec 2016 13:18:27 GMT`

### Payload

`{`

`"name":"SalesDBBackup",`

`"description":"Backs up annual sales",`

`"state":"RUNNING",`

`"message":"NONE",`

`"source_endpoint":{
`

`"name":"Customer Management",`

`"type":"Oracle",`

`},`

`"target_endpoint":{`

`"name":"Business Management",`

`"type":"Microsoft SQL Server",`

`},`

`"cdc_event_counters":`

`{"applied_insert_count":0,`

`"applied_update_count":0,`

`"applied_delete_count":0,`

`"applied_ddl_count":0`

`},{`

`"full_load_counters":{`

`"tables_completed_count":3,`

`"tables_loading_count":0,`

`"tables_queued_count":0,`

`"tables_with_error_count":0,`

`"records_completed_count":177446,`

`"estimated_records_for_all_tables_count":177446,`

`"full_load_completed":true,`

`"full_load_start":"2016-12-18T02:23:30",`

`"full_load_end":"2016-12-18T02:23:35",`

`},{`

`"full_load_throughput":{`

`"source_throughput_records_count":0,`

`"source_throughput_volume":0,`

`"target_throughput_records_count":0,`

`"target_throughput_volume":0},`

`},{`

`"cdc_throughput":{`

`"source_throughput_records_count": {`

`"current": 0`

`},`

`"source_throughput_volume": {`

`"current": 0`

`},`

`"target_throughput_records_count": {`

`"current": 0`

`},`

`"target_throughput_volume": {`

`"current": 0`

`}`

`},{`

`"cdc_transactions_counters":{`

`"commit_change_records_count":0,`

`"rollback_transaction_count":0,`

`"rollback_change_records_count":0,`

`"rollback_change_volume_mb":0,`

`"applied_transactions_in_progress_count":0,`

`"applied_records_in_progress_count":0,`

`"applied_comitted_transacion_count":0,`

`"applied_records_comitted_ count":0,`

`"applied_volume_comitted_mb":0,`

`"incoming_accumulated_changes_in_memory_count":0,`

`"incoming_accumulated_changes_on_disk_count":0,`

`"incoming_applying_changes_in_memory_count":0,`

`"incoming_applying_changes_on_disk_count":0},`

`},{`

`"cdc_latency":{`

`"source_latency":"00:00:00",`

`"total_latency":"00:00:00"},`

`},{`

`"profile":"UNIDIRECTIONAL",`

`"task_stop_reason":"NORMAL",`

`"memory_mb":57,`

`"cpu_percentage":30,`

`"disk_usage_mb":0,`

`"data_error_count":0,`

`"options":{"full_load_enabled":true,"apply_changes_enabled":true,"store_changes_enabled":false,"audit_changes_enabled":false}`

`"log_stream_staging":"MyLogStreamTask",`

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

`}`

## Error response

All of the [general errors](https://help.qlik.com/en-US/enterprise-manager/November2025/Content/EnterpriseManager/EnterpriseManager_APIGuide/PythonAPI/error_handling.htm) as well as the errors listed in the table below.

Error responses

| HTTP Code | Qlik Enterprise Manager Code | Text | Description |
| --- | --- | --- | --- |
| 500 | AEM\_TASK\_NOT\_FOUND | Replicate task {task} on server {server} could not be found. | The task name is unknown to Enterprise Manager. |