get_datareloads_history_of_dataset¶

DatasetsApi.get_datareloads_history_of_dataset(id, role_id, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)¶

Gets datareloads history of a dataset

Returns all data-reload run records for the dataset as { “datareloads”: [ … ] }, ordered newest first (scan_index_forward=false). Caller needs any dataset access (owner, editor, or read-only). No pagination — the full history list is returned in one response. Optional projectionExpression (comma-separated attribute names) limits fields on each item; omit or empty returns full items. Unknown names are simply omitted from each object.

Parameters:

id (str) – Dataset ID whose reload history is listed. (required)
role_id (str) – Amorphic role ID the request is authorized against. (required)
projection_expression (str) – Optional comma-separated list of DataReloadsItem attribute names to keep on each history item (e.g. LoadStatus,CurrentStage,Message). Omit or empty to return full items. Unknown names are omitted from each object.
_request_timeout (int, tuple(int, int), optional) – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.
_content_type (str, Optional) – force content-type for the request.
_headers (dict, optional) – set to override the headers for a single request; this effectively ignores the headers in the spec for a single request.
_host_index (int, optional) – set to override the host_index for a single request; this effectively ignores the host_index in the spec for a single request.

Return type:

DataReloads

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /datasets/{id}/datareloads

Parameter examples¶

Name	In	Example
`projectionExpression`	query	`"LoadStatus,CurrentStage,Message,StartTime,EndTime"`

Success (HTTP 200)¶

Full reload history. Body is DataReloads with a datareloads array (may be empty).

Request / response example

{
  "datareloads": [
    {
      "DatasetId": "49e02003-289e-41e9-a9f2-28a733349481",
      "LoadStatus": "completed",
      "CurrentStage": "PostProcessing",
      "Message": "Reload completed successfully",
      "FilesLoaded": 3,
      "StartTime": "2024-01-15 10:00:00",
      "EndTime": "2024-01-15 10:05:00"
    }
  ]
}

Errors¶

Documented error codes: AUTH-1002, GE-1034.

HTTP 400

Validation/auth failure. AUTH-1002 when the caller has no dataset access; GE-1034 when datasetId is invalid/missing (“Invalid datasetId - {id}”).

No dataset access

{
  "Message": "AUTH-1002 - User is not authorized to perform this operation"
}

Dataset id does not exist

{
  "Message": "GE-1034 - Invalid datasetId - 49e02003-289e-41e9-a9f2-28a733349481"
}

HTTP 500

Backend/generic failure.