Data8 Administration & Batch Data Cleansing API

Manage your Data8 account, submit data to batch data cleansing jobs and retrieve the results

Jobs are submitted to workflows that are built for you by the Data8 Production Team to your specifications, and the details of the data to be provided to each workflow and generated by it will be documented by them.

If you do not already have a workflow available to submit jobs to, please get in touch with your account manager to discuss your requirements.

All requests must be authenticated using an Authorization: Bearer header, with the bearer token being obtained from the Data8 OAuth token server at https://auth.data-8.co.uk/connect/token.

/Job

GET

/Job

Retrieves a list of jobs that have already been submitted

Use this endpoint to retrieve a list of jobs that have previously been submitted.

The jobs are split into pages of 100, with the most recent jobs first. Use the page parameter to move through later pages, or the workflow, startDate and endDate parameters to refine the list.

Only the basic details of each job are included in the list. Use the GET /Job/{name} endpoint to get the full details of a particular job.

Parameters

The number of the page to retrieve. The first page is 1

The name of the workflow to filter the jobs by

The earliest date of the job to filter by

The latest date of the job to filter by

Responses

The list of jobs has been retrieved successfully

Some validation error occurred

Example Value

Schema

{
	"errors": {},
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string",
	"errors": {}
}

POST

/Job

Starts a new job

The details to be passed to this endpoint will vary depending on how your workflow has been configured. Full details of what each workflow is expecting in terms of input files, datasets and parameters will be agreed with you by the Data8 Production Team.

Once the job has been submitted it can be monitored by polling the GET /Job/{name} endpoint.

Each job must have a unique name. The job name cannot contain characters which are invalid in file names such as /, :, *, ?, ", <, >, |.

Parameters

No parameters.

Request Body

The details of the job to create

Example Value

Schema

{
	"name": "Contact Deceased Check 3124",
	"workflowName": "ContactDeceasedCheck",
	"inputFilename": "/ToData8/contact.csv",
	"inputDatasets": {
	  "Contacts": "my_contact_dataset_1",
	  "Accounts": "my_account_dataset_312"
	},
	"parameters": {
	  "MaxContactAge": "5"
	}
}

Responses

The job has been started succesfully

A validation error has occurred

Example Value

Schema

{
	"errors": {},
	"type": "string",
	"title": "string",
	"status": 0,
	"detail": "string",
	"instance": "string",
	"errors": {}
}

GET

/Job/{name}

Retrieves the full details of a job

Use this endpoint to get the full details of a job. In particular you can poll this to track the progress of a job and wait until it has completed before attempting to retrieve the results.

Parameters

The name of the job to retrieve

Responses

The details of the job has been retrieved successfully

Example Value

Schema

{
	"name": "string",
	"workflowName": "string",
	"submittedAt": "1970-01-01T00:00:00.0000000Z",
	"completedAt": "1970-01-01T00:00:00.0000000Z",
	"status": 0,
	"percentComplete": 0,
	"estimatedFinishTime": "1970-01-01T00:00:00.0000000Z",
	"statistics": {},
	"inputDatasets": {},
	"outputDatasets": {},
	"parameters": {},
	"inputFilename": "string",
	"outputFilenames": {}
}

The requested job name does not exist