Sign in

v51

latestOpenAPI 3.0.0AGPLv3 or laterraw.githubusercontent.com2026-08-0126276829.1 KB
display

Display Search

Search Displays for this User

get/display

Query parameters

displayIdinteger

Filter by Display Id

displayGroupIdinteger

Filter by DisplayGroup Id

displaystring

Filter by Display Name

tagsstring

Filter by tags

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

macAddressstring

Filter by Mac Address

hardwareKeystring

Filter by Hardware Key

clientVersionstring

Filter by Client Version

clientTypestring

Filter by Client Type

clientCodestring

Filter by Client Code

embedstring

Embed related data, namely displaygroups. A comma separated list of child objects to embed.

authorisedinteger

Filter by authorised flag

displayProfileIdinteger

Filter by Display Profile

mediaInventoryStatusinteger

Filter by Display Status ( 1 - up to date, 2 - downloading, 3 - Out of date)

loggedIninteger

Filter by Logged In flag

lastAccessedstring

Filter by Display Last Accessed date, expects date in Y-m-d H:i:s format

folderIdinteger

Filter by Folder ID

xmrRegisteredinteger

Filter by whether XMR is registed (1 or 0)

isPlayerSupportedinteger

Filter by whether the player is supported (1 or 0)

sortBy'displayId' | 'display' | 'clientType' | 'clientCode' | 'clientVersion' | 'mediaInventoryStatus' | 'clientAddress' | 'licensed' | 'loggedIn' | 'deviceName' | 'address' | 'storageAvailableSpace' | 'storageTotalSpace' | 'description' | 'orientation' | 'resolution' | 'defaultLayout' | 'incSchedule' | 'emailAlert' | 'lastAccessed' | 'macAddress' | 'timeZone' | 'languages' | 'latitude' | 'longitude' | 'screenShotRequested' | 'bandwidthLimit' | 'lastCommandSuccess' | 'commercialLicence' | 'groupsWithPermissions' | 'screenSize' | 'isMobile' | 'isOutdoor' | 'ref1' | 'ref2' | 'ref3' | 'ref4' | 'ref5' | 'customId' | 'costPerPlay' | 'impressionsPerPlay' | 'createdDt' | 'modifiedDt' | 'countFaults' | 'osVersion' | 'osSdk' | 'manufacturer' | 'brand' | 'model' | 'cmsTransfer' | 'xmrRegistered'

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

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

displayIdinteger

The ID of this Display

displayTypeIdinteger

The Display Type ID of this Display

venueIdinteger

The Venue ID of this Display

addressstring

The Location Address of this Display

isMobileinteger

Is this Display mobile?

languagesstring

The Languages supported in this display location

displayTypestring

The type of this Display

screenSizeinteger

The screen size of this Display

isOutdoorinteger

Is this Display Outdoor?

customIdstring

The custom ID (an Id of any external system) of this Display

costPerPlaynumber double

The Cost Per Play of this Display

impressionsPerPlaynumber double

The Impressions Per Play of this Display

ref1string

Optional Reference 1

ref2string

Optional Reference 2

ref3string

Optional Reference 3

ref4string

Optional Reference 4

ref5string

Optional Reference 5

auditingUntilinteger

Flag indicating whether this Display is recording Auditing Information from XMDS

displaystring

The Name of this Display

descriptionstring

The Description of this Display

defaultLayoutIdinteger

The ID of the Default Layout

licensestring

The Display Unique Identifier also called hardware key

licensedinteger

A flag indicating whether this Display is licensed or not

loggedIninteger

A flag indicating whether this Display is currently logged in

lastAccessedinteger

A timestamp in CMS time for the last time the Display accessed XMDS

incScheduleinteger

A flag indicating whether the default layout is interleaved with the Schedule

emailAlertinteger

A flag indicating whether the Display will send email alerts.

alertTimeoutinteger

A timeout in seconds for the Display to send email alerts.

clientAddressstring

The MAC Address of the Display

mediaInventoryStatusinteger

The media inventory status of the Display

macAddressstring

The current Mac Address of the Player

lastChangedinteger

A timestamp indicating the last time the Mac Address changed

numberOfMacAddressChangesinteger

A count of Mac Address changes

lastWakeOnLanCommandSentinteger

A timestamp indicating the last time a WOL command was sent

wakeOnLanEnabledinteger

A flag indicating whether Wake On Lan is enabled

wakeOnLanTimestring

A h:i string indicating the time to send a WOL command

broadCastAddressstring

The broad cast address for this Display

secureOnstring

The secureOn WOL settings for this display.

cidrstring

The CIDR WOL settings for this display

latitudenumber double

The display Latitude

longitudenumber double

The display longitude

clientTypestring

A string representing the player type

clientVersionstring

A string representing the player version

clientCodeinteger

A number representing the Player version code

displayProfileIdinteger

The display settings profile ID for this Display

currentLayoutIdinteger

The current layout ID reported via XMDS

screenShotRequestedinteger

A flag indicating that a screen shot should be taken by the Player

storageAvailableSpaceinteger

The number of bytes of storage available on the device.

storageTotalSpaceinteger

The number of bytes of storage in total on the device

displayGroupIdinteger

The ID of the Display Group for this Device

currentLayoutstring

The current layout

defaultLayoutstring

The default layout

xmrChannelstring

The Player Subscription Channel

xmrPubKeystring

The Player Public Key

lastCommandSuccessinteger

The last command success, 0 = failure, 1 = success, 2 = unknown

deviceNamestring

The Device Name for the device hardware associated with this Display

timeZonestring

The Display Timezone, or empty to use the CMS timezone

{"stackTrail":"components:schemas:Display:properties:overrideConfig","oasType":"schema","type":"unknown","description":"The configuration options that will overwrite Display Profile Config"}
bandwidthLimitinteger

The display bandwidth limit

newCmsAddressstring

The new CMS Address

newCmsKeystring

The new CMS Key

orientationstring

The orientation of the Display, either landscape or portrait

resolutionstring

The resolution of the Display expressed as a string in the format WxH

commercialLicenceinteger

Status of the commercial licence for this Display. 0 - Not licensed, 1 - licensed, 2 - trial licence, 3 - not applicable

teamViewerSerialstring

The TeamViewer serial number for this Display

webkeySerialstring

The Webkey serial number for this Display

groupsWithPermissionsstring

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

createdDtstring

The datetime this entity was created

modifiedDtstring

The datetime this entity was last modified

folderIdinteger

The id of the Folder this Display belongs to

permissionsFolderIdinteger

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

countFaultsinteger

The count of Player reported faults

lanIpAddressstring

LAN IP Address, if available on the Player

syncGroupIdinteger

The Display Group ID this Display is synced to

osVersionstring

The OS version of the Display

osSdkstring

The SDK version of the Display

manufacturerstring

The manufacturer of the Display

brandstring

The brand of the Display

modelstring

The model of the Display