API Reference

Create Media Transaction

POST/api/v2/mediasets/{mediaSetRid}/transactions

Warning

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 new transaction. Items uploaded to the media set while this transaction is open will not be reflected until the transaction is committed.

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

Path parameters

mediaSetRid

string

The Resource Identifier (RID) of a Media Set in Foundry.

branchName

string

optional

The branch on which to open the transaction. Defaults to master for most enrollments.

preview

boolean

optional

A boolean flag that, when set to true, enables the use of beta features in preview mode.

TransactionId

string

An identifier which represents a transaction on a media set.

Copied!

curl -X POST \
	-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/mediasets/{mediaSetRid}/transactions?preview=true"

Copied!

{
  "transactionId": "550e8400-e29b-41d4-a716-446655440000"
}