1. REST API for Oracle Analytics Cloud
  2. Tasks
  3. Catalog
  4. Datasets

Get reload history for a dataset

get

/api/20210901/catalog/datasets/{datasetId}/history

Get reload history for a dataset

Request

Path Parameters
  • 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.
Query Parameters
  • retrieve jobs with start time after this value. Acceptable formats yyyy-MM-dd'T'HH:mm:ss.SZ, yyyy-MM-dd HH:mm:ss, yyyy-MM-dd.
  • possible values:\ true or false. Default value is true. If true, all task histories will be included in job histories. If false, only job histories will be returned.
  • value of status of jobs to be retrieved. Example of possible values:\ ACCEPTED, IN_PROGRESS, FAILED, SUCCEEDED, CANCELING, CANCELED.
  • number of job histories to be retrieved starting from the newest. If not present, all jobs of the object will be returned.
  • retrieve jobs with start time before this value. Acceptable formats yyyy-MM-dd'T'HH:mm:ss.SZ, yyyy-MM-dd HH:mm:ss, yyyy-MM-dd.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Successful operation.
Body ()
Root Schema : schema
Type: array
Show Source
Nested Schema : JobInformation
Type: object
Show Source
Nested Schema : jobTasks
Type: array
Show Source
Nested Schema : TaskInformation
Type: object
Show Source

403 Response

Forbidden (missing permissions for operation, request denied for unspecified reason, and so on).
Body ()
Root Schema : Error
Type: object
Show Source

404 Response

Not Found. The requested resource was not found.
Body ()
Root Schema : Error
Type: object
Show Source

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.
Body ()
Root Schema : Error
Type: object
Show Source
Back to Top

Examples

In this example, you return the detailed history of reload operations for 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' \

This example returns all history for the data set.

Note: You can use the numberOfJobs parameter to restrict the number of jobs returned. All the jobs are returned if the parameter is omitted or set to 0 (numberOfJobs=0).

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-06T21:24:14.0+0000",
        "taskStatus":"IN_PROGRESS",
        "taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
        "taskTargetName":"Data Set Storage",
        "taskAverageReadThroughput":"1220",
        "taskDuration":"PT7.691S"},

        {"taskName":"DSET : MySalesDataSet 2",
        "taskStatus":"ACCEPTED",
        "taskSourceName":"Internal Data Set Storage",
        "taskTargetName":"Data Set Storage",
        "taskDuration":"PT477141H24M21.691S"}]
    },
{"jobName":"'john.smith@mycompany.com'.'MySalesDataSet: Enrich MySales Report'",
    "jobIdentifier":"2345ABCD6789EFGH0123IJKL4567MNOP",
    "jobStartTimestamp":"2024-04-17T15:19:47.0+0000",
    "jobExecutionStartTimestamp":"2024-04-17T15:20:04.0+0000",
    "jobEndTimestamp":"2024-04-17T15:20:28.0+0000",
    "jobStatus":"SUCCEEDED",
    "jobRunType":"DATASET",
    "jobNumberOfSuccessfulRows":"144",
    "jobQueuedDuration":"PT41S",
    "jobRunDuration":"PT24S",
    "jobOriginOfRequest":"Manual",
    "jobNumberOfTasks":"3",
    "jobTasks":[{
        {"taskName":"DSET : MySalesDataSet: Enrich MySales Report",
        "taskStartTimestamp":"2024-04-17T15:20:16.0+0000",
        "taskEndTimestamp":"2024-04-17T15:20:24.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskSourceName":"'john.smith@mycompany.com'.'MySalesDataSet - Set 1'",
        "taskTargetName":"Data Set Storage",
        "taskAverageReadThroughput":"1714",
        "taskDataSizeInBytes":"65536",
        "taskNumberOfSuccessfulRows":"72",
        "taskDuration":"PT8S"},

        {"taskName":"DSET : MySalesDataSet 2",
        "taskStartTimestamp":"2024-04-17T15:20:25.0+0000",
        "taskEndTimestamp":"2024-04-17T15:20:28.0+0000",
        "taskStatus":"SUCCEEDED",
        "taskSourceName":"Internal Data Set Storage",
        "taskTargetName":"Data Set Storage",
        "taskAverageReadThroughput":"6545",
        "taskDataSizeInBytes":"13486",
        "taskNumberOfSuccessfulRows":"72",
        "taskDuration":"PT3S"}
        ]
    },
    ...
]

cURL Example with Parameters:

If you want to return specific reload history, you can apply one or more query parameters to filter the results by job status or start time, exclude task history, and limit the number of jobs returned. For example, you might want to return only jobs that succeeded from a particular date (2024-05-01) and exclude task information.

curl -i \
     --header 'Authorization: Bearer <token>' \
     --header 'Content-Type: application/json' \
     --request GET 'https://<hostname>/api/20210901/catalog/datasets/J2pvaG4uc21pdGhAbXljb21wYW55LmNvbScuJ015U2FsZXNEYXRhc2V0Jw/history?jobStatus=SUCCEEDED&fromStartTime=2024-05-01&includeTasks=false'
Back to Top