Get Terminology Job

{
  "id": "string",
  "job_type": "string",
  "status": "string",
  "started_at": "2024-01-15T09:30:00Z",
  "stage": "string",
  "started_by": "string",
  "finished_at": "2024-01-15T09:30:00Z",
  "error": "string",
  "term_count": 1,
  "stats": {},
  "languages": [
    {
      "language": "string",
      "status": "string",
      "term_count": 0,
      "error": "string"
    }
  ],
  "import_term_filters": [
    {
      "name": "string",
      "outcome": "imported",
      "owner": "string",
      "reason": "string",
      "replaced": false
    }
  ],
  "publish_term_filters": [
    {
      "name": "string",
      "outcome": "published",
      "reason": "string",
      "term_counts": {}
    }
  ]
}

A single publish or import job.

Returns 404 if no job with this identifier belongs to the organization.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

job_idstringRequiredformat: "uuid"

Identifier returned when the job started.

Response

Successful Response

idstringformat: "uuid"

job_typestring

Either publish or import.

statusstring

One of queued, running, succeeded, failed, or canceled. The first two mean the job is still holding the lock.

started_atdatetime

stagestring or nullOptional

Coarse progress label while running; null once finished.

started_bystring or nullOptional

Who started the job, for display.

finished_atdatetime or nullOptional

errorstring or nullOptional

Why the job failed; null unless status is failed.

term_countinteger or nullOptional

Terms published, for a successful publish.

statsmap from strings to integers or nullOptional

Per-record-type counts, for a successful import.

languageslist of objectsOptional

How each language fared, for a publish. Empty for an import, and for publishes that ran before per-language reporting existed.

import_term_filterslist of objectsOptional

What an import did with each of the legacy terminology's saved term filters. Empty for a publish, and for imports that ran before this was reported.

publish_term_filterslist of objectsOptional

What a publish did with each filter used for checking. Empty for an import, and for publishes that ran before this was reported.

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error