{"type":"api","title":"Returns filtered or all Txn objects","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":{"operationId":"GetTxn","requestBody":{"content":{"application/json":{"schema":{"description":"Description for pulseTxnQueryReq","example":{"end_time":1585156983722900200,"limit":0,"method":"DELETE","offset":0,"start_time":1585156960679719400,"state":"Complete","tx_id":25},"properties":{"end_time":{"description":"end_time","format":"int64","title":"Timestamp for end time","type":"integer"},"limit":{"description":"limit","format":"int32","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"},"method":{"description":"method","title":"Transaction Method","type":"string"},"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"},"start_time":{"description":"start_time","format":"int64","title":"Timestamp for start time","type":"integer"},"state":{"description":"state","title":"Transaction status","type":"string"},"tx_id":{"description":"tx_id","format":"int64","title":"Transaction ID","type":"integer"}},"title":"Pulse request object for transactions","type":"object","$$ref":"#/components/schemas/pulseTxnQueryReq"}}},"description":"This pulse endpoint returns Txn objects matched with filter params in the request object\nArgument passed in includes txid,origin and limit/offset. If no filter params matches returns all Txn\nArgument returned is TxnQueryResp\nExample: curl -x Post /v1/kpiprofile/jobs -d '{\"tx_id\": \"10\", \"Limit\": 10, \"Offset\": 0}'","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"description":"Description for pulseTxnQueryResp","example":{"end_time":1585156983722900200,"limit":0,"method":"DELETE","offset":0,"start_time":1585156960679719400,"state":"Complete","tx_id":25},"properties":{"total_filtered_txn_count":{"description":"total_filtered_txn_count","format":"int64","title":"Total Filtered Transactions count","type":"array"},"total_txn_count":{"description":"total_txn_count","format":"int64","title":"Total Transactions count","type":"array"},"txns":{"description":"txns","items":{"description":"Description for pulseTxn","example":{"created_by":"test","end_time":1588658326215551000,"error":"","method":"PATCH","start_time":1588658322014805800,"state":"Complete","tx_id":7},"properties":{"created_by":{"description":"created_by","title":"created By User","type":"string"},"end_time":{"description":"end_time","format":"int64","title":"Timestamp for end time","type":"integer"},"error":{"description":"error","title":"Transaction error","type":"string"},"method":{"description":"method","title":"Transaction Method","type":"string"},"start_time":{"description":"start_time","format":"int64","title":"Timestamp for start time","type":"integer"},"state":{"description":"state","type":"string"},"tx_id":{"description":"tx_id","format":"int64","title":"Transaction ID","type":"integer"}},"title":"Transaction object","type":"object","$$ref":"#/components/schemas/pulseTxn"},"title":"Transaction Objects","type":"array"}},"title":"Pulse response object for transactions","type":"object","$$ref":"#/components/schemas/pulseTxnQueryResp"}}},"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":"Returns filtered or all Txn objects.","tags":["KPI Profile / Device(s) Enable/Disable/Jobs"],"x-codegen-request-body-name":"body","__originalOperationId":"GetTxn","security":[{"bearerAuth":[]}],"method":"post","path":"/kpiprofile/jobs"}}