get_dataload_status¶

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

Status of dataset file loads (failed/completed/processing)

Returns file-load status for the dataset, bucketed by LoadStatus. Response contract: - Body is { “files”: [ { failed, completed, processing } ] }. - files is always a one-element array; the single element holds three arrays: failed, completed, and processing (full lists, no pagination). - Only LoadStatus values failed / completed / processing are queried. Pending file-loads are not included (use list files or pending-file flows for those). - Optional projectionExpression (comma-separated attribute names) limits fields on each file item; omit or empty returns full items. Caller needs any dataset access (owner, editor, or read-only). No access → “User is not authorized to see upload files details”. Unknown dataset → “Dataset doesn’t exist”.

Parameters:

id (str) – Dataset ID to query file-load status for. (required)
role_id (str) – Amorphic role ID the request is authorized against. (required)
projection_expression (str) – Optional comma-separated list of file-load attributes to keep on each item (e.g. FileName,LoadStatus,LastModified). Omit or empty to return full items. Unknown names are simply 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:

FileLoadResponse

Returns:

Returns the result object.

Request and Response Examples¶

HTTP: GET /datasets/{id}/dataloadstatus

Parameter examples¶

Name	In	Example
`projectionExpression`	query	`"FileName,LoadStatus,LastModified"`

Success (HTTP 200)¶

One-element files array whose object has failed, completed, and processing arrays of file-load items. Pending loads are not returned.

Request / response example

{
  "files": [
    {
      "failed": [],
      "completed": [
        {
          "FileName": "sales/monthly_orders/upload_date=1700000000/alice_49e02003-289e-41e9-a9f2-28a733349481_1700000001_orders.csv",
          "DatasetId": "49e02003-289e-41e9-a9f2-28a733349481",
          "LoadStatus": "completed",
          "LastModified": "2024-01-15T10:00:00Z"
        }
      ],
      "processing": []
    }
  ]
}

Errors¶

Documented error codes: GE-1044.

HTTP 400

Authorization or dataset validation failure. Plain Message strings: not authorized to see upload files details, or dataset doesn’t exist.

Caller has no access on the dataset

{
  "Message": "User is not authorized to see upload files details"
}

Dataset id does not exist

{
  "Message": "Dataset doesn't exist"
}

HTTP 500

Backend failure (e.g. GE-1044).