Skip to main content

Clears pending events for a device

DELETE /v1/event/list/pending/{deviceID}

Summary

Clears pending events for a device.

Details

Clears pending events for the specified device after authorization succeeds.

Authentication

No operation-level security requirement is documented here.

Parameters

NameInTypeRequiredDescriptionExample
deviceIDpathinteger (int64)YesThe ID of the device whose pending events should be cleared.1

Request Body

No request body is documented here.

Responses

200

Success

application/json

  • array of EventWithNames
    • deviceName (string, optional)
    • eventType (string, optional)
    • agentType (string, optional)
    • version (string, optional)
    • eventStatusName (string, optional)
    • eventStatusDescription (string, optional)
    • agentIndex (integer (int64), optional)
    • key (integer (int64), optional)
    • deviceID (integer (int64), optional)
    • agentTypeID (integer (int64), optional)
    • agentID (integer (int64), optional)
    • eventTypeID (integer (int64), optional)
    • serverEvent (integer (int64), optional)
    • eventStatus (integer (int64), optional)
    • eventParameters (string, optional)
    • processID (integer (int64), optional)
    • result (string, optional)
    • percentComplete (number (double), optional)
    • priority (integer (int64), optional)
    • expirationEpoch (integer (int64), optional)
    • attemptNumber (integer (int64), optional)
    • maxAttempts (integer (int64), optional)
    • tagString (string, optional)
    • tagNumber (integer (int64), optional)
    • creationDate (string (date-time), optional)

Example

[
{
"key": 501,
"deviceID": 201,
"agentTypeID": 1,
"agentID": 1,
"eventTypeID": 1,
"serverEvent": 1,
"eventStatus": 1,
"eventParameters": "{\"presetName\":\"Run Event Preset\"}",
"processID": 4321,
"result": "Example value",
"percentComplete": 42.5,
"priority": 1,
"expirationEpoch": 1711800000,
"attemptNumber": 1,
"maxAttempts": 3,
"tagString": "Example value",
"tagNumber": 1,
"creationDate": "2026-03-30T12:00:00.0000000Z",
"deviceName": "WearableDevice",
"eventType": "Run",
"agentType": "Device",
"version": "1.0.0",
"eventStatusName": "Example value",
"eventStatusDescription": "Example description",
"agentIndex": 1
}
]