{"type":"api","title":"Get Image","meta":{"id":"/apps/pubhub/media/edm-api-v2/a2a30bcc9ecab5281b65761ae61df7e0031d5691/f67a4e01-0023-334a-9a4a-7e606c2ef1a2","swagger":"2.0","info":{"contact":{"email":"devmgmt@cisco.com"},"description":"This is the IoT device management core service. The service is responsible for managing the lifecycle of various IoT gateways and endpoints deployed as part of the Field Area Networks","license":{"name":"Licensing is primarily subscription based. Call Andy now!","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"IoT Device Lifecycle Management","version":"4.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/edm/v1","schemes":["https"],"securityDefinitions":{"bearerAuth":{"description":"This is the bearer Auth token.","in":"header","name":"Authorization","type":"apiKey"}},"security":[{"bearerAuth":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"}}},"spec":{"description":"Get list of Software Images available for Software Upgrade of Base firmware or AP module firmware on managed devices.\u003cbr /\u003e One of the below permissions is needed to invoke this API\u003cbr /\u003e- Tenant Management\u003cbr /\u003e- Manage Devices\u003cbr /\u003e- Manage Firmware Upgrades","operationId":"getImage","parameters":[{"description":"Display the list of software images sorted based on fields like name, lastHeardTime. (Optional)","in":"query","name":"orderBy","required":false,"type":"string"},{"description":"Display the list of software images sorted in ascending or descending order. Must be one of value: asc or desc. (Optional)","in":"query","name":"orderDir","required":false,"type":"string"},{"description":"Firmware Bundle Type. Must be one of value: IOS_IR1800/IOS_IR1100/IOS_IR800/IOS_AP80","in":"query","name":"query","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Successful retrieval","schema":{"description":"List of images returned by the API call","items":{"properties":{"objectType":{"example":"FirmwareImageVo"},"id":{"description":"Image Id","example":"400001001","type":"integer"},"name":{"description":"Image Name","example":"testIr800","type":"string"},"fileName":{"description":"File Name","example":"test-ir800","type":"string"},"fileHash":{"description":"File Hash","example":"ABC8347D4W2-EF529GH25F8","type":"string"},"fileSize":{"description":"File Size","example":"203433678","type":"integer"},"version":{"description":"Image Version","example":"15.8(3)M4","type":"string"},"displayVersion":{"description":"Image Display Version","example":"15.8(3)M4","type":"string"},"bundleType":{"enum":["CDMA_CGR","CGOS_CGR","GSM_CGR","IOS_CGR","ENDPOINT_RF","ENDPOINT_PLC","ENDPOINT_BBU","ENDPOINT_LMAC","ENDPOINT_BL","IOS_C800","ENDPOINT_PLC_RF","IOS_AP800","IOS_IR800","LORAWAN","IOS_WPAN_RF","IOS_WPAN_PLC","IOS_WPAN_OFDM","IOS_WPAN_IXM","IOX_APP","IOX_CGR","IOX_IR800","IOS_SBR","IOX_IR500","IOS_IR807","ACTD_CGR","IOS_IR1100","IOS_IR1800","IOS_ESR5900_BASE","IOS_ESR5900_UNIVERSAL","IC3000","MK5","IG","IG_CELLULAR","IOS_IE3X00"],"example":"CDMA_CGR","type":"string"}},"type":"object","description":"Image","$$ref":"#/definitions/FirmwareImageVo"},"type":"array","$$ref":"#/definitions/FirmwareImageListVo"}},"400":{"description":"Bad request","schema":{"description":"Specifies the error that occurred during the request.","example":{"code":"10000","message":"Short message about the error","meta":"more information about that error"},"properties":{"code":{"description":"The error code that occurred in application level.","type":"number"},"message":{"description":"A user readable message that describes the error in details.","type":"string"},"meta":{"description":"Contains more information about the error message. For example when a validation error occurs, this field describes the fields that were invalid and the validation error that occurred. The content of this object can vary based on the type of error.\n","type":"object"}},"required":["code","message"],"type":"object","$$ref":"#/definitions/error"}},"401":{"description":"Unauthorized","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"404":{"description":"Not found","schema":{"example":"Image not found","type":"string"}}},"summary":"Get list of Software Images available for Software Upgrade","tags":["software"],"__originalOperationId":"getImage","security":[{"bearerAuth":[]}],"method":"get","path":"/software/image"}}