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.

/ClientCredential

GET

/ClientCredential

Retrieves the existing list of client credentials available for this user

The list of associated secrets is not included in the response from this endpoint, and will always be null.

Parameters

No parameters.

Responses

A list of available client credentials

POST

/ClientCredential

Creates a new client credential

The ClientId field of the credential will be auto-generated by this API and should not be supplied in the input. The generated ClientId will be included in the output.

Secrets should not be supplied in the input.

Parameters

No parameters.

Request Body

The details of the client credential to create

Example Value

Schema

{
	"clientId": "string",
	"description": "string",
	"secrets": []
}

Responses

The details of the created client credential

Example Value

Schema

{
	"clientId": "string",
	"description": "string",
	"secrets": []
}

Example Value

Schema

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

GET

/ClientCredential/{id}

Gets the details of a client credential

Parameters

The unique identifier of the client credential to get the details of

Responses

The details of the requested client credential

Example Value

Schema

{
	"clientId": "string",
	"description": "string",
	"secrets": []
}

Example Value

Schema

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

PUT

/ClientCredential/{id}

Updates the details of a client credential

Parameters

The unique identifier of the client credential to update the details of

Request Body

The information to change on the client credential

Example Value

Schema

{
	"clientId": "string",
	"description": "string",
	"secrets": []
}

Responses

Example Value

Schema

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

DELETE

/ClientCredential/{id}

Deletes a client credential

Parameters

The unique identifier of the client credential to delete

Responses

Example Value

Schema

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

GET

/ClientCredential/{id}/secrets

Gets the list of client secrets associated with a client credential

Parameters

The unique identifier of the client credential to get the list of client secrets for

Responses

A list of client secrets associated with a client credential

Example Value

Schema

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

POST

/ClientCredential/{id}/secrets

Creates a new client secret for a client credential

The secret value will be auto-generated by this API and included in the return value. It will not be available again, so please note it as soon as it is returned.

Parameters

The unique identifier of the client credential to create a new client secret for

Request Body

The details of the client secret to create

Example Value

Schema

{
	"clientSecretId": 0,
	"expires": "1970-01-01T00:00:00.0000000Z",
	"description": "string"
}

Responses

The details of the client secret that has been created

Example Value

Schema

{
	"clientSecretId": 0,
	"expires": "1970-01-01T00:00:00.0000000Z",
	"description": "string",
	"clientSecretId": 0,
	"generatedSecret": "string"
}

Example Value

Schema

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

GET

/ClientCredential/{id}/secrets/{secretId}

Gets the details of a client secret

Parameters

The unique identifier of the client credential to get the client secret for

The unique identifier of the client secret to get the details for

Responses

The details of the requested client secret

Example Value

Schema

{
	"clientSecretId": 0,
	"expires": "1970-01-01T00:00:00.0000000Z",
	"description": "string"
}

Example Value

Schema

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

PUT

/ClientCredential/{id}/secrets/{secretId}

Updates the details of a client secret

Parameters

The unique identifier of the client credential to update the client secret for

The unique identifier of the client secret to update the details for

Request Body

The details of the client secret to update

Example Value

Schema

{
	"clientSecretId": 0,
	"expires": "1970-01-01T00:00:00.0000000Z",
	"description": "string"
}

Responses

Example Value

Schema

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

DELETE

/ClientCredential/{id}/secrets/{secretId}

Deletes a client secret

Parameters

The unique identifier of the client credential to delete the client secret from

The unique identifier of the client secret to delete

Responses

Example Value

Schema

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