Data Export Schema

This object allows you to export specific data sets from Kantata OX. You can view the full schema of available data sets using this endpoint.

To use this endpoint, you need to be an account administrator.

Get Data Set Schema

Returns a list of the available data sets to export—as well as the respective available columns within each data set, which could include custom fields. The response will include unique key values for each individual data set and for each column. You will need to properly pass these keys in when you generate your data export.

Responses

200

A list of objects have been retrieved.

Response Schema: application/json

object

The key, display_name, and columns for a data set.

additional property

object

The key value for a data set.

key	string The `key` value for a data set.
display_name	string The name of a data set as it appears in the Data Exporter.
	Array of objects The `key` value and `display_name` for a column in a data set.

400

Bad Request

401

Unauthorized request

403

Forbidden request

404

Page Not Found

422

Unprocessable Entity

503

Service is unavailable

get/exports/available_datasets

Request samples

Response samples

application/json

{"datasets": {"property1": {"key": "string",
"display_name": "string",
"columns": [{"key": "string",
"display_name": "string",
"description": "string",
"type": "string"
}
]
},
"property2": {"key": "string",
"display_name": "string",
"columns": [{"key": "string",
"display_name": "string",
"description": "string",
"type": "string"
}
]
}
}
}

➔ Next to Data Exports