Get Assets - Cisco IoT Operations Dashboard

{"type":"api","title":"Get Assets","meta":{"id":"/apps/pubhub/media/cisco-iot-suite/fbcd3c11dd48e274ddaa7139d3a3ed24e2e107e0/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 Assets that match the filter criteria and sorted by ordering criteria","operationId":"getAssets","parameters":[{"description":"Filter criteria","in":"query","name":"filter","required":false,"type":"string","x-example":"name=ilike=\"Container1001\""},{"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=20"},{"description":"Order criteria","in":"query","name":"orderBy","required":false,"type":"string","x-example":"model asc"}],"produces":["application/json"],"responses":{"200":{"description":"Success","schema":{"example":{"data":[{"assetType":"ColdRoom","assetTypeId":"d841cf90-f921-4821-bd21-c0155a441c7b","createdBy":"nbtenant-\u003enbikey","createdTime":1622113351719,"description":"ColdRoom1 Description","highestAlarmSeverity":"NONE","id":"b376f226-25ad-4f90-b706-f977a51f4cb2","name":"ColdRoom1","sensorCount":0},{"assetType":"ColdRoom","assetTypeId":"d841cf90-f921-4821-bd21-c0155a441c7b","createdBy":"nbtenant-\u003enbikey","createdTime":1622113351819,"description":"oldRoom2 Description","highestAlarmSeverity":"MAJOR","id":"123a96f0-2bdc-4a89-afbb-c42f773005fb","name":"ColdRoom2","sensorCount":1}]},"properties":{"data":{"description":"List of Assets","items":{"example":{"assetType":"ColdRoom","assetTypeId":"d841cf90-f921-4821-bd21-c0155a441c7b","createdBy":"tenantname-\u003enbikey","createdTime":1622113351719,"description":"Cold Room Storages","highestAlarmSeverity":"NONE","name":"Cold Room","sensorCount":0},"properties":{"assetType":{"description":"Asset Type","type":"string"},"assetTypeId":{"description":"Asset Type Id","format":"uuid","type":"string"},"createdBy":{"description":"Created By","type":"string"},"createdTime":{"description":"Created Time (Epoch Time)","format":"int64","type":"integer"},"customAttributes":{"description":"Custom Attributes of the Asset","items":{"properties":{"name":{"description":"Attribute Name","type":"string"},"value":{"description":"Attribute Value","type":"object"}},"type":"object","$$ref":"#/definitions/CustomAttributeData"},"type":"array"},"description":{"description":"Asset Description","type":"string"},"highestAlarmSeverity":{"description":"Highest Alarm Severity","enum":["NONE","CRITICAL","MAJOR","MINOR"],"type":"string"},"id":{"description":"Asset Id","format":"uuid","type":"string"},"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"},"model":{"description":"Asset Model","type":"string"},"modifiedBy":{"description":"Modified By","type":"string"},"modifiedTime":{"description":"Modified Time (Epoch Time)","format":"int64","type":"integer"},"name":{"description":"Asset Name","type":"string"},"sensorCount":{"description":"Asset Sensor Count","format":"int64","type":"integer"}},"type":"object","$$ref":"#/definitions/Asset"},"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","xml":{"name":"AssetListResponse"},"$$ref":"#/definitions/AssetListResponse"}},"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 Assets","tags":["Assets"],"__originalOperationId":"getAssets","method":"get","path":"/assets"}}