This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Get the Transaction history for the given Dataset.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-read.
stringThe Resource Identifier (RID) of a Dataset.
stringThe name of a Branch.
integerThe default pageSize is 20 transactions and the maximum allowed pageSize is 50 transactions
stringThe 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.
booleanEnables the use of preview functionality.
objectlist<Transaction>stringThe 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.
1
2
3
curl \
\t-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/branches/master/transactions?preview=true"1
2
3
4
5
6
7
8
9
10
11
12
{
"data": [
{
"transactionType": "APPEND",
"createdTime": "2020-09-30T14:30:00Z",
"rid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4",
"closedTime": "2020-09-30T21:00:00Z",
"status": "COMMITTED"
}
],
"nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"
}| Error Name | ||
|---|---|---|
Branch | 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 | |
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 | |
Get | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not transactions the Branch. | |
| Parameters | datasetRid, branchName | |
See Errors for a general overview of errors in the platform.