Deletes an event from Optima.
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 section).
- An explicit Logout call (→ Logout).
Request
Request
POST
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/event/deleteRequest parameters
Not applicable.
Request content-type
Not applicable.
Request body (payload)
The body of this post must be in the format x-www-form-urlencoded with:
- Key = id.
- Value = the unique ID of the event that you want to delete.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
Result of the processed request. |
Response content-type
application/json
Response output
{
"success": true
}
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/datex2import/optima/event/deleteRequest input
Key = id
Value = TEST.1Response status
200
Response output
{
"success": true
}