Get Pipeline Document Status

GET 
/api/v1/pipelines/:pipeline_id/documents/:document_id/status

Return a single document for a pipeline.

Request

Path Parameters

document_id Document Idrequired
pipeline_id uuidrequired

Cookie Parameters

session any

Responses

200

Successful Response

application/json

Schema

Schema

job_id

object

ID of the latest job.

anyOf

MOD1

string

deployment_date

object

Date of the deployment.

anyOf

MOD1

string

status ManagedIngestionStatus (string)required

Status of the ingestion.

Possible values: [NOT_STARTED, IN_PROGRESS, SUCCESS, ERROR, PARTIAL_SUCCESS]

error

object

List of errors that occurred during ingestion.

anyOf

MOD1

Array [

job_id uuidrequired

ID of the job that failed.

message Message (string)required

List of errors that occurred during ingestion.

step JobNameMapping (string)required

Name of the job that failed.

Possible values: [MANAGED_INGESTION, DATA_SOURCE, FILES_UPDATE, FILE_UPDATER, PARSE, TRANSFORM, INGESTION]

]

Example (from schema)

{
  "job_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "deployment_date": "2024-07-29T15:51:28.071Z",
  "status": "NOT_STARTED",
  "error": [
    null
  ]
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}