Library
Library
Set Enable Stats Collection? to use for the collection of Proof of Play statistics for a media.
The Media ID
The option to enable the collection of Media Proof of Play statistics
successful operation
No content
PUT /api/library/setenablestat/{mediaId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 21
"enableStat='text'"successful operation
No content
Search the Library for this user
Filter by Media Id
Filter by Media Name
Filter by Media Type
Filter by Owner Id
Filter by Retired
Filter by Tags - comma seperated
A flag indicating whether to treat the tags filter as an exact match
When filtering by multiple Tags, which logical operator should be used? AND|OR
Filter by Duration - a number or less-than,greater-than,less-than-equal or great-than-equal followed by a | followed by a number
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
Filter by users in this UserGroupId
Filter by Folder ID
Should the thumbnail URLs be authenticated S3 style public URL, default = false
Start date for filtering media by modified date
End date for filtering media by modified date
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/library HTTP/1.1
Accept: */*
successful operation
[
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}
]Add Media to the Library, optionally replacing an existing media item, optionally adding to a playlist.
The Uploaded File
Optional Media Name
Id of an existing media file which should be replaced with the new upload
Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)
Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)
Comma separated string of Tags that should be assigned to uploaded Media
Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media
A playlistId to add this uploaded media to
Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.
Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.
Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached
Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media
Folder ID to which this object should be assigned to
successful operation
No content
POST /api/library HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 227
{
"files": "binary",
"name": "text",
"oldMediaId": 1,
"updateInLayouts": 1,
"deleteOldRevisions": 1,
"tags": "text",
"expires": "text",
"playlistId": 1,
"widgetFromDt": "text",
"widgetToDt": "text",
"deleteOnExpiry": 1,
"applyToMedia": 1,
"folderId": 1
}successful operation
No content
Get the Media object specified by the provided mediaId
Numeric ID of the Media to get
successful operation
Class Media
The Media ID
The ID of the User that owns this Media
The Parent ID of this Media if it has been revised
The Name of this Media
The module type of this Media
The file name of the media as stored in the library
The original file name as it was uploaded
The file size in bytes
The duration to use when assigning this media to a Layout widget
Flag indicating whether this media is valid.
DEPRECATED: Flag indicating whether this media is a system file or not
Timestamp indicating when this media should expire
Flag indicating whether this media is retired
Flag indicating whether this media has been edited and replaced with a newer file
A MD5 checksum of the stored media file
The username of the User that owns this media
A comma separated list of groups/users with permissions to this Media
A flag indicating whether this media has been released
An API reference
The datetime the Media was created
The datetime the Media was last modified
The option to enable the collection of Media Proof of Play statistics
The orientation of the Media file
The width of the Media file
The height of the Media file
The id of the Folder this Media belongs to
The id of the Folder responsible for providing permissions for this Media
GET /api/library/{mediaId} HTTP/1.1
Accept: */*
successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Edit a Media Item in the Library
The Media ID to Edit
Media Item Name
The duration in seconds for this Media Item
Flag indicating if this media is retired
Comma separated list of Tags
Flag indicating whether to update the duration in all Layouts the Media is assigned to
Date in Y-m-d H:i:s format, will set expiration date on the Media item
Folder ID to which this media should be assigned to
successful operation
Class Media
The Media ID
The ID of the User that owns this Media
The Parent ID of this Media if it has been revised
The Name of this Media
The module type of this Media
The file name of the media as stored in the library
The original file name as it was uploaded
The file size in bytes
The duration to use when assigning this media to a Layout widget
Flag indicating whether this media is valid.
DEPRECATED: Flag indicating whether this media is a system file or not
Timestamp indicating when this media should expire
Flag indicating whether this media is retired
Flag indicating whether this media has been edited and replaced with a newer file
A MD5 checksum of the stored media file
The username of the User that owns this media
A comma separated list of groups/users with permissions to this Media
A flag indicating whether this media has been released
An API reference
The datetime the Media was created
The datetime the Media was last modified
The option to enable the collection of Media Proof of Play statistics
The orientation of the Media file
The width of the Media file
The height of the Media file
The id of the Folder this Media belongs to
The id of the Folder responsible for providing permissions for this Media
PUT /api/library/{mediaId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 104
"name='text'&duration=1&retired=1&tags='text'&updateInLayouts=1&expires='text'&folderId=1"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Delete Media from the Library
The Media ID to Delete
If the media item has been used should it be force removed from items that uses it?
Should this Media be added to the Purge List for all Displays?
successful operation
No content
DELETE /api/library/{mediaId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 27
"forceDelete=1&purge=1"successful operation
No content
Search all library files from local and connectors
successful operation
GET /api/library/search HTTP/1.1
Accept: */*
successful operation
[
{
"title": null,
"description": null,
"thumbnail": null,
"source": null,
"type": null,
"id": null,
"download": null,
"fileSize": null,
"width": null,
"height": null,
"orientation": null,
"duration": null,
"videoThumbnailUrl": null,
"tags": [
"text"
],
"isFeatured": null
}
]Routine tidy of the library, removing unused files.
Also delete generic files?
successful operation
No content
DELETE /api/library/tidy HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 22
"tidyGenericFiles=1"successful operation
No content
Download a Media file from the Library
The Media ID to Download
The Module Type of the Download
Serve video/audio media with its real content type for inline streaming playback, rather than as an attachment download
successful operation
GET /api/library/download/{mediaId}/{type} HTTP/1.1
Accept: */*
successful operation
binaryDownload thumbnail for a Media file from the Library
The Media ID to Download
successful operation
GET /api/library/thumbnail/{mediaId} HTTP/1.1
Accept: */*
successful operation
binaryTag a Media with one or more tags
The Media Id to Tag
An array of tags
successful operation
Class Media
The Media ID
The ID of the User that owns this Media
The Parent ID of this Media if it has been revised
The Name of this Media
The module type of this Media
The file name of the media as stored in the library
The original file name as it was uploaded
The file size in bytes
The duration to use when assigning this media to a Layout widget
Flag indicating whether this media is valid.
DEPRECATED: Flag indicating whether this media is a system file or not
Timestamp indicating when this media should expire
Flag indicating whether this media is retired
Flag indicating whether this media has been edited and replaced with a newer file
A MD5 checksum of the stored media file
The username of the User that owns this media
A comma separated list of groups/users with permissions to this Media
A flag indicating whether this media has been released
An API reference
The datetime the Media was created
The datetime the Media was last modified
The option to enable the collection of Media Proof of Play statistics
The orientation of the Media file
The width of the Media file
The height of the Media file
The id of the Folder this Media belongs to
The id of the Folder responsible for providing permissions for this Media
POST /api/library/{mediaId}/tag HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"tag=['text']"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Untag a Media with one or more tags
The Media Id to Untag
An array of tags
successful operation
Class Media
The Media ID
The ID of the User that owns this Media
The Parent ID of this Media if it has been revised
The Name of this Media
The module type of this Media
The file name of the media as stored in the library
The original file name as it was uploaded
The file size in bytes
The duration to use when assigning this media to a Layout widget
Flag indicating whether this media is valid.
DEPRECATED: Flag indicating whether this media is a system file or not
Timestamp indicating when this media should expire
Flag indicating whether this media is retired
Flag indicating whether this media has been edited and replaced with a newer file
A MD5 checksum of the stored media file
The username of the User that owns this media
A comma separated list of groups/users with permissions to this Media
A flag indicating whether this media has been released
An API reference
The datetime the Media was created
The datetime the Media was last modified
The option to enable the collection of Media Proof of Play statistics
The orientation of the Media file
The width of the Media file
The height of the Media file
The id of the Folder this Media belongs to
The id of the Folder responsible for providing permissions for this Media
POST /api/library/{mediaId}/untag HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 16
"tag=['text']"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Get the records for the library item usage report for Layouts
The Media Id
successful operation
No content
GET /api/library/usage/layouts/{mediaId} HTTP/1.1
Accept: */*
successful operation
No content
Copy a Media, providing a new name and tags if applicable
The media ID to Copy
The name for the new Media
The Optional tags for new Media
successful operation
POST /api/library/copy/{mediaId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 29
"name='text'&tags='text'"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Upload Media to CMS library from an external URL
The URL to the media
The type of the media, image, video etc
Optional extension of the media, jpg, png etc. If not set in the request it will be retrieved from the headers
The option to enable the collection of Media Proof of Play statistics, On, Off or Inherit.
An optional name for this media file, if left empty it will default to the file name
Date in Y-m-d H:i:s format, will set expiration date on the Media item
Folder ID to which this media should be assigned to
successful operation
POST /api/library/uploadUrl HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 119
"url='text'&type='text'&extension='text'&enableStat='text'&optionalName='text'&expires='text'&folderId=1"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Select Folder for Media
The Media ID
Folder ID to which this object should be assigned to
successful operation
Class Media
The Media ID
The ID of the User that owns this Media
The Parent ID of this Media if it has been revised
The Name of this Media
The module type of this Media
The file name of the media as stored in the library
The original file name as it was uploaded
The file size in bytes
The duration to use when assigning this media to a Layout widget
Flag indicating whether this media is valid.
DEPRECATED: Flag indicating whether this media is a system file or not
Timestamp indicating when this media should expire
Flag indicating whether this media is retired
Flag indicating whether this media has been edited and replaced with a newer file
A MD5 checksum of the stored media file
The username of the User that owns this media
A comma separated list of groups/users with permissions to this Media
A flag indicating whether this media has been released
An API reference
The datetime the Media was created
The datetime the Media was last modified
The option to enable the collection of Media Proof of Play statistics
The orientation of the Media file
The width of the Media file
The height of the Media file
The id of the Folder this Media belongs to
The id of the Folder responsible for providing permissions for this Media
PUT /api/library/{id}/selectfolder HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14
"folderId=1"successful operation
{
"mediaId": 1,
"ownerId": 1,
"parentId": 1,
"name": "text",
"mediaType": "text",
"storedAs": "text",
"fileName": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"fileSize": 1,
"duration": 1,
"valid": 1,
"moduleSystemFile": 1,
"expires": 1,
"retired": 1,
"isEdited": 1,
"md5": "text",
"owner": "text",
"groupsWithPermissions": "text",
"released": 1,
"apiRef": "text",
"createdDt": "text",
"modifiedDt": "text",
"enableStat": "text",
"orientation": "text",
"width": 1,
"height": 1,
"folderId": 1,
"permissionsFolderId": 1
}Last updated
Was this helpful?

