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.

Request parameters

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

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

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_transaction_counters contains all numeric data concerning CDC transactions.

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", …]
}	

cURL example for Replicate tasks

Request

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

Response

Headers:

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

Payload

{

}

Error response

All of the general errors as well as the errors listed in the table below.