Commit Transaction

POST/api/v1/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 the Dataset that contains the Transaction.

transactionRid

string

The Resource Identifier (RID) of the Transaction.

Response body

Transaction

object

An operation that modifies the files within a dataset.

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/v1/datasets/ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da/transactions/ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496/commit"

Response

Copied!

{
  "rid": "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496",
  "transactionType": "SNAPSHOT",
  "status": "COMMITTED",
  "createdTime": "2022-10-10T12:20:15.166Z",
  "closedTime": "2022-10-10T12:23:11.152Z"
}

Error responses

Error Name
`DatasetNotFound`	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`
`TransactionNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The requested transaction could not be found on the dataset, or the client token does not have access to it.
	Parameters	`datasetRid, transactionRid`
`CommitTransactionPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	The provided token does not have permission to commit the given transaction on the given dataset.
	Parameters	`datasetRid, transactionRid`
`TransactionNotOpen`	Error Code	`INVALID_ARGUMENT`
	Status Code	400
	Description	The given transaction is not open.
	Parameters	`datasetRid, transactionRid, transactionStatus`

See Errors for a general overview of errors in the platform.