OFoffice-of-national-statistics
Import API

Update the jobs state

Update the state of the job. If this is set to submitted, this shall trigger the import process.

put/jobs/{id}

Request

  • Base URL
    /v1 (relative, and the document’s source URL is not known)
  • Auth
    API key in header florence-token

Path parameters

idstring required

A unique job identifier

Request body

idstring

A unique id for an import job

recipestring

The recipe to use when baking data. Below is a list of predefined recipes;

  • v4 - This will skip the data baking process.
statestring

The state of the job, this can be;

  • created - The job has been created;
  • submitted - The job has been queue to be imported
  • completed - The job has been imported
  • error - The job was not imported (See the events in the instances)
last_updatedstring string

The time this job was last updated.

Example request

{
  "last_updated": "2016-07-17T08:38:25.316+0000"
}

Response

The job is in a queue

Changes

No recorded changes to this operation across all 1 revision of this API.