{"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 pulseTxnResultQueryResp","example":{"expected_run_time_minutes":20,"total_filtered_txnresult_count":"5","total_txnresult_count":"100","total_txnresult_failed_count":"5","txn_results":[{"collection_job_id":"","created_by":"admin","creation_time":1588657415336159000,"device_id":"RouterFremont","end_time":0,"error":"","kpi_id":"logic_test","kpi_name":"logic_test(Deleted)","kpi_profile_id":"sysmib","kpi_profile_name":"sysmib","kpi_type":"COMPOSITE","operation":"Create","start_time":1588657415336158000,"state":"Success","tx_id":39}]},"properties":{"expected_run_time_minutes":{"description":"expected_run_time_minutes","format":"int64","title":"Expected run time for the Job in minutes","type":"integer"},"total_filtered_txnresult_count":{"description":"total_filtered_txnresult_count","format":"int64","title":"Total Filtered Transaction Results","type":"string"},"total_txnresult_count":{"description":"total_txnresult_count","format":"int64","title":"Total Transaction Results","type":"string"},"total_txnresult_failed_count":{"description":"total_txnresult_failed_count","format":"int64","title":"Total Failed Transaction Results","type":"string"},"txn_results":{"description":"txn_results","items":{"description":"Description for pulseTxnResult","example":{"collection_job_id":"","created_by":"admin","creation_time":1588657415336159000,"device_id":"RouterFremont","end_time":0,"error":"","kpi_id":"logic_test","kpi_name":"logic_test(Deleted)","kpi_profile_id":"sysmib","kpi_profile_name":"sysmib","kpi_type":"COMPOSITE","operation":"Create","start_time":1588657415336158000,"state":"Success","tx_id":5},"properties":{"collection_job_id":{"description":"collection_job_id","title":"Collection Job Id","type":"string"},"created_by":{"description":"created_by","title":"created By User","type":"string"},"creation_time":{"description":"creation_time","format":"int64","title":"Transaction creation timestamp","type":"integer"},"device_id":{"description":"device_id","title":"Pulse Device ID","type":"string"},"end_time":{"description":"end_time","format":"int64","title":"Timestamp for end time","type":"integer"},"error":{"description":"error","title":"Transaction error","type":"string"},"kpi_id":{"description":"kpi_id","title":"Pulse KPI ID","type":"string"},"kpi_name":{"description":"kpi_name","title":"Pulse KPI Name","type":"string"},"kpi_profile_id":{"description":"kpi_profile_id","title":"Pulse KPI profile ID","type":"string"},"kpi_profile_name":{"description":"kpi_profile_name","title":"Pulse KPI profile Name","type":"string"},"kpi_type":{"description":"kpi_type","title":"Pulse KPI type","type":"string"},"operation":{"description":"operation","title":"Transaction operation","type":"string"},"start_time":{"description":"start_time","format":"int64","title":"Timestamp for start time","type":"integer"},"state":{"description":"state","type":"string","default":"Unknown","enum":["Unknown","Success","Failed","Processing","Validation_Fail"],"title":"- Success: Transaction result Success\n - Failed: Transaction result Failed\n - Processing: Transaction result Processing\n - Validation_Fail: Transaction result Validation failed","$$ref":"#/components/schemas/TxnResultJobDetailsStates"},"tx_id":{"description":"tx_id","format":"int64","title":"Transaction ID","type":"integer"}},"title":"Txn_Result Object","type":"object","$$ref":"#/components/schemas/pulseTxnResult"},"title":"Txn_results","type":"array"}},"title":"pulseTxnResultQueryResp","type":"object","$$ref":"#/components/schemas/pulseTxnResultQueryResp"}}