display

Edit a Display

put/display/{displayId}

Request

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

Path parameters

displayIdinteger required

The Display ID

Request body application/x-www-form-urlencoded

displaystring required

The Display Name

descriptionstring

A description of the Display

tagsstring

A comma separated list of tags for this item

auditingUntilstring date-time

A date this Display records auditing information until.

defaultLayoutIdinteger required

A Layout ID representing the Default Layout for this Display.

licensedinteger required

Flag indicating whether this display is licensed.

licensestring required

The hardwareKey to use as the licence key for this Display

incScheduleinteger required

Flag indicating whether the Default Layout should be included in the Schedule

emailAlertinteger required

Flag indicating whether the Display generates up/down email alerts.

alertTimeoutinteger

How long in seconds should this display wait before alerting when it hasn't connected. Override for the collection interval.

wakeOnLanEnabledinteger required

Flag indicating if Wake On LAN is enabled for this Display

wakeOnLanTimestring

A h:i string representing the time that the Display should receive its Wake on LAN command

broadCastAddressstring

The BroadCast Address for this Display - used by Wake On LAN

secureOnstring

The secure on configuration for this Display

cidrinteger

The CIDR configuration for this Display

latitudenumber

The Latitude of this Display

longitudenumber

The Longitude of this Display

timeZonestring

The timezone for this display, or empty to use the CMS timezone

languagesstring

An array of languages supported in this display location

displayProfileIdinteger

The Display Settings Profile ID

displayTypeIdinteger

The Display Type ID of this Display

screenSizenumber

The screen size of this Display

venueIdinteger

The Venue ID of this Display

addressstring

The Location Address of this Display

isMobileinteger

Is this Display mobile?

isOutdoorinteger

Is this Display Outdoor?

costPerPlaynumber

The Cost Per Play of this Display

impressionsPerPlayinteger

The Impressions Per Play of this Display

customIdstring

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

ref1string

Reference 1

ref2string

Reference 2

ref3string

Reference 3

ref4string

Reference 4

ref5string

Reference 5

clearCachedDatainteger

Clear all Cached data for this display

rekeyXmrinteger

Clear the cached XMR configuration and send a rekey

teamViewerSerialstring

The TeamViewer serial number for this Display, if applicable

webkeySerialstring

The Webkey serial number for this Display, if applicable

folderIdinteger

Folder ID to which this object should be assigned to

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

overrideConfigunknown
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

groupsWithPermissionsListstring[]

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

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • breaking

      added required request body

    • info

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