request

The request command returns the data associated with an event or notification. For more on requests, events, and notifications, see Requests and Events.

Command Type	SDVoE
Minimum Version	2.x.x

Usage

request <request_id>

Arguments

Argument	Required	Description
request_id	Yes	The identification number included in a PROCESSING command response, an event object, or a notification.

Examples

Fetch the outcome of an asynchronous command
request 85521

Return value

The result depends on the type of the original request:

request 85521
{
  "status": "SUCCESS",
  "request_id": 85521,
  "result": {
    "devices": [
      {
        "device_id": "001ec0f03668"
      }
    ],
    "error": []
  },
  "error": null
}

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	/api/request/{request_id}
Role	Governed by the device lock rather than by a DisplayNet role

GET /api/request/{request_id}

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

See also

• event: list recent events and their request IDs
• Requests and Events: the full request/event/notification model