get_models_run_status_of_dataset_file

DatasetsApi.get_models_run_status_of_dataset_file(id, role_id, filename=None, model_run_id=None, projection_expression=None, _request_timeout=None, _request_auth=None, _content_type=None, _headers=None, _host_index=0)

List model run statuses for a dataset

Returns ML model run status records for the dataset. Caller must have access to the dataset (else AUTH-1002). Filtering: - filename only: returns { modelruns: […] } for that file (from model-runs and file-runs tables); optional projectionExpression limits fields. - ModelRunId only: returns { modelrun: { ModelRunId, BatchTransformationJobs, DatasetProcessingMode, RunStatus, … } } with aggregate RunStatus SUCCESS|FAILED|INPROGRESS. - neither: returns { modelruns: […] } for all runs on the dataset. Safe to retry (read-only).

Parameters:

• id (str) – Dataset ID. Must exist and be active with completed registration (else DS-1019 / DS-1002 / DS-1003). (required)

• role_id (str) – Amorphic role ID the request is authorized against. Must grant access to the dataset. (required)

• filename (str) – When set, list run records for this file only. Mutually preferred over ModelRunId when both are present (filename branch wins).

• model_run_id (str) – When set (and filename omitted), return aggregate status for this model run including BatchTransformationJobs[].

• projection_expression (str) – Optional comma-separated attribute names to keep on each modelruns item (filename or neither-filter branches only). Ignored for the ModelRunId aggregate response.

• _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:

MLModelsRunStatuses

Returns:

Returns the result object.

Request and Response Examples

HTTP: GET /datasets/{id}/files/models/runstatus

Parameter examples

Name	In	Example
filename	query	"sales/monthly_orders/upload_date=2026-08-01/file_orders.csv"
ModelRunId	query	"c9d8e7f6-a5b4-3210-9876-543210fedcba"
id	path	"b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f"
projectionExpression	query	"ModelRunId,RunStatus,FileName,ModelId"

Success (HTTP 200)

Run status payload. Shape is MLModelsRunStatuses: either modelruns[] (list) or modelrun (single aggregate when ModelRunId is used).

Runs for a file

{
  "modelruns": [
    {
      "ModelRunId": "c9d8e7f6-a5b4-3210-9876-543210fedcba",
      "ModelId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "FileName": "sales/monthly_orders/upload_date=2026-08-01/file_orders.csv",
      "RunStatus": "SUCCESS",
      "DatasetId": "b1e6c2a0-9f4d-4c7a-8f2e-1a2b3c4d5e6f",
      "TargetDatasetId": "d0e1f2a3-b4c5-6789-0123-456789abcdef",
      "LastModifiedBy": "alice@example.com",
      "LastModifiedTime": "2026-08-01T12:00:00Z"
    }
  ]
}

Aggregate status for a ModelRunId

{
  "modelrun": {
    "ModelRunId": "c9d8e7f6-a5b4-3210-9876-543210fedcba",
    "DatasetProcessingMode": "CustomFileSelection",
    "RunStatus": "INPROGRESS",
    "BatchTransformationJobs": [
      {
        "BatchTransformJobId": "btj-abc123",
        "BatchRunStatus": "INPROGRESS",
        "ErrorMessage": "N/A"
      }
    ]
  }
}

Errors

Documented error codes: DS-1019, DS-1002, AUTH-1002, DS-1003, GE-1008.

HTTP 400

Validation or authorization failure. Body is {“Message”: “<CODE> - <text>”}. Codes: DS-1019 / DS-1002, AUTH-1002 (no dataset access).

Request / response example

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

HTTP 500

Backend/generic failure. Body is {“Message”: “<CODE> - <text>”} (e.g. DS-1003, GE-1008).