...
Configuration Article | CA-20220907-TP-29 VDG Sense | API | Functions | Events  |
|
| Table of Contents |
|---|
Note: This function requires an API license.
...
This command will return immediately with a multipart/x-mixed-replace content type and specific boundary. When an event occures, it will be send as xml message as denoted below, together with the boundary indicating the end of the multipart. If another request is send from the client, the ending boundary will be send.
Request
|
parameter | type | remarks |
|---|---|---|
types | [string] | (optional) semicolon (;) separated list of event types that should be included in the results. All other types are excluded. (optional) |
deviceid | [uid] | (optional) filters events from a specific device. |
serverid | [uid] | (optional) filters events from a specific server. |
Response
|
node/event | value | remarks | |
|---|---|---|---|
id | [uid] | id of event (<= API version 2.6.1) | |
name | [string] | name of event. (API version 2.7.1+) | |
type | [string] | type of event. (<= API version 2.6.1) | |
value | [string] | value of event | |
time | [timestamp] | Time stamp of event in UTC time | |
serverid | [uid] | Id of server where the event occurred | |
deviceid | [uid] | Id of device which triggered the event, could be ommited or zero if it wasn't a device related event (i.e. SystemEvent). | |
extravalue | [string] | additional info if available (added in Sense version 2.6.8) | |
divaid | [uid] | if client events occur, then this will be the id of that specific client | |
devicename | [string] | name of the device which triggered the event (added in Sense version 2.6.8) | |
devicelocation | [string] | location of the device (added in Sense version 2.6.8) | |
servername | [string] | name of the server (added in Sense version 2.6.8) |
errorcode | description | remarks |
|---|---|---|
0 | Ok | Ok, no error |
-18 | General error | An undefined error occured |
See also
...