List Tasks | RESTful API | Teradata Data Mover - 17.11 - List Tasks (RESTful API) - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.11
Release Date
October 2021
Content Type
User Guide
Publication ID
B035-4101-091K
Language
English (United States)

Purpose

The list_tasks RESTful API displays a list of queued and running tasks, including information about status and execution.

The list_tasks RESTful API uses the following URL and method:
Item Description
URL /datamover/tasks
Method GET

Request Parameters

jobName
Description: List tasks associated with specified job name
Required: No
taskId
Description: List tasks associated with specified task ID
Required: No
agentName
Description: List tasks running on specified agent
Required: No
taskStatusMode
Description: List tasks in one of the following specified modes:
  • A (ALL): All modes
  • Q (QUEUED): All queued tasks
  • R (RUNNING) All running tasks
Required: No
If you do not specify a mode, Data Mover includes all modes.

Response Parameters

agentNames
Description: Agent currently running the task, or '-' if queued
JSON Data Type: String Array
jobName
Description: Name of the associated job
JSON Data Type: String
jobPriority
Description: Priority of the associated job, where possible value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: String
lastUpdateTime
Description: Time of last update.
JSON Data Type: Long
queueName
Description: Queue in which the task is waiting, or NOT_QUEUED if running
JSON Data Type: String
queueOrder
Description: Task position in the queue, or '-' if running
JSON Data Type: String
srcSystem
Description: Database source system from which the task is moving data
JSON Data Type: String
targetSystem
Description: Database system to which task is moving data
JSON Data Type: String
taskId
Description: Task ID
JSON Data Type: Integer
taskStatus
Description: Status of the task, where the value is one of the following:
  • QUEUED
  • RUNNING
JSON Data Type: String
targetUserPoolName
Description: Pool name, or '-' if none used
JSON Data Type: String
utility
Description: Utility on which task depends
JSON Data Type: String

Response Example

[
    {
        "taskID": "499",
        "jobName": "ast-1",
        "taskStatus": "QUEUED",
        "agentNames": [ ],
        "queueName": "LOAD_SLOT",
        "utility": "TPTAPI_LOAD",
        "srcSystem" : "10.25.46.85",
        "targetSystem": "sdt16849.labs.teradata.com"
        "jobPriority" : "LOW",
        "lastUpdateTime" : 1536693540772 
    }
]