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.
Creates a Transaction on a Branch of a Dataset.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:datasets-write
.
string
The name of the Branch on which to create the Transaction. Defaults to master
for most enrollments.
boolean
Enables the use of preview functionality.
object
string
(enum)The type of a Transaction.
Enum values: APPEND
, UPDATE
, SNAPSHOT
, DELETE
object
The created Transaction
string
The Resource Identifier (RID) of a Transaction.
string
(enum)The type of a Transaction.
Enum values: APPEND
, UPDATE
, SNAPSHOT
, DELETE
string
(enum)The status of a Transaction.
Enum values: ABORTED
, COMMITTED
, OPEN
string
The timestamp when the transaction was created, in ISO 8601 timestamp format.
string
The timestamp when the transaction was closed, in ISO 8601 timestamp format.
1
2
3
4
5
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/transactions?branchName=master&preview=true" \
-d '{"transactionType":"APPEND"}'
1
2
3
4
5
{
"transactionType": "APPEND",
"rid": "ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4",
"status": "COMMITTED"
}