Get reload history for a dataset job
/api/20210901/catalog/datasets/{datasetId}/history/{jobId}
Request
-
datasetId(required): string(byte)
The object ID of the dataset with Base64 encoding. For example, if your dataset has the object ID 'Admin'.'dataSet124', enter the Base64 encoded value, J0FkbWluJy4nZGF0YVNldDEyNCc.
-
jobId(required): string(byte)
ID of the job you want to return.
-
includeTasks: boolean(byte)
Specifies whether to return historical task and job information or only the job history. Possible values are true or false. Specify true, to return both task history and job history. Specify false, to return only job history. The default value is true.
There's no request body for this operation.
Back to TopResponse
- application/json
200 Response
object
-
jobEndTimestamp: string
Time job finished.
-
jobExecutionTimestamp: string
Time job started.
-
jobIdentifier: string
Identifier for the job.
-
jobName: string
Name of the job.
-
jobNumberOfTasks: number
Number of tasks in the job.
-
jobOriginOfRequest: string
Source of the job request. Either Manual or Schedule.
-
jobQueuedDuration: string
Length of time (in seconds) that the job spent in the queue.
-
jobRunDuration: string
Length of time taken (in seconds) for the job to run.
-
jobRunType: string
Type of job. For example: DATASET, DATAFLOW, SEQUENCE.
-
jobStartTimestamp: string
Time job requested.
-
jobStatus: string
Status of the job. For example: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.
-
jobTasks:
jobTasks
object
-
taskAverageReadThroughput: number
Average read throughput for the task.
-
taskDataSizeInBytes: number
Total data processed by the task in bytes.
-
taskEndTimestamp: string
Time the task finished.
-
taskName: string
Name of the task.
-
taskNumberOfSuccessfulRows: number
Number of rows successfully processed by this task.
-
taskRunDuration: string
Length of time taken (in seconds) for the task to run.
-
taskSourceName: string
Name of the source connection.
-
taskStartTimestamp: string
Time the task started.
-
taskStatus: string
Status of the task. For example: ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.
-
taskTargetName: string
Name of the target connection.
403 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
404 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
500 Response
object
-
code(required): string
Short error code that defines the error, meant for programmatic parsing.
-
message(required): string
Human-readable error string.
Examples
In this example, you return the detailed history of a specific reload
operation for the ID 1234ABCD5678EFGH9012IJKL3456MNOP
and a given
datasetID. The object ID of the data set is
'john.smith@mycompany.com'.'MySalesDataset' which has the Base64URL-safe encoded
datasetID value:
J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw
.
cURL Example:
curl -i \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history/1234ABCD5678EFGH9012IJKL3456MNOP' \
This example returns both job and task history for a specific job.
Example of Request Body
Not applicable.
Example of Response Body
[ { "jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'", "jobIdentifier":"1234ABCD5678EFGH9012IJKL3456MNOP", "jobStartTimestamp":"2024-06-24T16:08:44.0+0000", "jobExecutionStartTimestamp":"2024-06-24T16:09:14.0+0000", "jobEndTimestamp":"2024-06-24T16:09:45.0+0000", "jobStatus":"SUCCEEDED", "jobRunType":"DATASET", "jobNumberOfSuccessfulRows":"29796", "jobQueuedDuration":"PT1M1S", "jobRunDuration":"PT31S", "jobOriginOfRequest":"External", "jobNumberOfTasks":"1", "jobTasks":[{"taskName":"DSET : MySalesDataSet: Enrich MySales Report", "taskStartTimestamp":"2024-06-24T16:09:25.0+0000", "taskEndTimestamp":"2024-06-24T16:09:38.0+0000", "taskStatus":"SUCCEEDED", "taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet - Set 1'", "taskTargetName":"Data Set Storage", "taskAverageReadThroughput":"6127", "taskDataSizeInBytes":"458752", "taskNumberOfSuccessfulRows":"29796", "taskDuration":"PT13S"}] } ]
cURL Example with Parameters:
If you want to exclude task history, apply the query parameter
includeTasks=false
.
curl -i \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history/1234ABCD5678EFGH9012IJKL3456MNOP?includeTasks=false' \