5.10.2 api log subscribe

The /api/log/subscribe function helps you create a subscription channel and returns a unique identifier to be used for subsequent dialling of the /api/log/pull or /api/log/unsubscribe function. 

Each subscription channel contains an event queue of its own. All the new events that match the channel filter (filter parameter) are added to the channel queue and read using the /api/log/pull function.

At the same time, the device keeps the event history queue (last 10000 events) in its internal memory. The event history queue is empty by default.

Use the include parameter to specify whether the channel queue shall be empty after restart (storing of events occurring after the channel is opened), or be filled with all or some events from the event history records.

Use the duration parameter to define the channel duration if it is not accessed via /api/log/pull. The channel will be closed automatically when the  defined timeout passes as if the /api/log/unsubscribe function were used.

The function is part of the Logging service and requires some user privileges for authentication. Unprivileged user events shall not be included in the channel queue.

Table of events:

The GET or POST method can be used for this function.

Request parameters:

The reply is in the application/json format  and includes an identifier created by subscription.

Example:

GET /api/log/subscribe?filter=KeyPressed,InputChanged
{
  "success" : true,
  "result" : {
    "id" : 2121013117
  }
}