Sign in

v1

latestOpenAPI 3.1.02026-07-2483219318.4 KB
Datafiles

Get datafile details

get/v1/applications/{applicationId}/datafiles/{dataFileId}

Path parameters

applicationIdstring required
Example:application_tz4a98xxat96iws9zmbrgj3a
dataFileIdstring required
Example:dat_tz4a98xxat96iws9zmbrgj3a

Response

Success

_idstring required
_applicationstring required

The application that this datafile belongs to.

namestring required

The filename of this datafile.

content_type'application/json' required

The content type of the datafile.

schemastring required

The name of the schema for this datafile.

status'pending' | 'processing' | 'completed' | 'failed' required

The status of a datafile:

  • pending The datafile record exists, but the file has not yet been fully uploaded.

  • processing Akahu Apply is extracting and enriching the data from this datafile.

  • completed This datafile has been successfully processed.

  • failed This datafile has not been successfully processed. See the failure_reason for more detail.

created_atstring date-time required

The date that this datafile was created.

updated_atstring date-time required

The date that this datafile was last updated at.

expires_atstring date-time

Expiry for the datafile, after which the record will be deleted. Expiry varies as the datafile progresses through its lifecycle:

  • While the datafile has a status of pending, expiry is short lived, ensuring that the record is cleaned up quickly if a file is never uploaded.

  • After the datafile upload has been received, a 1 year expiry is set, after which the datafile and all associated data will be permanently deleted.

Example response

{
  "_id": "dat_tz4a98xxat96iws9zmbrgj3a",
  "_application": "application_tz4a98xxat96iws9zmbrgj3a"
}