Retrieve TxnResult objects based on filters - Crosswork Network Controller 7.1 APIs

{"type":"api","title":"Retrieve TxnResult objects based on filters","meta":{"id":"/apps/pubhub/media/crosswork-network-controller-7-1/b95772dc6c621d9842faced8610ee58b0cb9cb02/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":{"operationId":"GetTxnResult","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseTxnResultQueryReq","example":{"descending_order":true,"device_id":"RouterSanFrancisco","end_time":"1585202281518486500","error":"nso","kpi_id":"Ethernet port packet statistics","kpi_profile_id":"layer1traffic","kpi_type":"KPI","limit":0,"offset":0,"sort_by":"state","start_time":"1585198526801108200","state":"Failed","tx_id":"39"},"properties":{"descending_order":{"description":"descending_order","title":"Sort order. Default is ascending","type":"boolean"},"device_id":{"description":"device_id","title":"Pulse Device ID","type":"string"},"end_time":{"description":"end_time","format":"int64","title":"Timestamp for end time","type":"string"},"error":{"description":"error","title":"Error","type":"string"},"kpi_id":{"description":"kpi_id","title":"Pulse KPI ID","type":"string"},"kpi_profile_id":{"description":"kpi_profile_id","title":"Pulse KPI profile ID","type":"string"},"kpi_type":{"description":"kpi_type","title":"Pulse KPI type","type":"string"},"limit":{"description":"limit","title":"Specifies limit on number of rows to return in a single request\ne.g if limit = 4 then the api will return 4 rows\nDefault is 10","type":"integer"},"offset":{"description":"offset","format":"int32","title":"For pagination, specify the offset while fetching records.\ne.g.: if limit is 10, then in the first API call offset will be 0, in the 2nd call offset=10, 3rd call offset=20 etc","type":"integer"},"sort_by":{"description":"sort_by","title":"Sort field name","type":"string"},"start_time":{"description":"start_time","title":"Timestamp for start time","type":"string"},"state":{"description":"state","title":"Transaction State","type":"string"},"tx_id":{"description":"tx_id","format":"int64","title":"Transactin ID","type":"string"}},"title":"Pulse Request Object for querying Txnresult","type":"object","$$ref":"#/components/schemas/pulseTxnResultQueryReq"}}},"description":"This pulse endpoint returns TxnResult objects matched with filter params in the request object\nArgument passed in includes txid,profile_id,kpi_id and limit/offset. If no filter params matches returns all TxnResult for the txid\nArgument returned is TxnResultQueryResp\nExample: curl -x Post http://localhost:8000/v1/kpiprofile/jobDetails -d '{\"tx_id\": \"10\", \"Limit\": 10, \"Offset\": 0}'","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"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":"Pulse Response Object for returning Txnresult","type":"object","$$ref":"#/components/schemas/pulseTxnResultQueryResp"}}},"description":"A successful response."},"400":{"content":{},"description":"Bad Request"},"500":{"content":{"application/json":{"schema":{"description":"Description for error","example":"Internal Server Error","type":"string","$$ref":"#/components/schemas/error"}}},"description":"Internal Server Error"}},"summary":"Retrieve TxnResult objects based on filters","tags":["KPI Profile / Device(s) Enable/Disable/Jobs"],"x-codegen-request-body-name":"body","__originalOperationId":"GetTxnResult","security":[{"bearerAuth":[]}],"method":"post","path":"/kpiprofile/jobDetails"}}