Display
Displays
Search Displays for this User
Filter by Display Id
Filter by DisplayGroup Id
Filter by Display Name
Filter by tags
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 Mac Address
Filter by Hardware Key
Filter by Client Version
Filter by Client Type
Filter by Client Code
Embed related data, namely displaygroups. A comma separated list of child objects to embed.
Filter by authorised flag
Filter by Display Profile
Filter by Display Status ( 1 - up to date, 2 - downloading, 3 - Out of date)
Filter by Logged In flag
Filter by Display Last Accessed date, expects date in Y-m-d H:i:s format
Filter by Folder ID
Filter by whether XMR is registed (1 or 0)
Filter by whether the player is supported (1 or 0)
Specifies which field the results are sorted by. Used together with sortDir
Sort direction
successful operation
GET /api/display HTTP/1.1
Accept: */*
successful operation
[
{
"displayId": 1,
"displayTypeId": 1,
"venueId": 1,
"address": "text",
"isMobile": 1,
"languages": "text",
"displayType": "text",
"screenSize": 1,
"isOutdoor": 1,
"customId": "text",
"costPerPlay": 1,
"impressionsPerPlay": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"auditingUntil": 1,
"display": "text",
"description": "text",
"defaultLayoutId": 1,
"license": "text",
"licensed": 1,
"loggedIn": 1,
"lastAccessed": 1,
"incSchedule": 1,
"emailAlert": 1,
"alertTimeout": 1,
"clientAddress": "text",
"mediaInventoryStatus": 1,
"macAddress": "text",
"lastChanged": 1,
"numberOfMacAddressChanges": 1,
"lastWakeOnLanCommandSent": 1,
"wakeOnLanEnabled": 1,
"wakeOnLanTime": "text",
"broadCastAddress": "text",
"secureOn": "text",
"cidr": "text",
"latitude": 1,
"longitude": 1,
"clientType": "text",
"clientVersion": "text",
"clientCode": 1,
"displayProfileId": 1,
"currentLayoutId": 1,
"screenShotRequested": 1,
"storageAvailableSpace": 1,
"storageTotalSpace": 1,
"displayGroupId": 1,
"currentLayout": "text",
"defaultLayout": "text",
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"xmrChannel": "text",
"xmrPubKey": "text",
"lastCommandSuccess": 1,
"deviceName": "text",
"timeZone": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"overrideConfig": null,
"bandwidthLimit": 1,
"newCmsAddress": "text",
"newCmsKey": "text",
"orientation": "text",
"resolution": "text",
"commercialLicence": 1,
"teamViewerSerial": "text",
"webkeySerial": "text",
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"countFaults": 1,
"lanIpAddress": "text",
"syncGroupId": 1,
"osVersion": "text",
"osSdk": "text",
"manufacturer": "text",
"brand": "text",
"model": "text"
}
]Get the Display object specified by the provided displayId
Numeric ID of the Display to get
successful operation
Class Display
The ID of this Display
The Display Type ID of this Display
The Venue ID of this Display
The Location Address of this Display
Is this Display mobile?
The Languages supported in this display location
The type of this Display
The screen size of this Display
Is this Display Outdoor?
The custom ID (an Id of any external system) of this Display
The Cost Per Play of this Display
The Impressions Per Play of this Display
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
Flag indicating whether this Display is recording Auditing Information from XMDS
The Name of this Display
The Description of this Display
The ID of the Default Layout
The Display Unique Identifier also called hardware key
A flag indicating whether this Display is licensed or not
A flag indicating whether this Display is currently logged in
A timestamp in CMS time for the last time the Display accessed XMDS
A flag indicating whether the default layout is interleaved with the Schedule
A flag indicating whether the Display will send email alerts.
A timeout in seconds for the Display to send email alerts.
The MAC Address of the Display
The media inventory status of the Display
The current Mac Address of the Player
A timestamp indicating the last time the Mac Address changed
A count of Mac Address changes
A timestamp indicating the last time a WOL command was sent
A flag indicating whether Wake On Lan is enabled
A h:i string indicating the time to send a WOL command
The broad cast address for this Display
The secureOn WOL settings for this display.
The CIDR WOL settings for this display
The display Latitude
The display longitude
A string representing the player type
A string representing the player version
A number representing the Player version code
The display settings profile ID for this Display
The current layout ID reported via XMDS
A flag indicating that a screen shot should be taken by the Player
The number of bytes of storage available on the device.
The number of bytes of storage in total on the device
The ID of the Display Group for this Device
The current layout
The default layout
The Player Subscription Channel
The Player Public Key
The last command success, 0 = failure, 1 = success, 2 = unknown
The Device Name for the device hardware associated with this Display
The Display Timezone, or empty to use the CMS timezone
The configuration options that will overwrite Display Profile Config
The display bandwidth limit
The new CMS Address
The new CMS Key
The orientation of the Display, either landscape or portrait
The resolution of the Display expressed as a string in the format WxH
Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable
The TeamViewer serial number for this Display
The Webkey serial number for this Display
A comma separated list of groups/users with permissions to this Display
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display belongs to
The id of the Folder responsible for providing permissions for this Display
The count of Player reported faults
LAN IP Address, if available on the Player
The Display Group ID this Display is synced to
The OS version of the Display
The SDK version of the Display
The manufacturer of the Display
The brand of the Display
The model of the Display
GET /api/display/{displayId} HTTP/1.1
Accept: */*
successful operation
{
"displayId": 1,
"displayTypeId": 1,
"venueId": 1,
"address": "text",
"isMobile": 1,
"languages": "text",
"displayType": "text",
"screenSize": 1,
"isOutdoor": 1,
"customId": "text",
"costPerPlay": 1,
"impressionsPerPlay": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"auditingUntil": 1,
"display": "text",
"description": "text",
"defaultLayoutId": 1,
"license": "text",
"licensed": 1,
"loggedIn": 1,
"lastAccessed": 1,
"incSchedule": 1,
"emailAlert": 1,
"alertTimeout": 1,
"clientAddress": "text",
"mediaInventoryStatus": 1,
"macAddress": "text",
"lastChanged": 1,
"numberOfMacAddressChanges": 1,
"lastWakeOnLanCommandSent": 1,
"wakeOnLanEnabled": 1,
"wakeOnLanTime": "text",
"broadCastAddress": "text",
"secureOn": "text",
"cidr": "text",
"latitude": 1,
"longitude": 1,
"clientType": "text",
"clientVersion": "text",
"clientCode": 1,
"displayProfileId": 1,
"currentLayoutId": 1,
"screenShotRequested": 1,
"storageAvailableSpace": 1,
"storageTotalSpace": 1,
"displayGroupId": 1,
"currentLayout": "text",
"defaultLayout": "text",
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"xmrChannel": "text",
"xmrPubKey": "text",
"lastCommandSuccess": 1,
"deviceName": "text",
"timeZone": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"overrideConfig": null,
"bandwidthLimit": 1,
"newCmsAddress": "text",
"newCmsKey": "text",
"orientation": "text",
"resolution": "text",
"commercialLicence": 1,
"teamViewerSerial": "text",
"webkeySerial": "text",
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"countFaults": 1,
"lanIpAddress": "text",
"syncGroupId": 1,
"osVersion": "text",
"osSdk": "text",
"manufacturer": "text",
"brand": "text",
"model": "text"
}Edit a Display
The Display ID
The Display Name
A description of the Display
A comma separated list of tags for this item
A date this Display records auditing information until.
A Layout ID representing the Default Layout for this Display.
Flag indicating whether this display is licensed.
The hardwareKey to use as the licence key for this Display
Flag indicating whether the Default Layout should be included in the Schedule
Flag indicating whether the Display generates up/down email alerts.
How long in seconds should this display wait before alerting when it hasn't connected. Override for the collection interval.
Flag indicating if Wake On LAN is enabled for this Display
A h:i string representing the time that the Display should receive its Wake on LAN command
The BroadCast Address for this Display - used by Wake On LAN
The secure on configuration for this Display
The CIDR configuration for this Display
The Latitude of this Display
The Longitude of this Display
The timezone for this display, or empty to use the CMS timezone
An array of languages supported in this display location
The Display Settings Profile ID
The Display Type ID of this Display
The screen size of this Display
The Venue ID of this Display
The Location Address of this Display
Is this Display mobile?
Is this Display Outdoor?
The Cost Per Play of this Display
The Impressions Per Play of this Display
The custom ID (an Id of any external system) of this Display
Reference 1
Reference 2
Reference 3
Reference 4
Reference 5
Clear all Cached data for this display
Clear the cached XMR configuration and send a rekey
The TeamViewer serial number for this Display, if applicable
The Webkey serial number for this Display, if applicable
Folder ID to which this object should be assigned to
successful operation
Class Display
The ID of this Display
The Display Type ID of this Display
The Venue ID of this Display
The Location Address of this Display
Is this Display mobile?
The Languages supported in this display location
The type of this Display
The screen size of this Display
Is this Display Outdoor?
The custom ID (an Id of any external system) of this Display
The Cost Per Play of this Display
The Impressions Per Play of this Display
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
Flag indicating whether this Display is recording Auditing Information from XMDS
The Name of this Display
The Description of this Display
The ID of the Default Layout
The Display Unique Identifier also called hardware key
A flag indicating whether this Display is licensed or not
A flag indicating whether this Display is currently logged in
A timestamp in CMS time for the last time the Display accessed XMDS
A flag indicating whether the default layout is interleaved with the Schedule
A flag indicating whether the Display will send email alerts.
A timeout in seconds for the Display to send email alerts.
The MAC Address of the Display
The media inventory status of the Display
The current Mac Address of the Player
A timestamp indicating the last time the Mac Address changed
A count of Mac Address changes
A timestamp indicating the last time a WOL command was sent
A flag indicating whether Wake On Lan is enabled
A h:i string indicating the time to send a WOL command
The broad cast address for this Display
The secureOn WOL settings for this display.
The CIDR WOL settings for this display
The display Latitude
The display longitude
A string representing the player type
A string representing the player version
A number representing the Player version code
The display settings profile ID for this Display
The current layout ID reported via XMDS
A flag indicating that a screen shot should be taken by the Player
The number of bytes of storage available on the device.
The number of bytes of storage in total on the device
The ID of the Display Group for this Device
The current layout
The default layout
The Player Subscription Channel
The Player Public Key
The last command success, 0 = failure, 1 = success, 2 = unknown
The Device Name for the device hardware associated with this Display
The Display Timezone, or empty to use the CMS timezone
The configuration options that will overwrite Display Profile Config
The display bandwidth limit
The new CMS Address
The new CMS Key
The orientation of the Display, either landscape or portrait
The resolution of the Display expressed as a string in the format WxH
Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable
The TeamViewer serial number for this Display
The Webkey serial number for this Display
A comma separated list of groups/users with permissions to this Display
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display belongs to
The id of the Folder responsible for providing permissions for this Display
The count of Player reported faults
LAN IP Address, if available on the Player
The Display Group ID this Display is synced to
The OS version of the Display
The SDK version of the Display
The manufacturer of the Display
The brand of the Display
The model of the Display
PUT /api/display/{displayId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 686
"display='text'&description='text'&tags='text'&auditingUntil='2026-01-01T00:00:00.000Z'&defaultLayoutId=1&licensed=1&license='text'&incSchedule=1&emailAlert=1&alertTimeout=1&wakeOnLanEnabled=1&wakeOnLanTime='text'&broadCastAddress='text'&secureOn='text'&cidr=1&latitude=1&longitude=1&timeZone='text'&languages='text'&displayProfileId=1&displayTypeId=1&screenSize=1&venueId=1&address='text'&isMobile=1&isOutdoor=1&costPerPlay=1&impressionsPerPlay=1&customId='text'&ref1='text'&ref2='text'&ref3='text'&ref4='text'&ref5='text'&clearCachedData=1&rekeyXmr=1&teamViewerSerial='text'&webkeySerial='text'&folderId=1"successful operation
{
"displayId": 1,
"displayTypeId": 1,
"venueId": 1,
"address": "text",
"isMobile": 1,
"languages": "text",
"displayType": "text",
"screenSize": 1,
"isOutdoor": 1,
"customId": "text",
"costPerPlay": 1,
"impressionsPerPlay": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"auditingUntil": 1,
"display": "text",
"description": "text",
"defaultLayoutId": 1,
"license": "text",
"licensed": 1,
"loggedIn": 1,
"lastAccessed": 1,
"incSchedule": 1,
"emailAlert": 1,
"alertTimeout": 1,
"clientAddress": "text",
"mediaInventoryStatus": 1,
"macAddress": "text",
"lastChanged": 1,
"numberOfMacAddressChanges": 1,
"lastWakeOnLanCommandSent": 1,
"wakeOnLanEnabled": 1,
"wakeOnLanTime": "text",
"broadCastAddress": "text",
"secureOn": "text",
"cidr": "text",
"latitude": 1,
"longitude": 1,
"clientType": "text",
"clientVersion": "text",
"clientCode": 1,
"displayProfileId": 1,
"currentLayoutId": 1,
"screenShotRequested": 1,
"storageAvailableSpace": 1,
"storageTotalSpace": 1,
"displayGroupId": 1,
"currentLayout": "text",
"defaultLayout": "text",
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"xmrChannel": "text",
"xmrPubKey": "text",
"lastCommandSuccess": 1,
"deviceName": "text",
"timeZone": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"overrideConfig": null,
"bandwidthLimit": 1,
"newCmsAddress": "text",
"newCmsKey": "text",
"orientation": "text",
"resolution": "text",
"commercialLicence": 1,
"teamViewerSerial": "text",
"webkeySerial": "text",
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"countFaults": 1,
"lanIpAddress": "text",
"syncGroupId": 1,
"osVersion": "text",
"osSdk": "text",
"manufacturer": "text",
"brand": "text",
"model": "text"
}Notify the display that the CMS would like a screen shot to be sent.
The Display ID
successful operation
Class Display
The ID of this Display
The Display Type ID of this Display
The Venue ID of this Display
The Location Address of this Display
Is this Display mobile?
The Languages supported in this display location
The type of this Display
The screen size of this Display
Is this Display Outdoor?
The custom ID (an Id of any external system) of this Display
The Cost Per Play of this Display
The Impressions Per Play of this Display
Optional Reference 1
Optional Reference 2
Optional Reference 3
Optional Reference 4
Optional Reference 5
Flag indicating whether this Display is recording Auditing Information from XMDS
The Name of this Display
The Description of this Display
The ID of the Default Layout
The Display Unique Identifier also called hardware key
A flag indicating whether this Display is licensed or not
A flag indicating whether this Display is currently logged in
A timestamp in CMS time for the last time the Display accessed XMDS
A flag indicating whether the default layout is interleaved with the Schedule
A flag indicating whether the Display will send email alerts.
A timeout in seconds for the Display to send email alerts.
The MAC Address of the Display
The media inventory status of the Display
The current Mac Address of the Player
A timestamp indicating the last time the Mac Address changed
A count of Mac Address changes
A timestamp indicating the last time a WOL command was sent
A flag indicating whether Wake On Lan is enabled
A h:i string indicating the time to send a WOL command
The broad cast address for this Display
The secureOn WOL settings for this display.
The CIDR WOL settings for this display
The display Latitude
The display longitude
A string representing the player type
A string representing the player version
A number representing the Player version code
The display settings profile ID for this Display
The current layout ID reported via XMDS
A flag indicating that a screen shot should be taken by the Player
The number of bytes of storage available on the device.
The number of bytes of storage in total on the device
The ID of the Display Group for this Device
The current layout
The default layout
The Player Subscription Channel
The Player Public Key
The last command success, 0 = failure, 1 = success, 2 = unknown
The Device Name for the device hardware associated with this Display
The Display Timezone, or empty to use the CMS timezone
The configuration options that will overwrite Display Profile Config
The display bandwidth limit
The new CMS Address
The new CMS Key
The orientation of the Display, either landscape or portrait
The resolution of the Display expressed as a string in the format WxH
Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable
The TeamViewer serial number for this Display
The Webkey serial number for this Display
A comma separated list of groups/users with permissions to this Display
The datetime this entity was created
The datetime this entity was last modified
The id of the Folder this Display belongs to
The id of the Folder responsible for providing permissions for this Display
The count of Player reported faults
LAN IP Address, if available on the Player
The Display Group ID this Display is synced to
The OS version of the Display
The SDK version of the Display
The manufacturer of the Display
The brand of the Display
The model of the Display
PUT /api/display/requestscreenshot/{displayId} HTTP/1.1
Accept: */*
successful operation
{
"displayId": 1,
"displayTypeId": 1,
"venueId": 1,
"address": "text",
"isMobile": 1,
"languages": "text",
"displayType": "text",
"screenSize": 1,
"isOutdoor": 1,
"customId": "text",
"costPerPlay": 1,
"impressionsPerPlay": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text",
"auditingUntil": 1,
"display": "text",
"description": "text",
"defaultLayoutId": 1,
"license": "text",
"licensed": 1,
"loggedIn": 1,
"lastAccessed": 1,
"incSchedule": 1,
"emailAlert": 1,
"alertTimeout": 1,
"clientAddress": "text",
"mediaInventoryStatus": 1,
"macAddress": "text",
"lastChanged": 1,
"numberOfMacAddressChanges": 1,
"lastWakeOnLanCommandSent": 1,
"wakeOnLanEnabled": 1,
"wakeOnLanTime": "text",
"broadCastAddress": "text",
"secureOn": "text",
"cidr": "text",
"latitude": 1,
"longitude": 1,
"clientType": "text",
"clientVersion": "text",
"clientCode": 1,
"displayProfileId": 1,
"currentLayoutId": 1,
"screenShotRequested": 1,
"storageAvailableSpace": 1,
"storageTotalSpace": 1,
"displayGroupId": 1,
"currentLayout": "text",
"defaultLayout": "text",
"displayGroups": [
{
"displayGroupId": 1,
"displayGroup": "text",
"description": "text",
"isDisplaySpecific": 1,
"isDynamic": 1,
"dynamicCriteria": "text",
"dynamicCriteriaLogicalOperator": "text",
"dynamicCriteriaTags": "text",
"dynamicCriteriaExactTags": 1,
"dynamicCriteriaTagsLogicalOperator": "text",
"userId": 1,
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"bandwidthLimit": 1,
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"ref1": "text",
"ref2": "text",
"ref3": "text",
"ref4": "text",
"ref5": "text"
}
],
"xmrChannel": "text",
"xmrPubKey": "text",
"lastCommandSuccess": 1,
"deviceName": "text",
"timeZone": "text",
"tags": [
{
"tag": "text",
"tagId": 1,
"value": "text"
}
],
"overrideConfig": null,
"bandwidthLimit": 1,
"newCmsAddress": "text",
"newCmsKey": "text",
"orientation": "text",
"resolution": "text",
"commercialLicence": 1,
"teamViewerSerial": "text",
"webkeySerial": "text",
"groupsWithPermissions": "text",
"createdDt": "text",
"modifiedDt": "text",
"folderId": 1,
"permissionsFolderId": 1,
"countFaults": 1,
"lanIpAddress": "text",
"syncGroupId": 1,
"osVersion": "text",
"osSdk": "text",
"manufacturer": "text",
"brand": "text",
"model": "text"
}Set the default Layout on this Display
The Display ID
The Layout ID
successful operation
No content
PUT /api/display/defaultlayout/{displayId} HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 14
"layoutId=1"successful operation
No content
Ask this Player to purge all Media from its local storage and request fresh files from CMS.
The Display ID
successful operation
No content
PUT /api/display/purgeAll/{displayId} HTTP/1.1
Accept: */*
successful operation
No content
Last updated
Was this helpful?