list_tasks RESTful API - Teradata Data Mover

Teradata Data Mover User Guide
Product
Teradata Data Mover
Release Number
16.10
Published
June 2017
Language
English (United States)
Last Update
2018-03-29
dita:mapPath
kmo1482331935137.ditamap
dita:ditavalPath
ft:empty
dita:id
B035-4101
lifecycle
previous
Product Category
Analytical Ecosystem

Purpose

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

The list_job_definition 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

agent
Description: Agent currently running the task, or '-' if queued
JSON Data Type: String
jobName
Description: Name of the associated job
JSON Data Type: String
priority
Description: Priority of the associated job, where possible value is one of the following:
  • UNSPECIFIED
  • LOW
  • MEDIUM
  • HIGH
JSON Data Type: string
queue
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
sourceSystem
Description: Database system from which task is moving data
JSON Data Type: string
status
Description: Status of the task, where the value is one of the following:
  • QUEUED
  • RUNNING
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
userPool
Description: Pool name, or '-' if none used
JSON Data Type: Integer
utility
Description: Utility on which task depends
JSON Data Type: String

Status Codes

If the command executes without error, the API returns status code 200 in the response header and nothing in the response body.

If an error occurs during execution, the API returns a non-200 status code in the response header and an error message in JSON format in the response body.

Response Example

[
    {
        "taskID": "138",
        "jobName": "ast-1",
        "taskStatus": "RUNNING",
        "agentName": [ ],
        "queueName": "NOT_QUEUED",
        "utility": "JDBC",
        "srcSystem" : "10.25.46.85",
        "targetSystem": "sdlc7614.labs.teradata.com"
        "jobPriority" : "MEDIUM",
        "lastUpdateTime" : 1450480158375
    }
]