private
Get list of migration jobs
Lists all migration jobs in a paginated format.
get/migration-jobs
Request
- Base URL/v1 (relative, and the document’s source URL is not known)
- AuthAPI key in header Authorization
Query parameters
limitinteger
The number of items requested, defaulted to 10 and limited to 1000.
offsetinteger
The offset into the complete ordered set of items which satisfy the query, which specifies the first item to return (starting at 0). Use this parameter as a pagination mechanism along with the limit parameter."
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'
A filter for item state, specifies a subset of items to be returned"
sort'job_number:asc' | 'job_number:desc' | 'label:asc' | 'label:desc'
Sort jobs by job_number or label in ascending (asc) or descending (desc) order. Format: $field:$direction
Response
Successful response
Example response
{
"items": [
{
"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"
}
}
],
"states": [
{
"id": "in_review",
"label": "In review",
"count": 1
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.