{"type":"api","title":"Get Software Upgrade Status","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 software upgrade status for groups (ina paginated way).\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\u003cbr /\u003e- Manage Groups\u003cbr /\u003e- Add Devices","operationId":"getSoftwareUpgradeStatus","parameters":[{"description":"The uuid of the tenant in whose context we are calling the api.","format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"default":0,"description":"page number requested to be displayed","in":"query","minimum":0,"name":"page","required":false,"type":"integer"},{"default":20,"description":"The numbers of items to return","in":"query","maximum":200,"minimum":1,"name":"size","required":false,"type":"integer"}],"produces":["application/json"],"responses":{"200":{"description":"successful retrieval","schema":{"properties":{"objectType":{"example":"PagedSoftwareUpgradeStatusVo"},"page":{"example":0},"results":{"items":{"properties":{"createdBy":{"example":"myadmin@cisco.com","type":"string"},"createdTime":{"example":"2023-02-16 19:38:02","type":"string"},"errorMessage":{"example":null,"type":"string"},"group":{"example":"26cb98fc-1f9b-48ec-bffb-765580a1411b","type":"string"},"groupName":{"example":"default-ir1100","type":"string"},"jobName":{"example":"SHRUTHI: [0C_Sparrow_Cel_171124002_DNU]","type":"string"},"jobStatus":{"enum":["SCHEDULED","IN_PROGRESS","FAILED","CANCELLED","FINISHED"],"example":"FINISHED","type":"string"},"scheduledTime":{"example":"2023-02-18 07:00:57","type":"string"},"sourceVersionDetails":{"example":null,"type":"object"},"targetVersion":{"example":null,"type":"string"}},"required":["jobName","group","targetVersion","sourceVersionDetails","createdTime","scheduledTime","createdBy","jobStatus","errorMessage","groupName"],"type":"object","$$ref":"#/definitions/SoftwareUpgradeStatusVo"},"type":"array"},"size":{"example":1},"total":{"example":1}},"required":["results"],"type":"object","$$ref":"#/definitions/PagedSoftwareUpgradeStatusVo"}},"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":"Unauthorized","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}}},"summary":"Get software upgrade status for groups (in a paginated way)","tags":["groups"],"__originalOperationId":"getSoftwareUpgradeStatus","security":[{"bearerAuth":[]}],"method":"get","path":"/groups/software_upgrade/status"}}