Import API

Create an import job

To import a dataset a job must be created first. To do this a data baker recipe is needed and the number of instances which the recipe creates. Once a job is created files can be added to the job and the state of the job can be changed.

post/jobs

Request

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

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

An import job was successfully created