Purpose
The list_job_steps RESTful API displays the lists of steps for a specified job without starting or running the job.
The list_job_steps API uses the following URL and method:
| Item | Description |
|---|---|
| URL | /datamover/jobs/[job-name]/steps |
| Method | GET |
Response Parameters
- jobName
- Description: Job name
- sourceLogin
- Description: Lists source system properties.
- targetLogin
- Description: Lists target system properties.
- steps
- Description: Lists job steps.
- sourceSession
- Description: Lists source session used.
- targetSession
- Description: Lists target session used.
- dataStream
- Description: Lists data stream used.
Response Example
{
"jobName": "tdToTdJob",
"sourceLogin":
{
"teradata":
{
"tdpid": "sourceSystem",
"username": "user",
"password": "password",
"sessionCharset": "UTF8",
"passwordEncrypted": "false"
}
},
"targetLogin":
{
"userPool": "poolA"
},
"steps":
[
{
"id": "422",
"type": "VERIFY_JOB_OBJECTS"
},
{
"id": "423",
"type": "COMPARE_DDL"
},
{
"id": "424",
"type": "MOVE_TABLE_DATA"
"tasks":
[
{
"type": "ARCTaskType",
"id": "494",
"arc_tasks":
[
{
"name": "archive_script",
"value": "ARCHIVE DATA TABLES
("test"."test"),
SKIP JOIN INDEX,
skip stat collection,
RELEASE LOCK,
FILE=ARCHIVE;
LOGOFF;"
},
{
"name": "copy_script",
"value": "LOGON $LOGON;
COPY DATA TABLES
("test"."test"),
skip stat collection,
RELEASE LOCK,
FILE=ARCHIVE;
LOGOFF;"
}
]
}
]
}
]
"sourceSession": "1",
"targetSession": "1",
"dataStream": "2"
}