Retrieve Data Logic Logs - Cisco Edge Intelligence 2.2 API

{"type":"api","title":"Retrieve Data Logic Logs","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":["Policy Management"],"summary":"Retrieve Data Logic Logs","description":"Fetches paginated data logic logs for a specific pipeline.\nThe logs can be retrieved in chunks using cursor-based pagination.\n","operationId":"getPipelineDataLogicLogs","parameters":[{"name":"pipelineId","in":"path","required":true,"description":"Unique identifier of the pipeline","schema":{"type":"string"},"$$ref":"#/components/parameters/PipelineId"},{"name":"cursor","in":"query","required":false,"description":"Starting position for log retrieval (0-based indexing)","schema":{"type":"integer","minimum":0,"default":0,"example":0}},{"name":"limit","in":"query","required":false,"description":"Maximum number of log entries to retrieve","schema":{"type":"integer","minimum":1,"maximum":100,"default":50,"example":3}}],"responses":{"200":{"description":"Successfully retrieved data logic logs","content":{"application/json":{"schema":{"type":"object","description":"Response schema for data logic logs","properties":{"success":{"type":"boolean","description":"Indicates if the request was successful"},"data":{"type":"object","properties":{"logs":{"type":"array","description":"Array of log entries","items":{"type":"object","properties":{"line_number":{"type":"integer","description":"Line number of the log entry"},"message":{"type":"string","description":"Log message content"}}}},"next_cursor":{"type":"integer","description":"Cursor position for the next page of logs"},"total_logs":{"type":"integer","description":"Total number of log entries available"}}},"message":{"type":"string","description":"Response message"}},"$$ref":"#/components/schemas/DataLogicLogsResponse"},"example":{"success":true,"data":{"logs":[{"line_number":1,"message":"2025-02-24T08:56:35.418Z INF: on_time_trigger++++ timestamp = 2025-02-24 08:56:35.418+00:00"},{"line_number":2,"message":"2025-02-24T08:56:36.419Z INF: on_time_trigger++++ timestamp = 2025-02-24 08:56:36.419+00:00"},{"line_number":3,"message":"2025-02-24T08:56:37.419Z INF: on_time_trigger++++ timestamp = 2025-02-24 08:56:37.419+00:00"}],"next_cursor":4,"total_logs":1682},"message":"Logs retrieved successfully"}}}},"400":{"description":"Bad request","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"}}},"$$ref":"#/components/responses/BadRequest"},"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":"getPipelineDataLogicLogs","method":"get","path":"/pipelines/{pipelineId}/datalogic/logs"}}