Get Status of Specific Pipeline - Cisco Edge Intelligence 2.2 API

{"type":"api","title":"Get Status of Specific Pipeline","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":"Get Status of Specific Pipeline","description":"Retrieves the status of a specific data pipeline","operationId":"getPipelineStatus","parameters":[{"name":"pipelineId","in":"path","required":true,"description":"Unique identifier of the pipeline","schema":{"type":"string"},"$$ref":"#/components/parameters/PipelineId"}],"responses":{"200":{"description":"Successfully retrieved the health status of the specified pipeline.","content":{"application/json":{"schema":{"type":"object","description":"HealthStatusSuccess","properties":{"success":{"type":"boolean","description":"boolean value indicating success or failure"},"data":{"type":"object","description":"Health Status of pipeline","properties":{"healthStatus":{"description":"health status details","type":"object","properties":{"cloud2device":{"description":"cloud2device","type":"object","properties":{"processedTs":{"description":"processedTs","type":"integer","nullable":true}}},"dataLogic":{"description":"dataLogic","type":"boolean"},"id":{"description":"id of data logic","type":"string","example":"16c630b8-2adb-4a42-8a1a-99e328d041c6_e2260dda-814a-4a55-a9bf-ead72198ffda"},"pipelineStatus":{"description":"pipeline status","type":"string","example":"Stopped"},"processing":{"description":"processing data","type":"object","properties":{"error":{"description":"error details","type":"object","properties":{"ts":{"description":"timestamp of error","type":"integer","example":1716813035352},"v":{"description":"description value","type":"string","example":""}}},"processedTs":{"description":"processedTs","type":"integer","example":1725258096050}}},"sources":{"description":"sources","type":"array","items":{"description":"list of sources","type":"object","properties":{"error":{"description":"error details","type":"object","properties":{"ts":{"description":"timestamp of error","type":"integer","example":1716813035307},"v":{"description":"description value","type":"string","example":""}}},"label":{"description":"Asset Name","type":"string","example":"input"},"processedTs":{"description":"processedTs","type":"integer","example":0}}}},"targets":{"description":"targets","type":"array","items":{"description":"list of targets","type":"object","properties":{"error":{"description":"error details","type":"object","properties":{"ts":{"description":"timestamp of error","type":"integer","example":1721885445215},"v":{"description":"description value","type":"string","example":"unexpected disconnect, reason = 'The connection was lost."}}},"label":{"description":"label","type":"string","example":"output"},"processedTs":{"description":"processedTs","type":"integer","example":1721885444571}}}}}},"name":{"description":"pipeline name","type":"string","example":"demo-pipeline"}},"$$ref":"#/components/schemas/HealthStatus"},"message":{"type":"string","description":"message","example":"Successfully Retrieved Pipeline Health Status"}},"$$ref":"#/components/schemas/HealthStatusSuccess"}}}},"400":{"description":"Error in retrieving pipeline health status.","content":{"application/json":{"schema":{"type":"object","description":"HealthStatusBadRequest","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/HealthStatusBadRequest","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":"getPipelineStatus","method":"get","path":"/pipelines/{pipelineId}/status"}}