Search documentation
karat

+

K

User Documentation ↗

Get Media Item Info

GET/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}
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 item.

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.

mediaItemRid
string

The RID of the media item.

Query parameters

preview
boolean
optional

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

Response body

GetMediaItemInfoResponse
object
Hide child attributes

Hide child attributes

viewRid
string

The Resource Identifier (RID) of a single View of a Media Set. A Media Set View is an independent collection of Media Items.

path
string
optional

A user-specified identifier for a media item within a media set. Paths must be less than 256 characters long. If multiple items are written to the same media set at the same path, then when retrieving by path the media item which was written last is returned.

logicalTimestamp
string

A number representing a logical ordering to be used for transactions, etc. This can be interpreted as a timestamp in microseconds, but may differ slightly from system clock time due to clock drift and slight adjustments for the sake of ordering.

Only positive timestamps (representing times after epoch) are supported.

attribution
object
optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/mediasets/{mediaSetRid}/items/{mediaItemRid}?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 { "viewRid": "ri.mio.main.view.1", "logicalTimestamp": 12345, "path": "example.png", "attribution": { "creatorId": 1, "creationTimestamp": "2020-07-10 15:00:00.000" } }