Sign in
library

Library Search

Search the Library for this user

get/library

Query parameters

mediaIdinteger

Filter by Media Id

mediastring

Filter by Media Name

typestring

Filter by Media Type

ownerIdinteger

Filter by Owner Id

retiredinteger

Filter by Retired

tagsstring

Filter by Tags - comma seperated

exactTagsinteger

A flag indicating whether to treat the tags filter as an exact match

logicalOperatorstring

When filtering by multiple Tags, which logical operator should be used? AND|OR

durationstring

Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number

fileSizestring

Filter by File Size - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number

ownerUserGroupIdinteger

Filter by users in this UserGroupId

folderIdinteger

Filter by Folder ID

isReturnPublicUrlsinteger

Should the thumbnail URLs be authenticated S3 style public URL, default = false

modifiedDateFromstring date

Start date for filtering media by modified date

modifiedDateTostring date

End date for filtering media by modified date

sortBy'mediaId' | 'name' | 'type' | 'duration' | 'fileSize' | 'owner' | 'sharing' | 'released' | 'fileName' | 'enableStat' | 'createdAt' | 'modifiedDt' | 'expires' | 'revised' | 'formattedDuration' | 'durationSeconds' | 'fileSizeFormatted' | 'mediaType' | 'resolution' | 'groupsWithPermissions'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

mediaIdinteger

The Media ID

ownerIdinteger

The ID of the User that owns this Media

parentIdinteger

The Parent ID of this Media if it has been revised

namestring

The Name of this Media

mediaTypestring

The module type of this Media

storedAsstring

The file name of the media as stored in the library

fileNamestring

The original file name as it was uploaded

fileSizeinteger

The file size in bytes

durationinteger

The duration to use when assigning this media to a Layout widget

validinteger

Flag indicating whether this media is valid.

moduleSystemFileinteger

DEPRECATED: Flag indicating whether this media is a system file or not

expiresinteger

Timestamp indicating when this media should expire

retiredinteger

Flag indicating whether this media is retired

isEditedinteger

Flag indicating whether this media has been edited and replaced with a newer file

md5string

A MD5 checksum of the stored media file

ownerstring

The username of the User that owns this media

groupsWithPermissionsstring

A comma separated list of groups/users with permissions to this Media

releasedinteger

A flag indicating whether this media has been released

apiRefstring

An API reference

createdDtstring

The datetime the Media was created

modifiedDtstring

The datetime the Media was last modified

enableStatstring

The option to enable the collection of Media Proof of Play statistics

orientationstring

The orientation of the Media file

widthinteger

The width of the Media file

heightinteger

The height of the Media file

folderIdinteger

The id of the Folder this Media belongs to

permissionsFolderIdinteger

The id of the Folder responsible for providing permissions for this Media

Changes

Changed in 6 of the 52 revisions of this API.1710

  • fe497e811c7f13See the full diff
    • ●

      deleted the query request parameter keyword

      request-parameter-removed

    • ○

      added the new optional query request parameter modifiedDateFrom

      new-optional-request-parameter

    • ○

      added the new optional query request parameter modifiedDateTo

      new-optional-request-parameter

    • ○

      added the new enum value groupsWithPermissions to the query request parameter sortBy

      request-parameter-enum-value-added

  • 41c04de98ec54See the full diff
    • ○

      added the new optional query request parameter keyword

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortBy

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortDir

      new-optional-request-parameter

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 44e0d30692621See the full diff
    • ○

      added the new optional query request parameter isReturnPublicUrls

      new-optional-request-parameter

  • 6d18f62f77821See the full diff
    • ○

      added the new optional query request parameter logicalOperator

      new-optional-request-parameter

  • 9ddbdc81e86a1See the full diff
    • ○

      added the new optional query request parameter folderId

      new-optional-request-parameter

  • 8e127539510416See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    • ●

      deleted the query request parameter folderId

      request-parameter-removed

    • ●

      deleted the query request parameter isReturnPublicUrls

      request-parameter-removed

    • ●

      deleted the query request parameter keyword

      request-parameter-removed

    • ●

      deleted the query request parameter logicalOperator

      request-parameter-removed

    • ●

      deleted the query request parameter sortBy

      request-parameter-removed

    • ●

      deleted the query request parameter sortDir

      request-parameter-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog