Version 2.0

Get Media Item Rid By Path

GET/api/v2/mediasets/{mediaSetRid}/items/getRidByPath

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.

Returns the media item RID for the media item with the specified path.

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

Path parameters

mediaSetRid

string

The RID of the media set.

mediaItemPath

string

The path of the media item.

branchName

stringoptional

Specifies the specific branch by name in which to search for this media item. May not be provided if branch rid or view rid are provided.

branchRid

stringoptional

Specifies the specific branch by rid in which to search for this media item. May not be provided if branch name or view rid are provided.

viewRid

stringoptional

Specifies the specific view by rid in which to search for this media item. May not be provided if branch name or branch rid are provided.

preview

booleanoptional

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

GetMediaItemRidByPathResponse

object

mediaItemRid

stringoptional

The Resource Identifier (RID) of an individual Media Item within a Media Set in Foundry.

Copied!

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