Overview
The status RESTful API displays the status of an executed job using the following URL and method:
Item | Description | ||
---|---|---|---|
URL | /datamover/executedJobs/executed-job-name /datamover/executingJobs/executed-job-name |
||
Method | GET |
Request Parameters
- outputLevel
- URL: /datamover/executingJobs/executed-job-name?outputLevel=value
Response Parameters
- currentStep
- Description: Most current step ID for the job, null if never executed
- endTime
- Description: End time of job, null if never executed
- estimatedJobSize
- Description: High estimate of job size
- jobExecutionId
- Description: Job execution identification
- jobName
- Description: Job name (maximum characters: 237)
- jobExecutionName
- Description: Job execution name
- lifeCycle
- Description: Lists all the events during job creation and execution
- log
- Description: Displays the utility log output
- rowCount
- Description: Row count results of the source and target objects if row count validation steps exist
- startTime
- Description: Start time of job, null if never executed
- status
- Description: Status of the job (maximum characters: 12), where possible values are listed in the status description for Request Parameters
- steps
- Description: Lists all the last steps of the job, null if never executed
- streams
- Description: Lists streams, if available
- submitTime
- Description: Time when job was submitted
- tasks
- Description: Lists all the individual tasks for each object, null if never executed
Response Example
The following example shows an array of job executions with the most common status. The links generated depend on job status.
{ "jobName" : "job1-20200128112954", "jobExecutionName" : "job1-20200128112954", "jobExecutionId" : 25, "currentStep" : 3, "startTime" : 1580239796717, "endTime" : 1580239811907, "status" : "COMPLETED", "steps" : [ { "id" : 1, "status" : "COMPLETED", "type" : "VERIFY_JOB_OBJECTS", "startTime" : 1580239799361, "endTime" : 1580239800076 }, { "id" : 2, "status" : "COMPLETED", "type" : "COMPARE_DDL", "startTime" : 1580239800186, "endTime" : 1580239802157 }, { "id" : 3, "status" : "COMPLETED", "type" : "MOVE_TABLE_DATA", "startTime" : 1580239802203, "endTime" : 1580239811792 } ], "tasks" : [ { "id" : 2570, "movePhase" : "VALIDATING", "status" : "COMPLETE", "timestamp" : 1580239799774 }, { "id" : 2571, "movePhase" : "COMPARE_DDL", "status" : "COMPLETE", "agentName" : "Agent1", "utility" : "SQL", "timestamp" : 1580239801883 }, { "id" : 2572, "movePhase" : "MOVING_DATA", "status" : "COMPLETE", "objectType" : "table", "agentName" : "Agent1", "utility" : "DSA", "timestamp" : 1580239804392 } ], "links" : [ { "rel" : "self", "href" : "https://localhost:1443/datamover/executedJobs/job1-20200128112954?outputLevel=3" } ]