Skip to navigation
v2Datasets

Create a dataset

Create a dataset. Note that a data frame must already exist to create a dataset. The data frame id is required in this request in order to create a dataset.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
customFieldsmap from strings to objectsOptional
Custom field values to set on the file
dataFrameIdstringOptional
ID of the data frame that
folderIdstringOptional
ID of the folder that contains the file
namestringOptional
Display name for the file
study_idslist of strings or nullOptional
The study IDs that the dataset is associated with. If provided, the dataset will be associated with the provided studies. If not provided, the dataset will not be associated with any studies.

Response

Created
archiveRecordobject or nullOptional
ArchiveRecord Resource if the dataset is archived. This is null if the dataset is not archived.
createdAtdatetimeOptionalRead-only
Date and time the dataset was created
creatorobjectOptional
UserSummary of the user who created the dataset
customFieldsmap from strings to objectsOptional
Custom field values of the dataset
dataFrameIdstringOptional
ID of the data frame to link to this dataset
displayIdstringOptionalRead-only

User-friendly ID of the dataset

folderIdstringOptional
ID of the folder that contains the dataset
idstringOptional
modifiedAtdatetimeOptionalRead-only
Date and time the dataset was last modified
namestringOptional

The user-facing name for this Dataset.

Errors

400
Bad Request Error