{"type":"model","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/f445c17e25a1120e8fbde4bd413083d0fd88b2b3/280afeb1-5ea4-33e3-8618-f92d3ecedf8f","info":{"contact":{"email":"support@cisco.com","name":"Crosswork Team, Cisco"},"description":"Health Insights(HI) is a software system that provides smart KPI monitoring and remediation for service provider networks. This document contains details of the HI RESTful APIs that can be used to manage KPIs, enable/disable KPIs on groups or devices, query KPIs and device alerts, remediate alerting KPIs etc.","license":{"name":"Cisco Software License Agreement","url":"https://www.cisco.com/public/sw-license-agreement.html"},"title":"Crosswork Health Insights API","version":"7.1.0"},"security":[{"bearerAuth":[]}],"x-parser-conf":{"overview":{"markdownPath":"reference/CAHI/health_insights_overview.md"}},"openapi":"3.0.1","servers":[{"url":"https://{server_ip}:30603/crosswork/hi/v1","description":"Generated server url"}],"securitySchemes":{"bearerAuth":{"description":"token","in":"header","name":"Authorization","type":"apiKey"}}},"spec":{"description":"Description for transaction","properties":{"end_time":{"description":"End time of transaction. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"array"},"error":{"description":"Error message, if any, of transaction.","type":"array"},"method":{"description":"HTTP method. Values are 'DELETE', 'POST', and 'PUT'.","type":"array"},"request":{"description":"Request body in JSON format.","properties":{},"type":"array"},"start_time":{"description":"Start time of transaction. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"array"},"state":{"description":"State of transaction. Values are 'Failed', 'Partial', 'Processing', 'Queued', and 'Success'.","type":"array"},"tasks":{"description":"tasks","properties":{"task":{"description":"task","items":{"properties":{"device_id":{"description":"Device identifier.","type":"string"},"end_time":{"description":"End time of task. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"string"},"error":{"description":"Error message, if any, of task.","type":"string"},"kpi_id":{"description":"KPI identifier.","type":"string"},"operation":{"description":"Operation values are 'Create', 'Delete', and 'Update'.","type":"string"},"start_time":{"description":"Start time of task. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"string"},"state":{"description":"State of task. Values are 'Failed', 'Processing', 'Queued', and 'Success'.","type":"string"},"subtasks":{"description":"subtasks","properties":{"subtask":{"description":"subtask","items":{"properties":{"end_time":{"description":"End time of subtask. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"string"},"error":{"description":"Error message, if any, of subtask.","type":"string"},"start_time":{"description":"Start time of subtask. Unix time in the format of for example, \"2017-10-30T14:53:33.967154-07:00\".","type":"string"},"state":{"description":"State of subtask. Values are 'Failed', 'Processing', 'Queued', and 'Success'.","type":"string"},"subtask_id":{"description":"Subtask identifier.","type":"string"}},"type":"object"},"type":"array"}},"type":"object"},"uuid":{"description":"UUID","type":"string"}},"type":"object"},"type":"array"}},"type":"array"},"txid":{"description":"Transaction identifier (64-bit integer).","type":"array"},"url":{"description":"Request URL.","type":"array"}},"type":"object","$$ref":"#/components/schemas/transaction","title":"transaction"}}