.png?sv=2022-11-02&spr=https&st=2025-12-27T18%3A38%3A27Z&se=2025-12-27T18%3A48%3A27Z&sr=c&sp=r&sig=eWH4dyaGhw853fw5%2FQRn2iNv2AO82GkSgazRCo6BydI%3D){kind=logo}
Set API Error
- DarkLight
Set API Error
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows the Agent to define the error message for the application accessing Acqueon Workspace.
Pre-requisite
The application must be registered with the Cisco channel.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Cisco |
topic | Error |
subtopic | SetAPIError |
source | «app-name-broadcasting-this-message» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
packet | String | Name of the packet. | apierror |
data | JSON Object | NA | NA |
errorType | String | The error type. | Invalid state |
errorMessage | String | The internally used message to convey the error. | Supervisor setting state to 'Ready' is not allowed. |
msg | String | The internal message above converted to a user-friendly message. | Supervisor setting state to 'READY' is not allowed. |
Response Parameters
Response Parameters | Value |
|---|---|
channel | Not applicable |
topic | Not applicable |
subtopic | Not applicable |
message | Not applicable |
Sample Request
{
"channel": "Cisco",
"topic": "Error",
"subtopic": "SetAPIError",
"data":
{
"packet": "apierror",
"data ":
{
"errorType": "Invalid State",
"errorMessage": "Supervisor setting state to 'READY' is not allowed",
"msg": "Supervisor setting state to 'READY' is not allowed"
}
}
}Sample Response
No sample responseWas this article helpful?