GetTaskList

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

Syntax

public AemGetTaskListResp GetTaskList(

string server

);

Parameters
Parameter	Type	Description
server	string	The name of the server on which the tasks reside.

AemGetTaskListResp

Return values
Value	Type	Description
TaskList	List<AemTaskInfo>	An array of Endpoint objects.
Name	string	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	AemTaskState { STOPPED = 0, RUNNING = 1, ERROR = 2, RECOVERY = 3 }	-
StopReason	AemTaskStopReason { NONE = 0, NORMAL = 1, RECOVERABLE_ERROR = 2, FATAL_ERROR = 3, FULL_LOAD_ONLY_FINISHED = 4, STOPPED_AFTER_FULL_LOAD = 5, STOPPED_AFTER_CACHED_EVENTS = 6, EXPRESS_LICENSE_LIMITS_REACHED = 7, STOPPED_AFTER_DDL_APPLY = 8, STOPPED_LOW_MEMORY = 9, STOPPED_LOW_DISK_SPACE = 10 }	The reason the task stopped. For Compose tasks, this will always be NONE.
Message	string	The message if the task stopped due to an error.
AssignedTags	array	Returns the custom tags assigned to the task. If no tags are assigned to the task, an empty array will be returned.

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!