API Reference

Create Transaction

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

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.

Path parameters

datasetRid

string

The Resource Identifier (RID) of a Dataset.

Query parameters

branchName

string

optional

The name of the Branch on which to create the Transaction. Defaults to master for most enrollments.

Request body

CreateTransactionRequest

object

Hide child attributes

transactionType

string (enum)

The type of a Transaction.

Enum values: APPEND, UPDATE, SNAPSHOT, DELETE

Response body

Transaction

object

The created Transaction

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 "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" \
	-d '{"transactionType":"APPEND"}'

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

Error responses

Error Name
`BranchNotFound`	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`
`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`
`OpenTransactionAlreadyExists`	Error Code	`CONFLICT`
	Status Code	404
	Description	A transaction is already open on this dataset and branch. A branch of a dataset can only have one open transaction at a time.
	Parameters	`datasetRid, branchName`
`CreateTransactionPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not create the Transaction.
	Parameters	`datasetRid`

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