Search documentation
karat

+

K

User Documentation ↗

List Branches

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

Lists the Branches 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 on which to list Branches.

Query parameters

pageSize
integer
optional

The desired size of the page to be returned. Defaults to 1,000. See page sizes for details.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Response body

ListBranchesResponse
object
Hide child attributes

Hide child attributes

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

data
list<Branch>
optional

The list of branches in the current page.

Show child attributes

Show child attributes

Branch
object

A Branch of a Dataset.

Show child attributes

Show 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"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 { "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z", "data": [ { "branchId": "master", "transactionRid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4" }, { "branchId": "test-v2", "transactionRid": "ri.foundry.main.transaction.fc9feb4b-34e4-4bfd-9e4f-b6425fbea85f" }, { "branchId": "my-branch" } ] }