Every Connect ETL job is tracked by a unique identifier, whether scheduled or run. To access metadata about a job, you require its unique identifier, and the dmxjob API resource retrieves job run IDs that match various parameters.
URI
projects/dmxjob/HTTP Methods
GET
Parameters
All the parameters shown in table below are optional. If no parameters are specified, every job ID in the system’s history is retrieved.
| Parameter | Optional? | Description |
|---|---|---|
| name=<jobName> | Optional | Short job file name. |
| jobDirectory=<dir> | Optional | The job path on the node from which the job was submitted. |
| user=<user> | Optional | The authorizing user for a job. |
| startTime=<time>& endTime=<Time>: | Optional | A range of job start times. Times must be in “yyyy-MM-ddT hh:mm:ss” (ISO 8601) format or an error is reported. |
Response
Job metadata containing the unique job identifier. If there are no parameters, a list of all jobs is retrieved.
Example
The following output is retrieved for a request returning metadata from 2 Connect ETL
jobs:
[
{
"runId": "0adb63de-006f-42a5-a895-c01974857bed",
"detailedStatus": "SUCCEEDED",
"name": "jobDMX-24501_0001.dxj",
"userName": "dmxmgrtesting",
"jobDirectory": "",
"startTime": "May 1, 2019 3:36:10 PM",
"endTime": "May 1, 2019 3:36:13 PM"
},
{
"runId": "9491f908-6e67-4624-9588-68e9c139cc35",
"detailedStatus": "SUCCEEDED",
"name": "jobDMX-24501_0002.dxj",
"userName": "dmxmgrtesting",
"jobDirectory": "",
"startTime": "May 1, 2019 3:36:15 PM",
"endTime": "May 1, 2019 3:36:18 PM"
}
]