Get Gateways - Cisco IoT Operations Dashboard

{"type":"api","title":"Get Gateways","meta":{"id":"/apps/pubhub/media/cisco-iot-suite/64f8fe4b343793ff572741607351ff520b6a158d/5c66b3aa-a761-3029-b823-c160b9ed90db","swagger":"2.0","info":{"contact":{"email":"asset-tracking-team@cisco.com"},"description":"This service exposes APIs for managing AssetTypes, Assets, Sensors, Gateways deployed in the network.","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"http://swagger.io/terms/","title":"Industrial Asset Vision","version":"1.0.0"},"host":"us.ciscoiot.com","basePath":"/at/nbapi/v1","schemes":["https"],"externalDocs":{"description":"Find out more about Industrial Asset Vision","url":"https://www.cisco.com/c/en/us/products/cloud-systems-management/industrial-asset-vision/index.html"},"securityDefinitions":{"BearerToken":{"in":"header","name":"Authorization","type":"apiKey"}},"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"serverConfig":true,"meta":{"useProxy":true}}},"spec":{"description":"Returns a paginated list of Gateways that match the filter criteria and sorted by ordering criteria","operationId":"getGateways","parameters":[{"description":"Filter criteria","in":"query","name":"filter","required":false,"type":"string","x-example":"name==IXMGateway"},{"description":"Order criteria","in":"query","name":"orderBy","required":false,"type":"string","x-example":"name desc"},{"default":0,"description":"Page Number","in":"query","minimum":0,"name":"page","required":false,"type":"integer","x-example":"page=0"},{"default":10,"description":"Page Size","in":"query","maximum":500,"minimum":1,"name":"size","required":false,"type":"integer","x-example":"size=10"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"properties":{"data":{"description":"List of Gateways","items":{"example":{"additionalInfo":{"antennaGain":1.5,"antennaType":"ANT-WPAN-OD-OUT-N","lightningArrestorPresent":false,"numberOfAntennas":1,"totalLoss":0.1},"createdBy":"tennantname->nbikey","createdTime":1621742677786,"description":"Gateway","gatewayId":1000000000000001,"highestAlarmSeverity":"MAJOR","id":"4b1d65ab-e60b-4cd7-a2a1-fcb40375efa2","lastSeenAt":1623751623307,"location":{"address":"Cessna Business Park, Bengaluru","latitude":78.12345678,"longitude":12.12345678},"manufacturer":"Cisco","model":"IXM","modifiedBy":"tennantname->nbikey","modifiedTime":1622124238468,"name":"IXMGateway","onboardedTime":1623751596745,"pidNumber":"IXM-LPWA-800-16-K9","region":"IN865","serialNumber":"FOD33357040","status":"Inventory","type":"IXM"},"properties":{"additionalAttributesMap":{"additionalProperties":{"type":"string"},"description":"Map of <String, String> with the key value pairs of additional attributes","type":"object","$$ref":"#/definitions/AdditionalAttributesMap"},"additionalInfo":{"example":{"antennaGain":1.5,"antennaType":"ANT-WPAN-OD-OUT-N","lightningArrestorPresent":false,"numberOfAntennas":1,"totalLoss":0.1},"properties":{"antennaGain":{"description":"Antenna Gain in dBi","format":"double","type":"number"},"antennaType":{"description":"Antenna Type","enum":["ANT-WPAN-OD-OUT-N","ANT-LPWA-DB-O-N","CUSTOM"],"type":"string"},"lightningArrestorPresent":{"description":"Antenna Lightning Arrestor (ACC-LA-H-NM-NF) present or not","type":"boolean"},"numberOfAntennas":{"description":"Number of Antennas","type":"integer"},"totalLoss":{"description":"Total Loss in dB","format":"double","type":"number"}},"type":"object","$$ref":"#/definitions/AdditionalGatewayInfo"},"alarmSeverityMap":{"additionalProperties":{"type":"integer"},"description":"Map of <AlarmSeverity, alarmCount>","type":"object"},"cpfVersion":{"description":"Gateway CPF Version","type":"string"},"createdBy":{"description":"Created By","type":"string"},"createdTime":{"description":"Created Time (Epoch Time)","format":"int64","type":"integer"},"description":{"description":"Gateway Description","type":"string"},"firmwareVersion":{"description":"Gateway Firmware Version","type":"string"},"gatewayId":{"description":"Gateway Id","type":"string"},"highestAlarmSeverity":{"description":"Highest Alarm Severity","enum":["NONE","CRITICAL","MAJOR","MINOR"],"type":"string"},"id":{"format":"uuid","type":"string"},"lastSeenAt":{"description":"Last Seen","format":"int64","type":"integer"},"liveData":{"additionalProperties":{"properties":{"name":{"description":"Attribute Name","type":"string"},"timestamp":{"description":"Timestamp in epoch time","type":"string"},"unitSymbol":{"description":"Attribute Unit Symbol","type":"string"},"value":{"description":"Attribute Value","type":"string"}},"type":"object","$$ref":"#/definitions/LiveDataItem"},"description":"Live Telemetry Data","type":"object"},"location":{"description":"Location details","properties":{"address":{"description":"Address","type":"string"},"latitude":{"description":"Latitude","format":"double","type":"number"},"longitude":{"description":"Longitude","format":"double","type":"number"}},"type":"object","$$ref":"#/definitions/Location"},"manufacturer":{"description":"Gateway Manufacturer","type":"string"},"model":{"description":"Gateway Model","type":"string"},"modifiedBy":{"description":"Modified By","type":"string"},"modifiedTime":{"description":"Modified Time (Epoch Time)","format":"int64","type":"integer"},"name":{"description":"Gateway Name","type":"string"},"onboardedTime":{"description":"Onboarded TIme","format":"int64","type":"integer"},"pidNumber":{"description":"Gateway PID Number","type":"string"},"region":{"description":"Gateway Region","type":"string"},"serialNumber":{"description":"Gateway Serial Number","type":"string"},"serialNumberPresentInPnp":{"description":"Serial Number present in Cisco PnP services or not","type":"boolean"},"status":{"description":"Gateway Status","enum":["Inventory","Unheard","Heard","Online","Offline"],"type":"string"},"type":{"description":"Gateway Type","type":"string"},"upTime":{"description":"Gateway Uptime","type":"string"}},"type":"object","$$ref":"#/definitions/Gateway"},"type":"array"},"pageInfo":{"example":{"count":1,"page":0,"size":10,"totalCount":10},"properties":{"count":{"description":"Count of items returned in the current page","type":"integer"},"page":{"description":"Page Number","type":"integer"},"size":{"description":"Page Size","type":"integer"},"totalCount":{"description":"Total count of objects matching the filter criteria","type":"integer"}},"type":"object","$$ref":"#/definitions/PageInfo"}},"type":"object","$$ref":"#/definitions/GatewayListResponse"}},"400":{"description":"Bad Request","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"401":{"description":"Unauthorized","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"403":{"description":"Forbidden","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}},"500":{"description":"Internal Server Error","schema":{"description":"Contains errorCode and message","example":{"message":"Error Message","status":"4xx/500"},"properties":{"message":{"description":"A user readable message that describes the error in details.","type":"string"},"status":{"description":"Http Status Code that describes the error","type":"integer"}},"type":"object","$$ref":"#/definitions/Error"}}},"security":[{"BearerToken":[]}],"summary":"Get Gateways","tags":["Gateways"],"__originalOperationId":"getGateways","method":"get","path":"/gateways"}}