Data8 Logo

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

Starts a new job

HTTP Method: POST

Operation Id: Job_CreateJob

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": {}
}
An error has occurred. This application may no longer respond until reloaded. Reload 🗙