This API deletes all events with specified IDs.
Authentication phase
Before using the endpoint, you must run the authentication phase (→ Login).
After the authentication, a session opens and a valid session token persists until:
- The end of the session time-out, that is set through the parameter sessionTimeout (→ OptimaWSI configuration > OptimaAuth node).
- An explicit Logout call (→ Logout).
Request endpoint
Request
DEL
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event/
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
eventId |
NO |
Event identifier. You can also specify a list of n events, in the format: eventId=ID1&eventId=ID2&...&eventId=IDn. Important: IDs can be obtained through → Getting PuT events. |
Request content-type
Not applicable.
Request body (payload)
Not applicable.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response content-type
text/plain
Response output
A formatted text:
Deleted <number of events> events
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-put/event?eventId=1&eventId=2&eventId=3&eventId=4
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The processing request has been accepted. |
Response output
Deleted 2 events