Creates a branch on an existing dataset. A branch may optionally point to a (committed) transaction.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write.
stringThe Resource Identifier (RID) of the Dataset on which to create the Branch.
objectstringThe identifier (name) of a Branch.
stringThe Resource Identifier (RID) of a Transaction.
objectA Branch of a Dataset.
stringThe identifier (name) of a Branch.
stringThe Resource Identifier (RID) of a Transaction.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches" \
-d '{"branchId":"my-branch"}'1
2
3
{
"branchId": "my-branch"
}| 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 | |
See Errors for a general overview of errors in the platform.