Creates a new Dataset. A default branch - master
for most enrollments - will be created on the Dataset.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write
.
object
string
The Resource Identifier (RID) of a Dataset.
string
string
1curl -X POST \
2 -H "Content-type: application/json" \
3 -H "Authorization: Bearer $TOKEN" \
4 "https://$HOSTNAME/api/v1/datasets" \
5 -d '{"name":"My Dataset","parentFolderRid":"ri.foundry.main.folder.bfe58487-4c56-4c58-aba7-25defd6163c4"}'
1{
2 "rid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
3 "path": "/Empyrean Airlines/My Important Project/My Dataset"
4}
Error Name | ||
---|---|---|
Invalid | Error Code | INVALID_ARGUMENT |
Status Code | 400 | |
Description | The requested branch name cannot be used. Branch names cannot be empty and must not look like RIDs or UUIDs. | |
Parameters | branchId | |
Transaction | Error Code | INVALID_ARGUMENT |
Status Code | 400 | |
Description | The given transaction has not been committed. | |
Parameters | datasetRid, transactionRid, transactionStatus | |
Transaction | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | The requested transaction could not be found on the dataset, or the client token does not have access to it. | |
Parameters | datasetRid, transactionRid | |
Dataset | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | The requested dataset could not be found, or the client token does not have access to it. | |
Parameters | datasetRid | |
Create | Error Code | PERMISSION_DENIED |
Status Code | 403 | |
Description | The provided token does not have permission to create a branch of this dataset. | |
Parameters | datasetRid, branchId | |
Branch | Error Code | CONFLICT |
Status Code | 409 | |
Description | The branch cannot be created because a branch with that name already exists. | |
Parameters | datasetRid, branchId | |
Resource | Error Code | CONFLICT |
Status Code | 409 | |
Description | The provided resource name is already in use by another resource in the same folder. | |
Parameters | parentFolderRid, resourceName | |
Folder | Error Code | NOT_FOUND |
Status Code | 404 | |
Description | The requested folder could not be found, or the client token does not have access to it. | |
Parameters | folderRid | |
Create | Error Code | PERMISSION_DENIED |
Status Code | 403 | |
Description | The provided token does not have permission to create a dataset in this folder. | |
Parameters | parentFolderRid, name |
See Errors for a general overview of errors in the platform.