Magidoc

DeviceEndpoint
Object

A device endpoint is an on-premise route that can be called by devices such as press controllers. This is normally configured through an integration.

Fields

#

id

ID !
Non-null

The ID of the device endpoint.

name

String !
Non-null

The name of the device endpoint.

deviceId

ID !
Non-null

The ID of the device this endpoint is associated with.

device

Device !
Non-null

The device that the endpoint is associated with.

installedIntegrationId

ID

The ID of the installed integration this endpoint is associated with, if present.

installedIntegration

InstalledIntegration

The installed integration that the endpoint is associated with, if present.

methods

[ HTTPMethod !]!
Non-null

The method of the device endpoint.

module

String !
Non-null

The module to execute when the endpoint is called.

path

String

The path of the endpoint. This is nested under the base route and supports variables such as :id, or :state.

url

String

The URL of the device endpoint. If this device is not bound to a controller, this will be null.

enabled

Boolean !
Non-null

Whether the device endpoint is enabled and serving requests.

createdAt

DateTimeISO !
Non-null

The date and time when the device endpoint was created.

updatedAt

DateTimeISO !
Non-null

The date and time when the device endpoint was last updated.