{"type":"api","title":"Get Device Data Usage","meta":{"id":"/apps/pubhub/media/sd-wan-api-20-16/58fb893fa751949ea20a40274e9ab219a20e19fa/e77267b5-7b4b-3f93-807c-c6d1c6b41343","info":{"title":"Cisco Catalyst SD-WAN Manager API","description":"The vManage API exposes the functionality of operations maintaining devices and the overlay network","contact":{"email":"vmanage@cisco.com"},"license":{"name":"Commercial License","url":"https://www.cisco.com/c/en/us/solutions/enterprise-networks/sd-wan/index.html"},"version":"2.0.0"},"openapi":"3.0.1","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Secure Device OnBoarding - Provider Credentials"],"description":"Get device data usage using device uuid","operationId":"getDeviceDataUsage","parameters":[{"name":"deviceUUID","in":"path","description":"DeviceUUID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"required":["carrierName","communicationPlan","controllerId","currentDataUsage","iccid","ratePlan","ratePlanType","slotId"],"type":"object","properties":{"carrierName":{"type":"string","description":"Name of the service provider.","example":"Singtel"},"communicationPlan":{"type":"string","description":"Name of the communication plan.","example":"vm cp sms data share"},"controllerId":{"type":"string","description":"Controller Id","example":"1"},"currentDataUsage":{"type":"string","description":"Current Data Usage.","example":"10MB"},"errorDetails":{"type":"string","description":"Details of any error encountered while retrieving device data usage","example":"No eSIM ICCIDs found"},"esimStatus":{"type":"string","description":"Bootstrap eSim Status","example":"ACTIVATED"},"iccid":{"type":"string","description":"Identifier of the eSIM device.","example":"8988216716970004975"},"isBootstrap":{"type":"boolean","description":"Boolean flag that indicated if ICCID is on bootstrap account"},"otherEsimsDataUsage":{"type":"string","description":"Total data used by other eSIM devices.","example":"20MB"},"ratePlan":{"type":"string","description":"Name of the rate plan.","example":"vm fixed pool rp"},"ratePlanDataUsageLimit":{"type":"string","description":"Rate plan usage limit.","example":"50MB"},"ratePlanType":{"type":"string","description":"Rate plan type.","example":"Monthly - Pooled Subscriber"},"slotId":{"type":"integer","description":"Slot Id","format":"int32"},"totalDataUsage":{"type":"string","description":"Total data usage","example":"30MB"},"usageThresholdWarning":{"type":"array","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%.","items":{"type":"string","description":"Total value of current data usage and data used by other eSIM devices","example":"Data Usage has reached or exceeded the threshold limit of 90%."}}},"$$ref":"#/components/schemas/DeviceUsageDetails"},"examples":{"Device Usage Response Example":{"description":"Device Usage Response Example","value":"[{\n\t \"iccid\": \"8988216716970004975\",\n\t \"carrierName\": \"Singtel\",\n\t \"ratePlan\":\"hphlr rp1\" ,\n\t \"communicationPlan\": \"vm cp sms data shared\",\n\t \"ratePlanType\":\"Monthly - Pooled Subscriber\",\n\t \"currentDataUsage\":\"10MB\",\n\t \"ratePlanUsageLimit\": \"50MB\",\n\t \"otherEsimsDataUsage\": \"20MB\",\n\t }]"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Secure Device Onboarding-read","__originalOperationId":"getDeviceDataUsage","method":"get","path":"/v1/securedeviceonboarding/{deviceUUID}/deviceusage"}}