Version 2.0

Get Media Set

GET/api/v2/mediasets/{mediaSetRid}

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.

Gets information about the media set.

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

Path parameters

mediaSetRid

string

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

preview

boolean

optional

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

GetMediaSetResponse

object

Information about a media set.

rid

string

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

mediaSchema

string (enum)

The schema type of a media set, indicating what type of media items it can contain.

Enum values: AUDIO, DICOM, DOCUMENT, IMAGERY, MODEL_3D, MULTIMODAL, SPREADSHEET, VIDEO, EMAIL

defaultBranchName

string

A name for a media set branch. Valid branch names must be (a) non-empty, (b) less than 256 characters, and (c) not a valid ResourceIdentifier.

transactionPolicy

union

The transaction policy for a media set, determining how writes are handled.

pathsRequired

boolean

Whether media items in this media set require paths.

Copied!

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