API Reference

Get Branch

GET/api/v2/datasets/{datasetRid}/branches/{branchName}

Get a Branch of a Dataset.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-read.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

branchName

string

The name of a Branch.

Response body

Branch

object

Hide child attributes

name

string

The name of a Branch.

transactionRid

string

optional

The Resource Identifier (RID) of a Transaction.

Examples

Request

Copied!

curl \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/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`
`BranchNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Branch could not be found.
	Parameters	`datasetRid, branchName`

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