Create Branch

POST/api/v2/datasets/{datasetRid}/branches

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.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

Request body

CreateBranchRequest

object

Hide child attributes

transactionRid

string

optional

The most recent OPEN or COMMITTED transaction on the branch. This will never be an ABORTED transaction.

name

string

The name of a Branch.

Response body

Branch

object

The created Branch

Hide child attributes

name

string

The name of a Branch.

transactionRid

string

optional

The most recent OPEN or COMMITTED transaction on the branch. This will never be an ABORTED transaction.

Examples

Request

Copied!

curl -X POST \
	-H "Content-type: application/json" \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches" \
	-d '{"transactionRid":"ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4","name":"master"}'

Response

Copied!

{
  "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4",
  "name": "master"
}

Error responses

Error Name
`BranchNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested branch could not be found, or the client token does not have access to it.
	Parameters	`datasetRid, branchName`
`DatasetNotFound`	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`
`TransactionNotCommitted`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The given transaction has not been committed.
	Parameters	`datasetRid, transactionRid, transactionStatus`
`TransactionNotFound`	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`
`CreateBranchPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to create a branch of this dataset.
	Parameters	`datasetRid, branchName`
`BranchAlreadyExists`	Error Code	`CONFLICT`
	Status Code	409
	Description	The branch cannot be created because a branch with that name already exists.
	Parameters	`datasetRid, branchName`
`InvalidBranchName`	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	`branchName`

See Errors for a general overview of errors in the platform.