This endpoint (logically) deletes a KPI instance.
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 Endpoint
Request
DELETE
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance/<instance_id>Request resource
Not applicable.
Request parameters
| Parameter | Required | Description |
|---|---|---|
|
instance_id |
YES |
Integer type. It contains the identifier of an existing KPI instance. |
Request content-type
application/JSON
Request body (payload)
Payload is empty.
Response
Response status
| HTTP status | Description |
|---|---|
|
200 OK |
The KPI instance is deleted. |
|
403 Forbidden |
The KPI instance is already deleted. |
|
404 Not found |
The instance ID does not exists. |
Response content-type
application/JSON
Response output
The KPI instance deleted.
In case of error 403 or 404, the output is formatted as a couple:
<error_code>: <error description>
Example: Delete a KPI instance
Request
https://<OPTIMA_HOST_IP_ADDRESS>:<PORT_NUMBER>/optima-kpi/kpi/api/instance/459
Additional Notes
Instance 459 is deleted.