API Reference

Commit Transaction

POST/api/v2/datasets/{datasetRid}/transactions/{transactionRid}/commit

Commits an open Transaction. File modifications made on this Transaction are preserved and the Branch is updated to point to the Transaction.

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

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

transactionRid

string

The Resource Identifier (RID) of a Transaction.

Response body

Transaction

object

Hide child attributes

rid

string

The Resource Identifier (RID) of a Transaction.

transactionType

string (enum)

The type of a Transaction.

Enum values: APPEND, UPDATE, SNAPSHOT, DELETE

status

string (enum)

The status of a Transaction.

Enum values: ABORTED, COMMITTED, OPEN

createdTime

string

The timestamp when the transaction was created, in ISO 8601 timestamp format.

closedTime

string

optional

The timestamp when the transaction was closed, in ISO 8601 timestamp format.

Examples

Request

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4/commit"

Response

Copied!

{
  "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"
}