Search documentation
karat

+

K

User Documentation ↗

Get Branch

GET/api/v1/datasets/{datasetRid}/branches/{branchId}

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 the Dataset that contains the Branch.

branchId
string

The identifier (name) of the Branch.

Response body

Branch
object

A Branch of a Dataset.

Hide child attributes

Hide child attributes

branchId
string

The identifier (name) of a Branch.

transactionRid
string
optional

The Resource Identifier (RID) of a Transaction.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/master"

Response

Copied!
1 2 3 4 { "branchId": "master", "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4" }