v1

latestOpenAPI 3.0.0Open Government Licence v3.02026-07-2371816.7 KB
private

Get a migration job

Gets a specific migration job using the unique job number

get/migration-jobs/{job_number}

Path parameters

job_numberinteger required

Unique human-readable identifier for a migration job

Response

Successful response

job_numberinteger
last_updatedstring date-time
labelstring

The title of the source dataset, automatically populated during job creation

state'submitted' | 'in_review' | 'approved' | 'published' | 'completed' | 'rejected' | 'cancelled' | 'migrating' | 'publishing' | 'pending_post_publish' | 'post_publishing' | 'reverting' | 'failed_post_publish' | 'failed_publish' | 'failed_migration' | 'failed_reversion'
type'static_dataset'

Example response

{
  "job_number": 20,
  "last_updated": "2020-06-11T12:49:20+01:00",
  "label": "Consumer Price Index: All Items",
  "links": {
    "events": {
      "href": "https://api.beta.ons.gov.uk/v1/migration-jobs/20/events"
    },
    "self": {
      "href": "https://api.beta.ons.gov.uk/v1/migration-jobs/20",
      "job_number": 20
    },
    "tasks": {
      "href": "https://api.beta.ons.gov.uk/v1/migration-jobs/20/tasks"
    }
  },
  "config": {
    "collection_id": "migration-collection-20",
    "source_id": "/economy/inflationandpriceindices",
    "target_id": "migration-series-id"
  }
}