Retrieve Events - Cisco Edge Intelligence 2.2 API

{"type":"api","title":"Retrieve Events","meta":{"id":"/apps/pubhub/media/cisco-edge-intelligence-2-2-0-api/2d8524cb89cd60e1e2e66bcc438913d05fdc9eff/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"Edge Intelligence Local Manager API Documentation","description":"This API enables management of data policies within the Cisco Edge Intelligence IOx Application.\n\n**Key Features**:\n- User Authentication\n- Data Policy Management\n- Agent Management\n\n**Versioning**:\n- Current version: v2\n- Access pattern: `/api/v{version_number}/edge-intelligence`\n\n**Security**:\n- All endpoints secured with JWT Bearer token authentication\n- Tokens expire after 5 mins\n- Refresh tokens using the `/token` endpoint\n","version":"2.2.0"},"tags":[{"name":"Authentication","description":"User authentication and token management"},{"name":"Policy Management","description":"Data policy management"},{"name":"Agent Management","description":"Edge Intelligence Agent management"},{"name":"Metrics","description":"Edge Intelligence Metrics"}],"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://localhost/api/v2/edge-intelligence","description":"Local development server"}],"securitySchemes":{"Bearer":{"type":"apiKey","description":"JWT Authorization header using the Bearer scheme.\nExample: \"Authorization: Bearer {token}\"\n","name":"Authorization","in":"header"}}},"spec":{"tags":["Event Management"],"summary":"Retrieve Events","description":"Fetches events\n","operationId":"getEvents","parameters":[{"name":"severity","in":"query","required":false,"description":"Severity of event","schema":{"type":"string","enum":["Low","Medium","High"]},"$$ref":"#/components/parameters/EventSeverity"},{"name":"type","in":"query","required":false,"description":"Type of event","schema":{"type":"string","enum":["backpressure"]},"$$ref":"#/components/parameters/EventType"},{"name":"startTime","in":"query","required":false,"description":"start time of event","schema":{"type":"string","format":"time-date"},"$$ref":"#/components/parameters/StartTime"},{"name":"endTime","in":"query","required":false,"description":"end time of event","schema":{"type":"string","format":"time-date"},"$$ref":"#/components/parameters/EndTime"},{"name":"sortBy","in":"query","required":false,"description":"Sort by field","schema":{"type":"string","enum":["type","severity","createdAt"]},"$$ref":"#/components/parameters/SortBy"},{"name":"order","in":"query","required":false,"description":"Sort order (asc or desc)","schema":{"type":"string"},"$$ref":"#/components/parameters/Order"},{"name":"pageNo","in":"query","required":false,"description":"Page number","schema":{"type":"integer"},"$$ref":"#/components/parameters/PageNo"},{"name":"size","in":"query","required":false,"description":"Size of page","schema":{"type":"integer"},"$$ref":"#/components/parameters/Size"}],"responses":{"200":{"description":"Events retrieved successfully","content":{"application/json":{"schema":{"description":"Events response","properties":{"success":{"description":"boolean value indicating success or failure","type":"boolean","example":true},"data":{"description":"Events ResponseData","type":"object","properties":{"items":{"description":"list of events response","type":"array","properties":{"Type":{"description":"Type of event","type":"string"},"CreatedAt":{"description":"Event created date-time","type":"integer"},"Severity":{"description":"Severity of event","type":"string"},"Data":{"description":"Event deails","type":"object","properties":{"message":{"description":"Event message","type":"string"},"origin":{"description":"When was the event originated","type":"string"},"pipeline-id":{"description":"Event pipeline-id","type":"string"},"severity":{"description":"Event severity","type":"string"},"ts":{"description":"Event created date-time","type":"string","format":"date-time"},"type":{"description":"Event type","type":"string"}},"$$ref":"#/components/schemas/EventDetails"}},"$$ref":"#/components/schemas/Events"},"pagination":{"description":"Pagination","properties":{"page":{"description":"Page Number","type":"integer"},"limit":{"description":"Number of items in each page","type":"integer"},"total":{"description":"Total number of items","type":"integer"}},"$$ref":"#/components/schemas/Pagination"}},"$$ref":"#/components/schemas/EventsResponseData"},"message":{"description":"string value indicating success or failure","type":"string","example":"Successful"}},"$$ref":"#/components/schemas/EventsResponse"}}}},"400":{"description":"Error in retrieving pipeline configuration.","content":{"application/json":{"schema":{"type":"object","description":"PipelineConfigBadRequest","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"error":{"type":"object","description":"error message","properties":{"code":{"type":"string","description":"error code of failure"},"message":{"type":"string","description":"detailed error message"}}}},"$$ref":"#/components/schemas/PipelineConfigBadRequest","example":{"success":false,"error":{"code":"PIPELINE_NOT_FOUND","message":"Pipeline with ID 020aa190-5db2-4198-9db9-477901f2b1ca_2c157e50-3552-4f1c-a820-091dee209e40 does not exist"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","description":"Error response object","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"error":{"type":"object","description":"error message","properties":{"code":{"type":"string","description":"error code of failure"},"message":{"type":"string","description":"detailed error message"}}}},"$$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":{"code":"INVALID_TOKEN","message":"Invalid token"}}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"Error response object","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"error":{"type":"object","description":"error message","properties":{"code":{"type":"string","description":"error code of failure"},"message":{"type":"string","description":"detailed error message"}}}},"$$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":{"code":"FORBIDDEN","message":"Unauthorised operation performed"}}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Requested resource not found","content":{"application/json":{"schema":{"type":"object","description":"Error response object","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"error":{"type":"object","description":"error message","properties":{"code":{"type":"string","description":"error code of failure"},"message":{"type":"string","description":"detailed error message"}}}},"$$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":{"code":"NOT_FOUND","message":"Data not found"}}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Error response object","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"error":{"type":"object","description":"error message","properties":{"code":{"type":"string","description":"error code of failure"},"message":{"type":"string","description":"detailed error message"}}}},"$$ref":"#/components/schemas/ErrorResponse"},"example":{"success":false,"error":{"code":"INTERNAL_SERVER_ERROR","message":"Internal server error"}}}},"$$ref":"#/components/responses/InternalServerError"}},"security":[{"Bearer":[]}],"__originalOperationId":"getEvents","method":"get","path":"/events"}}