Search documentation
karat

+

K

User Documentation ↗

Abort Transaction

POST/api/v1/datasets/{datasetRid}/transactions/{transactionRid}/abort

Aborts an open Transaction. File modifications made on this Transaction are not preserved and the Branch is not updated.

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 children

Hide children

rid
string

The Resource Identifier (RID) of a Transaction. Example: ri.foundry.main.transaction.0a0207cb-26b7-415b-bc80-66a3aa3933f4.

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!
1 2 3 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/abort"

Response

Copied!
1 2 3 4 5 6 7 { "rid": "ri.foundry.main.transaction.abffc380-ea68-4843-9be1-9f44d2565496", "transactionType": "SNAPSHOT", "status": "ABORTED", "createdTime": "2022-10-10T12:20:15.166Z", "closedTime": "2022-10-10T12:23:11.152Z" }