library

Edit Media

Changed on

Edit a Media Item in the Library

put/library/{mediaId}

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/library/{mediaId}
  • Auth
    none declared

Path parameters

mediaIdinteger required

The Media ID to Edit

Request body application/x-www-form-urlencoded

namestring required

Media Item Name

durationinteger required

The duration in seconds for this Media Item

retiredinteger required

Flag indicating if this media is retired

tagsstring

Comma separated list of Tags

updateInLayoutsinteger

Flag indicating whether to update the duration in all Layouts the Media is assigned to

expiresstring

Date in Y-m-d H:i:s format, will set expiration date on the Media item

folderIdinteger

Folder ID to which this media should be assigned to

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

groupsWithPermissionsListstring[]

An array 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

  • 622fb073aecdRevision changes
    • info

      added the optional property to the response with the status

  • 41c04de98ec5Revision changes
    • breaking

      added required request body

    • info

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