{"items":[{"type":"link","label":"Entitlements","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3","content":{"contentType":"overview","meta":{"name":"Entitlements"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"Download PDF","url":"https://docs.ruckus.cloud/static/experimental_apis/entitlement-api-0.2.0-experimental-openapi3.pdf"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[{"kind":"externallink","title":"URL","titleTranslationKey":"info.contact.url","label":"http://support.ruckuswireless.com","url":"http://support.ruckuswireless.com"},{"kind":"email","title":"Support Team","email":"support@ruckuswireless.com","label":"support@ruckuswireless.com","withCopyButton":true,"copyContent":"support@ruckuswireless.com"},{"kind":"externallink","title":"License","titleTranslationKey":"info.license","label":"RUCKUS Cloud Privacy Policy","url":"https://support.ruckuswireless.com/ruckus-cloud-privacy-policy"}]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"payload","title":"Payload","lang":"Payload"},{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Entitlements (v0.2.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overview"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This experimental RUCKUS One Licensing API document describes upcoming behavioral changes to selected licensing endpoints."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What This Experimental API Covers"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Consolidated MSP Licensing: RUCKUS One MSP internal licensing is being consolidated so that the MSP own account no longer requires separate REC licenses compared to the MSP licenses used for MSP EC tenants."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Current State vs. New Behavior: Historically, REC licenses were required for the MSP own account while MSP licenses were required for MSP ECs. Under the new behavior, MSPs use a unified MSP licensing model across own-account and EC usage."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scope of Impact"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The behavioral changes only affect RUCKUS One MSP customers and are expected to be adopted through newer API versions."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The changes do not affect RUCKUS One RECs, but REC customers can also migrate to the newer API versions for additional clarity."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Usage & Compatibility"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"These changes are exposed through the v1.2 and v1.3 licensing APIs documented here."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Existing clients should review their usage of entitlement and compliance APIs for MSP tenants in light of the unified licensing model."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important Notes"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Please follow the RUCKUS One attention notes by going to the RUCKUS One portal and navigating to Subscriptions > Compliance to see when these changes will take effect in your region."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional Information"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you need more information related to consolidated licensing, refer to https://support.ruckuswireless.com/articles/000015527"},"children":[]}]}]}]}]}],"sectionId":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3"}],"sectionId":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3"}]}]}},{"type":"group","label":"Entitlement","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement","items":[{"label":"Get Entitlement Utilization Summaries","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getsummary","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getsummary","metadata":{"seo":{"title":"Get Entitlement Utilization Summaries","description":"Retrieves comprehensive entitlement utilization summaries that provide real-time visibility into how licenses are being consumed. Entitlement utilization summaries are aggregated reports that show license consumption patterns for each license type and device category. These summaries help organizations understand their license usage."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSummary","name":"Get Entitlement Utilization Summaries","isWebhook":false,"pointer":"/paths/~1entitlements~1utilizations~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Entitlement Utilization Summaries","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves comprehensive entitlement utilization summaries that provide real-time visibility into how licenses are being consumed. Entitlement utilization summaries are aggregated reports that show license consumption patterns for each license type and device category. These summaries help organizations understand their license usage."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1utilizations~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"},"application/json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"}},"schemaId":"components/schemas/EntitlementUtilizationQueryRequest","pointer":"/paths/~1entitlements~1utilizations~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/utilizations/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"},"application/json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"}},"responseCodes":["200","404","417","500"],"pointer":"/entitlements/utilizations/query","href":"entitlement/getsummary","openApiOperationId":"getSummary","summary":"Get Entitlement Utilization Summaries"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/EntitlementUtilizationQueryRequest","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"},"application/json":{"schemaId":"components/schemas/EntitlementUtilizationQueryRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Returns utilization response based on tenant type.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementUtilizationResponse"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementUtilizationResponse"}},"schemaId":"components/schemas/EntitlementUtilizationResponse"},{"code":"404","description":"Tenant not found.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"417","description":"Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1utilizations~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementUtilizationResponse","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementUtilizationResponse"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementUtilizationResponse"}}},{"code":"404","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"417","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/utilizations/query"},{"label":"Get Entitlements","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getentitlements","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getentitlements","metadata":{"seo":{"title":"Get Entitlements","description":"Retrieves all purchased entitlements for the authenticated tenant. Purchased entitlements represent the licenses and subscriptions acquired through purchases. Each entitlement includes details about the license type, SKU, quantity, effective dates, and expiration dates."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlements","name":"Get Entitlements","isWebhook":false,"pointer":"/paths/~1entitlements~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Entitlements","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieves all purchased entitlements for the authenticated tenant. Purchased entitlements represent the licenses and subscriptions acquired through purchases. Each entitlement includes details about the license type, SKU, quantity, effective dates, and expiration dates."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"excludeContent","in":"query","schemaId":"schema_663"}],"pointer":"/paths/~1entitlements~1query/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"},"application/json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"}},"schemaId":"components/schemas/DynamicQueryPayloadDto","pointer":"/paths/~1entitlements~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"excludeContent","in":"query","required":false,"schemaId":"schema_663"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"},"application/json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"}},"responseCodes":["200","404","417","500"],"pointer":"/entitlements/query","href":"entitlement/getentitlements","openApiOperationId":"getEntitlements","summary":"Get Entitlements"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/DynamicQueryPayloadDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"},"application/json":{"schemaId":"components/schemas/DynamicQueryPayloadDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/QueryResponse"},"application/json":{"schemaId":"components/schemas/QueryResponse"}},"schemaId":"components/schemas/QueryResponse"},{"code":"404","description":"Tenant not found.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"417","description":"Cannot display subscription data: entitlement ID is missing. At least one tenant subscription must be active.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/QueryResponse","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/QueryResponse"},"application/json":{"schemaId":"components/schemas/QueryResponse"}}},{"code":"404","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"417","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/query"},{"label":"Query License Mileage Report","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/licensemileagereports","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/licensemileagereports","metadata":{"seo":{"title":"Query License Mileage Report","description":"Mileage reports with detailed tracking of both available entitlement and assignment changes. This API is available for MSP customers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"licenseMileageReports","name":"Query License Mileage Report","isWebhook":false,"pointer":"/paths/~1entitlements~1mileageReports~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query License Mileage Report","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Mileage reports with detailed tracking of both available entitlement and assignment changes. This API is available for MSP customers."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1mileageReports~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/MileageRequestDto"},"application/json":{"schemaId":"components/schemas/MileageRequestDto"}},"schemaId":"components/schemas/MileageRequestDto","pointer":"/paths/~1entitlements~1mileageReports~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/mileageReports/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/MileageRequestDto"},"application/json":{"schemaId":"components/schemas/MileageRequestDto"}},"responseCodes":["200","500"],"pointer":"/entitlements/mileageReports/query","href":"entitlement/licensemileagereports","openApiOperationId":"licenseMileageReports","summary":"Query License Mileage Report"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/MileageRequestDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/MileageRequestDto"},"application/json":{"schemaId":"components/schemas/MileageRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MileageResponseDtoV2"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/MileageResponseDtoV2"}},"schemaId":"components/schemas/MileageResponseDtoV2"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1mileageReports~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/MileageResponseDtoV2","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/MileageResponseDtoV2"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/MileageResponseDtoV2"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/mileageReports/query"},{"label":"Query Entitlement Compliance Status","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getcompliances","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getcompliances","metadata":{"seo":{"title":"Query Entitlement Compliance Status","description":"Retrieves entitlement compliance data that shows whether the tenant's license usage is within authorized limits. Entitlement compliance data provides visibility into license adherence by comparing actual device usage against purchased license quantities. This includes identifying compliant licenses (usage within limits), overallocated licenses (usage exceeds purchased quantity), and underutilized licenses (purchased quantity significantly exceeds usage)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCompliances","name":"Query Entitlement Compliance Status","isWebhook":false,"pointer":"/paths/~1entitlements~1compliances~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query Entitlement Compliance Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves entitlement compliance data that shows whether the tenant's license usage is within authorized limits. Entitlement compliance data provides visibility into license adherence by comparing actual device usage against purchased license quantities. This includes identifying compliant licenses (usage within limits), overallocated licenses (usage exceeds purchased quantity), and underutilized licenses (purchased quantity significantly exceeds usage)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"What the Data Includes"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Compliance status for each license type, total purchased quantities vs. consumed quantities, active device counts by type, license shortfall or surplus amounts, devices at risk of non-compliance, and compliance trends."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1compliances~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/LicenseComplianceRequest"}},"schemaId":"components/schemas/LicenseComplianceRequest","pointer":"/paths/~1entitlements~1compliances~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/compliances/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/LicenseComplianceRequest"}},"responseCodes":["200","404","415","500"],"pointer":"/entitlements/compliances/query","href":"entitlement/getcompliances","openApiOperationId":"getCompliances","summary":"Query Entitlement Compliance Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/LicenseComplianceRequest","mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/LicenseComplianceRequest"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/LicenseComplianceRequest"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v3+json","application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/LicenseComplianceResponseV2"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/LicenseComplianceResponseV2"}},"schemaId":"components/schemas/ConsolidatedLicenseResponse"},{"code":"404","description":"This tenant does not exist.","mediaType":"application/vnd.ruckus.v1.3+json","mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"415","description":"Unsupported Media Type - Feature not enabled for this tenant.","mediaType":"application/vnd.ruckus.v1.3+json","mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v3+json","application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1compliances~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ConsolidatedLicenseResponse","mediaTypes":["application/json","application/vnd.ruckus.v3+json","application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/ConsolidatedLicenseResponse"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/LicenseComplianceResponseV2"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/LicenseComplianceResponseV2"}}},{"code":"404","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"415","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v3+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v3+json","application/vnd.ruckus.v1.3+json","application/vnd.ruckus.v1.2+json","application/vnd.ruckus.v1.1+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v3+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.3+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.1+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/compliances/query"},{"label":"Get Entitlements Banners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getbanners","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/getbanners","metadata":{"seo":{"title":"Get Entitlements Banners","description":"Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getBanners","name":"Get Entitlements Banners","isWebhook":false,"pointer":"/paths/~1entitlements~1banners~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Entitlements Banners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Retrieve entitlement banner data. Banners provide information about entitlements that are either near their expiry or have expired."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1banners~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"},"application/json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"}},"schemaId":"components/schemas/EntitlementBannerRequestDto","pointer":"/paths/~1entitlements~1banners~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/banners/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"},"application/json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"}},"responseCodes":["200","404","500"],"pointer":"/entitlements/banners/query","href":"entitlement/getbanners","openApiOperationId":"getBanners","summary":"Get Entitlements Banners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/EntitlementBannerRequestDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"},"application/json":{"schemaId":"components/schemas/EntitlementBannerRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementBannerResponseDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementBannerResponseDto"}},"schemaId":"components/schemas/EntitlementBannerResponseDto"},{"code":"404","description":"This tenant does not exist.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1banners~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/EntitlementBannerResponseDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/EntitlementBannerResponseDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/EntitlementBannerResponseDto"}}},{"code":"404","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/banners/query"},{"label":"Synchronize entitlements with purchased records","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/syncentitlements","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/entitlement/syncentitlements","metadata":{"seo":{"title":"Synchronize entitlements with purchased records","description":"If RUCKUS One licenses are not up to date with purchased licenses, call this API to sync with purchased records. This API syncs RUCKUS One licenses from purchased entitlements."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"syncEntitlements","name":"Synchronize entitlements with purchased records","isWebhook":false,"pointer":"/paths/~1entitlements/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Synchronize entitlements with purchased records","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"If RUCKUS One licenses are not up to date with purchased licenses, call this API to sync with purchased records. This API syncs RUCKUS One licenses from purchased entitlements."},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"},"application/json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"}},"schemaId":"components/schemas/SyncEntitlementRequestDto","pointer":"/paths/~1entitlements/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/entitlements","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"},"application/json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"}},"responseCodes":["202","404","417","500"],"pointer":"/entitlements","href":"entitlement/syncentitlements","openApiOperationId":"syncEntitlements","summary":"Synchronize entitlements with purchased records"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/SyncEntitlementRequestDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeSchemas":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"},"application/json":{"schemaId":"components/schemas/SyncEntitlementRequestDto"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Sync request accepted. RUCKUS One licenses will be synchronized from purchased records.","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/AcceptedDto"}},"schemaId":"components/schemas/AcceptedDto"},{"code":"404","description":"Tenant not found.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"417","description":"Entitlement ID is missing. At least one tenant subscription must be active.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/AcceptedDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AcceptedDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/AcceptedDto"}}},{"code":"404","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"417","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements"}],"content":{"contentType":"group","meta":{"name":"Entitlement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlement","showPageActions":true},{"nodeType":"markdoc","content":"Entitlement management and license operations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entitlements/utilizations/query","summary":"Get Entitlement Utilization Summaries","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/getsummary","deprecated":false},{"title":"/entitlements/query","summary":"Get Entitlements","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/getentitlements","deprecated":false},{"title":"/entitlements/mileageReports/query","summary":"Query License Mileage Report","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/licensemileagereports","deprecated":false},{"title":"/entitlements/compliances/query","summary":"Query Entitlement Compliance Status","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/getcompliances","deprecated":false},{"title":"/entitlements/banners/query","summary":"Get Entitlements Banners","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement/getbanners","deprecated":false},{"title":"/entitlements","summary":"Synchronize entitlements with purchased records","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entitlement/syncentitlements","deprecated":false}]}]}]}]}},{"type":"group","label":"AvailabilityReport","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/availabilityreport","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/availabilityreport","items":[{"label":"Query License Availability","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/availabilityreport/licenseavailabilityreports","routeSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3/availabilityreport/licenseavailabilityreports","metadata":{"seo":{"title":"Query License Availability","description":"This API allows you to query license availability between two dates or a timeline."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"licenseAvailabilityReports","name":"Query License Availability","isWebhook":false,"pointer":"/paths/~1entitlements~1availabilityReports~1query/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Query License Availability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This API allows you to query license availability between two dates or a timeline."},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"calculatorRequestDto","in":"query","schemaId":"schema_664","required":true}],"pointer":"/paths/~1entitlements~1availabilityReports~1query/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Content-Type","in":"header","schemaId":"schema_662","required":true}],"pointer":"/paths/~1entitlements~1availabilityReports~1query/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"}},"schemaId":"components/schemas/CalculatorRequestDtoV2","pointer":"/paths/~1entitlements~1availabilityReports~1query/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/entitlements/availabilityReports/query","servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"parameters":{"path":[],"query":[{"name":"calculatorRequestDto","in":"query","required":true,"schemaId":"components/schemas/CalculatorRequestDtoBase"}],"querystring":[],"header":[{"name":"Content-Type","in":"header","required":true,"schemaId":"schema_662"}],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"}},"responseCodes":["200","403","500"],"pointer":"/entitlements/availabilityReports/query","href":"availabilityreport/licenseavailabilityreports","openApiOperationId":"licenseAvailabilityReports","summary":"Query License Availability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}],"schemaId":"components/schemas/CalculatorRequestDtoV2","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/CalculatorRequestDtoV2"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"success.","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/CalculatorResponseDtoV2"},"application/json":{"schemaId":"components/schemas/CalculatorResponseDtoV2"}},"schemaId":"components/schemas/CalculatorResponseDtoV2"},{"code":"403","description":"Access Denied","mediaType":"application/vnd.ruckus.v1.2+json","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}},"schemaId":"components/schemas/RestApiErrorDto"},{"code":"500","description":"Internal Server Error","mediaType":"application/json","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}},"schemaId":"components/schemas/ErrorDto"}],"pointer":"/paths/~1entitlements~1availabilityReports~1query/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/CalculatorResponseDtoV2","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/CalculatorResponseDtoV2"},"application/json":{"schemaId":"components/schemas/CalculatorResponseDtoV2"}}},{"code":"403","schemaId":"components/schemas/RestApiErrorDto","mediaTypes":["application/vnd.ruckus.v1.2+json","application/json"],"mediaTypeContent":{"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/RestApiErrorDto"},"application/json":{"schemaId":"components/schemas/RestApiErrorDto"}}},{"code":"500","schemaId":"components/schemas/ErrorDto","mediaTypes":["application/json","application/vnd.ruckus.v1.2+json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ErrorDto"},"application/vnd.ruckus.v1.2+json":{"schemaId":"components/schemas/ErrorDto"}}}],"examples":[]}]}]}]},"httpPath":"/entitlements/availabilityReports/query"}],"content":{"contentType":"group","meta":{"name":"AvailabilityReport"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AvailabilityReport","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/entitlements/availabilityReports/query","summary":"Query License Availability","prefix":{"name":"post","color":"post"},"badges":[],"link":"/availabilityreport/licenseavailabilityreports","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/DynamicQueryPayloadFilterDto":{"id":"components/schemas/DynamicQueryPayloadFilterDto","kind":"json-schema","title":"DynamicQueryPayloadFilterDto","data":{"type":"object","description":"Filter criteria for dynamic queries including field selections, value filters, and query parameters.","properties":{"licenseType":{"type":"array","description":"The list of entitlement types.","example":["APSW"],"items":{"type":"string"},"uniqueItems":true},"isTrial":{"type":"boolean","description":"Flag indicating if summary is for trial or not.","example":false},"status":{"type":"array","description":"The list of status.","example":["VALID"],"items":{"type":"string"},"uniqueItems":true},"expirationDateRange":{"$ref":"#/components/schemas/ExpirationDateRange","description":"Expiration date range relative to today."},"sku":{"type":"array","description":"A list of SKU patterns in regular expression.","example":"[A-Z]+-[A-Z]+-[A-Z]+-[A-Z]+[0-9]$","items":{"type":"string"},"uniqueItems":true},"skuTier":{"type":"array","description":"A list of SKU tiers.","example":"Platinum, Gold, Silver","items":{"type":"string"},"uniqueItems":true}}}},"components/schemas/EntitlementUtilizationQueryRequest":{"id":"components/schemas/EntitlementUtilizationQueryRequest","kind":"json-schema","title":"EntitlementUtilizationQueryRequest","data":{"type":"object","description":"Request object for querying entitlement utilization data with configurable filter criteria.","properties":{"filters":{"$ref":"#/components/schemas/DynamicQueryPayloadFilterDto","description":"Filter criteria for querying entitlement utilization."}}}},"components/schemas/ExpirationDateRange":{"id":"components/schemas/ExpirationDateRange","kind":"json-schema","title":"ExpirationDateRange","data":{"type":"object","description":"Date range criteria for filtering entitlements based on expiration dates, supporting both past expired and future expiring time frames.","properties":{"lastExpiredDays":{"type":"integer","format":"int32","description":"The last number of days in which entitlements have expired.","example":30},"nextExpiringDays":{"type":"integer","format":"int32","description":"The next number of days in which entitlements will expire.","example":60}}}},"components/schemas/EntitlementUtilizationResponse":{"id":"components/schemas/EntitlementUtilizationResponse","kind":"json-schema","title":"EntitlementUtilizationResponse","data":{"type":"object","description":"Entitlement utilization response containing license usage summaries","properties":{"data":{"type":"array","description":"List of entitlement utilization summaries grouped by license type","items":{"$ref":"#/components/schemas/EntitlementUtilizationSummary"}}},"required":["data"]}},"components/schemas/EntitlementUtilizationSummary":{"id":"components/schemas/EntitlementUtilizationSummary","kind":"json-schema","title":"EntitlementUtilizationSummary","data":{"type":"object","description":"Entitlement utilization summary showing license quantities and usage","properties":{"licenseType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License type (APSW for Device Networking or SLTN_TOKEN for AddOn Solutions)"},"children":[]}]}]}],"example":"APSW"},"isTrial":{"type":"boolean","description":"Indicates if this entry represents trial licenses (true) or paid licenses (false). For non-MSP/VAR tenants, this is always false as trial and paid are combined.","example":false},"quantity":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total quantity of licenses available (paid + courtesy for MSP/VAR, or combined for non-MSP/VAR)"},"children":[]}]}]}],"example":1025},"courtesyQuantity":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Courtesy quantity. Only present for MSP/VAR tenants with paid licenses (isTrial=false). Not applicable for trial licenses."},"children":[]}]}]}],"example":230},"remainingQuantity":{"type":"integer","format":"int64","description":"Remaining quantity available for use","example":793},"selfUsage":{"type":"integer","format":"int64","description":"Number of licenses used by the tenant's own account","example":232},"mspCustomerUsage":{"type":"integer","format":"int64","description":"Number of licenses assigned to MSP customers. Only present for MSP/VAR tenants.","example":0}},"required":["isTrial","licenseType","quantity","remainingQuantity","selfUsage"]}},"components/schemas/RestApiErrorDto":{"id":"components/schemas/RestApiErrorDto","kind":"json-schema","title":"RestApiErrorDto","data":{"type":"object","description":"Error response containing detailed error information including error codes, messages, reasons, and suggestions for resolution.","properties":{"code":{"type":"string","description":"Unique error code identifying the specific type of error that occurred."},"message":{"type":"string","description":"Human-readable error message providing details about what went wrong."},"reason":{"type":"string","description":"Detailed explanation of why the error occurred, providing additional context."},"suggestion":{"type":"string","description":"Actionable suggestion or recommendation for how to resolve or avoid this error."}}}},"components/schemas/ErrorDto":{"id":"components/schemas/ErrorDto","kind":"json-schema","title":"ErrorDto","data":{"type":"object","description":"Error response containing request identifier and detailed error information.","properties":{"requestId":{"type":"string","description":"Unique identifier for the request that generated this error, used for tracking and debugging purposes."},"error":{"$ref":"#/components/schemas/RestApiErrorDto","description":"Detailed error information including error codes and messages."}}}},"components/schemas/DynamicQueryPayloadDto":{"id":"components/schemas/DynamicQueryPayloadDto","kind":"json-schema","title":"DynamicQueryPayloadDto","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Query payload for dynamic data retrieval supporting pagination, sorting, filtering, and field selection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": controls which subset of results to return:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"page"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": page number to retrieve (default: 1)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pageSize"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": number of records per page (default: 20)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"page\": 2, \"pageSize\": 50}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" retrieves records 51-100"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": orders results by a specific field:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortField"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": name of the field to sort by (e.g., 'expirationDate', 'sku', 'quantity')"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sortOrder"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": direction, either 'ASC (ascending)' or 'DESC (descending)'"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"sortField\": \"expirationDate\", \"sortOrder\": \"ASC\"}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sorts by earliest expiration first"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field selection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": specifies which fields to include in the response, reducing payload size:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fields"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": array of field names to return"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"example: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{\"fields\": [\"id\", \"sku\", \"quantity\"]}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns only these three fields"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filtering"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": narrows results based on specific criteria via the filters object (see DynamicQueryPayloadFilterDto for available filter options)."},"children":[]}]}]}],"properties":{"defaultPageSize":{"type":"integer","format":"int32","description":"Default number of records per page to use when pageSize is not explicitly specified or is invalid."},"sortField":{"type":"string","description":"Field name to use for sorting the query results in ascending or descending order."},"sortOrder":{"type":"string","description":"Sort order direction for the specified sort field, typically 'ASC' for ascending or 'DESC' for descending."},"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32","description":"Number of records to return per page for pagination, with automatic fallback to default if invalid."},"fields":{"type":"array","description":"Set of specific field names to include in the query response, enabling selective data retrieval.","items":{"type":"string"},"uniqueItems":true},"filters":{"$ref":"#/components/schemas/DynamicQueryPayloadFilterDto","description":"Filter criteria object containing various conditions to narrow down query results based on specific parameters."}}}},"components/schemas/HttpMethod":{"id":"components/schemas/HttpMethod","kind":"json-schema","title":"HttpMethod","data":{"description":"Hypertext transfer protocol method used for application programming interface calls.","enum":["GET","HEAD","POST","PUT","PATCH","DELETE","OPTIONS","TRACE"]}},"components/schemas/QueryResponse":{"id":"components/schemas/QueryResponse","kind":"json-schema","title":"QueryResponse","data":{"type":"object","description":"Generic query response containing paginated data results with metadata such as total count, page information, and field selections.","properties":{"fields":{"type":"array","description":"Set of field names that were requested to be included in the response data.","items":{"type":"string"},"uniqueItems":true},"totalCount":{"type":"integer","format":"int64","description":"Total number of records available that match the query criteria, used for pagination calculations."},"page":{"type":"integer","format":"int32"},"pageSize":{"type":"integer","format":"int32","description":"Maximum number of records returned in this response page."},"objectId":{"type":"string","description":"Unique identifier for the primary object or entity associated with this query response."},"data":{"type":"array","items":{}},"errors":{"type":"array","description":"List of errors that occurred during processing, if any.","items":{"$ref":"#/components/schemas/ErrorDto"}},"subsequentQueries":{"type":"array","description":"List of additional API calls that can be made to retrieve related or supplementary data.","items":{"$ref":"#/components/schemas/SubsequentQuery"}}}}},"components/schemas/SubsequentQuery":{"id":"components/schemas/SubsequentQuery","kind":"json-schema","title":"SubsequentQuery","data":{"type":"object","description":"Query definition for subsequent API calls that can be made to retrieve additional or related data.","properties":{"fields":{"type":"array","description":"List of specific field names to be included in the subsequent API call response.","items":{"type":"string"}},"url":{"type":"string","format":"uri","description":"Target URL endpoint for the subsequent API call."},"httpMethod":{"$ref":"#/components/schemas/HttpMethod","description":"Hypertext transfer protocol method used for application programming interface calls."},"payload":{"description":"Request body data to be sent with the subsequent API call, if required by the HTTP method."}}}},"components/schemas/CalculatorFilterRequestDto":{"id":"components/schemas/CalculatorFilterRequestDto","kind":"json-schema","title":"CalculatorFilterRequestDto","data":{"type":"object","description":"Request object containing filter criteria for entitlement calculations including usage type and license type parameters.","properties":{"licenseType":{"type":"string","description":"Type of entitlement license to calculate.","example":"APSW"},"isTrial":{"type":"boolean","description":"Indicates whether to calculate availability for trial/temporary licenses. When true, the calculation considers only trial license entitlements which are typically temporary evaluation licenses. When false, the calculation considers standard purchased licenses. This flag helps distinguish between trial and production license availability in the entitlement calculation.","example":true}},"required":["licenseType"]}},"components/schemas/MileageRequestDto":{"id":"components/schemas/MileageRequestDto","kind":"json-schema","title":"MileageRequestDto","data":{"type":"object","description":"Request payload for license mileage calculations.","properties":{"page":{"type":"integer","format":"int32","description":"The page number to be returned, 1 based, default 1.","example":1},"pageSize":{"type":"integer","format":"int32","description":"The page number to be returned, default 20.","example":30},"filters":{"$ref":"#/components/schemas/CalculatorFilterRequestDto","description":"Filter criteria for the request."}},"required":["filters"]}},"components/schemas/LicenseBreakUpDtoV2":{"id":"components/schemas/LicenseBreakUpDtoV2","kind":"json-schema","title":"LicenseBreakUpDtoV2","data":{"type":"object","description":"Enhanced license breakdown information tracking both entitlement and assignment quantities at specific event dates.","properties":{"eventDate":{"type":"string","description":"Date and time (UTC) when this event or snapshot occurred.","example":"Wed Nov 08 23:59:59 UTC 2045"},"entitlementQuantity":{"type":"integer","format":"int64","description":"Total entitlement quantity available at this date.","example":300},"assignedQuantity":{"type":"integer","format":"int64","description":"Total quantity assigned to sub-tenants at this date.","example":274},"selfUsageQuantity":{"type":"integer","format":"int64","description":"Self-usage quantity consumed by own devices (remains constant throughout the month).","example":50},"availableQuantity":{"type":"integer","format":"int64","description":"Available quantity calculated as: entitlementQuantity - assignedQuantity - selfUsageQuantity","example":26}}}},"components/schemas/MileageDataDtoV2":{"id":"components/schemas/MileageDataDtoV2","kind":"json-schema","title":"MileageDataDtoV2","data":{"type":"object","description":"Enhanced mileage data object containing license usage information with detailed event tracking for both entitlement and assignment changes.","properties":{"licenseType":{"type":"string","description":"Type of the license.","example":"APSW"},"lastDate":{"type":"string","description":"Last date and time (UTC) of the month (end of day).","example":"Fri Feb 28 23:59:59 UTC 2026"},"selfUsageQuantity":{"type":"integer","format":"int64","description":"Self-usage quantity consumed by own devices at the end of the month.","example":50},"quantity":{"type":"integer","format":"int64","description":"Total entitlement quantity available at the end of the month.","example":300},"assignedQuantity":{"type":"integer","format":"int64","description":"Total quantity assigned to sub-tenants at the end of the month.","example":274},"availableBreakUp":{"type":"array","description":"Detailed breakdown of license events within the month, tracking changes to both entitlements and assignments.","items":{"$ref":"#/components/schemas/LicenseBreakUpDtoV2"}},"isTrial":{"type":"boolean","description":"Indicates whether this mileage data represents trial/temporary license usage. Trial licenses are temporary evaluation licenses that allow customers to test functionality before purchasing. When true, the mileage data tracks trial license consumption; when false, it tracks standard purchased license usage. This distinction is important for reporting and billing purposes.","example":false}},"required":["isTrial","lastDate","licenseType"]}},"components/schemas/MileageResponseDtoV2":{"id":"components/schemas/MileageResponseDtoV2","kind":"json-schema","title":"MileageResponseDtoV2","data":{"type":"object","description":"Enhanced response object containing mileage report data with detailed event tracking for both entitlement and assignment changes.","properties":{"status":{"type":"string","description":"Status of the response.","example":"success"},"message":{"type":"string","description":"Message providing additional details about the response.","example":"Object created/updated successfully."},"page":{"type":"integer","format":"int32","description":"Current page number in the paginated result set."},"pageSize":{"type":"integer","format":"int32","description":"Number of records returned per page for pagination control."},"totalCount":{"type":"integer","format":"int64","description":"Total number of records available across all pages."},"data":{"type":"array","description":"Enhanced mileage data containing detailed event tracking.","items":{"$ref":"#/components/schemas/MileageDataDtoV2"}}}}},"components/schemas/LicenseComplianceFilter":{"id":"components/schemas/LicenseComplianceFilter","kind":"json-schema","title":"LicenseComplianceFilter","data":{"type":"object","description":"Filter criteria for license compliance queries including license types and compliance status parameters.","properties":{"licenseType":{"type":"array","description":"Set of license type identifiers to filter compliance results by specific entitlement categories.","items":{"type":"string"},"uniqueItems":true}}}},"components/schemas/LicenseComplianceRequest":{"id":"components/schemas/LicenseComplianceRequest","kind":"json-schema","title":"LicenseComplianceRequest","data":{"type":"object","description":"Request object for license compliance queries containing filter criteria and configuration options.","properties":{"filters":{"$ref":"#/components/schemas/LicenseComplianceFilter","description":"Filter criteria object containing parameters to narrow down compliance query results based on license types and status."}}}},"components/schemas/AccountUsageSummary":{"id":"components/schemas/AccountUsageSummary","kind":"json-schema","title":"AccountUsageSummary","data":{"type":"object","description":"Account usage summary containing detailed breakdown of device/solution usage","properties":{"usedSummary":{"type":"array","description":"List of usage summaries broken down by device or solution type","items":{"$ref":"#/components/schemas/DeviceUsageSummary"}},"totalConfigured":{"type":"integer","format":"int64","description":"Total number of devices/solutions currently configured across all types","example":140},"totalLicensesUsed":{"type":"integer","format":"int64","description":"Total number of licenses currently being used across all types","example":148}},"required":["totalLicensesUsed","usedSummary"]}},"components/schemas/ActiveLicensesBlock":{"id":"components/schemas/ActiveLicensesBlock","kind":"json-schema","title":"ActiveLicensesBlock","data":{"type":"object","description":"Active licenses information including paid and trial licenses with expiration details","properties":{"paid":{"$ref":"#/components/schemas/LicenseTypeBreakdown","description":"Paid license breakdown with total count and expiration information"},"trial":{"$ref":"#/components/schemas/LicenseTypeBreakdown","description":"Trial license breakdown with total count and expiration information"}}}},"components/schemas/ConsolidatedLicenseResponse":{"id":"components/schemas/ConsolidatedLicenseResponse","kind":"json-schema","title":"ConsolidatedLicenseResponse","data":{"type":"object","description":"Consolidated licensing summary response supporting Summary, MSP Customers, and My Account UI tabs","properties":{"data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of license summaries grouped by license type (APSW and SLTN_TOKEN)"},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/ConsolidatedLicenseSummary"}}},"required":["data"]}},"components/schemas/ConsolidatedLicenseSummary":{"id":"components/schemas/ConsolidatedLicenseSummary","kind":"json-schema","title":"ConsolidatedLicenseSummary","data":{"type":"object","description":"Consolidated license summary for a specific license type supporting Summary, MSP Customers, and My Account UI tabs","properties":{"licenseType":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"License type (APSW for Device Networking or SLTN_TOKEN for AddOn Solutions)"},"children":[]}]}]}],"example":"APSW"},"activeLicenses":{"$ref":"#/components/schemas/ActiveLicensesBlock","description":"Active licenses information with paid and trial breakdown including expiration details"},"licensesUsed":{"$ref":"#/components/schemas/LicensesUsedBlock","description":"Licenses used breakdown by self account (paid/trial) and MSP customers (paid/extendedTrial)"},"licensesAvailable":{"$ref":"#/components/schemas/LicensesAvailableBlock","description":"Licenses available breakdown for self account and MSP customer assignments"},"outOfCompliance":{"$ref":"#/components/schemas/OutOfComplianceBlock","description":"Out-of-compliance breakdown by self account and MSP customers"},"self":{"$ref":"#/components/schemas/AccountUsageSummary","description":"Device/solution usage summary for the account's own usage (self)"},"mspEcSummary":{"$ref":"#/components/schemas/AccountUsageSummary","description":"Aggregated device/solution usage summary for all MSP enterprise customers"}},"required":["licenseType","self"]}},"components/schemas/DeviceUsageSummary":{"id":"components/schemas/DeviceUsageSummary","kind":"json-schema","title":"DeviceUsageSummary","data":{"type":"object","description":"Usage summary for a specific device or solution type showing configured and licenses required","properties":{"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Device or solution type (e.g., WIFI, SWITCH, SLTN_PMS_INTEGRATION)"},"children":[]}]}]}],"example":"WIFI"},"installedCount":{"type":"integer","format":"int64","description":"Number of devices/solutions currently configured (installed count)","example":126},"licensesUsed":{"type":"integer","format":"int64","description":"Number of licenses required/used for this device type","example":126}},"required":["installedCount","licensesUsed","type"]}},"components/schemas/LicenseTypeBreakdown":{"id":"components/schemas/LicenseTypeBreakdown","kind":"json-schema","title":"LicenseTypeBreakdown","data":{"type":"object","description":"License breakdown showing total count and next expiration details","properties":{"total":{"type":"integer","format":"int64","description":"Total number of active licenses of this type (includes courtesy for paid)","example":210},"courtesyQty":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Courtesy quantity (5% bonus for paid licenses only, 0 for trial)"},"children":[]}]}]}],"example":10},"nextExpirationDate":{"type":"string","description":"Next (soonest) expiration date","example":"Wed Nov 08 23:59:59 GMT 2045"},"nextExpiringCount":{"type":"integer","format":"int64","description":"Count of licenses expiring on the next expiration date","example":50}}}},"components/schemas/LicensesAvailableBlock":{"id":"components/schemas/LicensesAvailableBlock","kind":"json-schema","title":"LicensesAvailableBlock","data":{"type":"object","description":"Licenses available information broken down by self account and MSP customers","properties":{"self":{"$ref":"#/components/schemas/SelfAvailableCount","description":"Licenses available to own account (self) broken down by paid and trial"},"mspCustomers":{"$ref":"#/components/schemas/MspCustomersAvailableCount","description":"Licenses available to assign to MSP customers broken down by paid and extended trial"}}}},"components/schemas/LicensesUsedBlock":{"id":"components/schemas/LicensesUsedBlock","kind":"json-schema","title":"LicensesUsedBlock","data":{"type":"object","description":"Licenses used information broken down by self account and MSP customers","properties":{"self":{"$ref":"#/components/schemas/SelfUsageCount","description":"Licenses used by own account (self) broken down by paid and trial"},"mspCustomers":{"$ref":"#/components/schemas/MspCustomersUsageCount","description":"Licenses assigned to active MSP customers broken down by paid and extended trial"}}}},"components/schemas/MspCustomersAvailableCount":{"id":"components/schemas/MspCustomersAvailableCount","kind":"json-schema","title":"MspCustomersAvailableCount","data":{"type":"object","description":"MSP Customers available licenses breakdown showing paid and extended trial availability","properties":{"paid":{"type":"integer","format":"int64","description":"Number of paid licenses available to assign to MSP customers","example":0},"extendedTrial":{"type":"integer","format":"int64","description":"Number of extended trial licenses available to assign to MSP customers","example":0},"total":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total licenses available to assign to MSP customers (paid + extendedTrial)"},"children":[]}]}]}],"example":0}}}},"components/schemas/MspCustomersOutOfComplianceCount":{"id":"components/schemas/MspCustomersOutOfComplianceCount","kind":"json-schema","title":"MspCustomersOutOfComplianceCount","data":{"type":"object","description":"MSP Customers out-of-compliance breakdown by paid, extended trial, and expired services","properties":{"paid":{"type":"integer","format":"int64","description":"Out-of-compliance count for MSP customers on paid licenses","example":0},"extendedTrial":{"type":"integer","format":"int64","description":"Out-of-compliance count for MSP customers on extended trial licenses","example":0},"expiredServices":{"type":"integer","format":"int64","description":"Out-of-compliance count for MSP customers with expired services","example":0},"total":{"type":"integer","format":"int64","description":"Total out-of-compliance count for all MSP customers","example":0}}}},"components/schemas/MspCustomersUsageCount":{"id":"components/schemas/MspCustomersUsageCount","kind":"json-schema","title":"MspCustomersUsageCount","data":{"type":"object","description":"MSP Customers usage breakdown showing paid and extended trial license consumption","properties":{"paid":{"type":"integer","format":"int64","description":"Number of paid licenses assigned to MSP customers","example":0},"extendedTrial":{"type":"integer","format":"int64","description":"Number of extended trial licenses assigned to MSP customers","example":0},"total":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total licenses assigned to MSP customers (paid + extendedTrial)"},"children":[]}]}]}],"example":0}}}},"components/schemas/OutOfComplianceBlock":{"id":"components/schemas/OutOfComplianceBlock","kind":"json-schema","title":"OutOfComplianceBlock","data":{"type":"object","description":"License out-of-compliance information broken down by self account and MSP customers","properties":{"self":{"$ref":"#/components/schemas/SelfOutOfComplianceCount","description":"Out-of-compliance count for own account (self)"},"mspCustomers":{"$ref":"#/components/schemas/MspCustomersOutOfComplianceCount","description":"Out-of-compliance breakdown for MSP customers by paid, extended trial, and expired services"},"total":{"type":"integer","format":"int64","description":"Total out-of-compliance count across self and MSP customers","example":95}}}},"components/schemas/SelfAvailableCount":{"id":"components/schemas/SelfAvailableCount","kind":"json-schema","title":"SelfAvailableCount","data":{"type":"object","description":"Self account available licenses breakdown showing paid and trial availability","properties":{"paid":{"type":"integer","format":"int64","description":"Number of paid licenses available to own account","example":40},"trial":{"type":"integer","format":"int64","description":"Number of trial licenses available to own account","example":80},"total":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total licenses available to own account (paid + trial)"},"children":[]}]}]}],"example":120}}}},"components/schemas/SelfOutOfComplianceCount":{"id":"components/schemas/SelfOutOfComplianceCount","kind":"json-schema","title":"SelfOutOfComplianceCount","data":{"type":"object","description":"Self account out-of-compliance count for paid and trial licenses combined","properties":{"total":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total out-of-compliance count for own account (paid + trial)"},"children":[]}]}]}],"example":95}}}},"components/schemas/SelfUsageCount":{"id":"components/schemas/SelfUsageCount","kind":"json-schema","title":"SelfUsageCount","data":{"type":"object","description":"Self account usage breakdown showing paid and trial license consumption","properties":{"paid":{"type":"integer","format":"int64","description":"Number of paid licenses used by own account","example":70},"trial":{"type":"integer","format":"int64","description":"Number of trial licenses used by own account","example":30},"total":{"type":"integer","format":"int64","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Total licenses used by own account (paid + trial)"},"children":[]}]}]}],"example":100}}}},"components/schemas/DeviceCompliance":{"id":"components/schemas/DeviceCompliance","kind":"json-schema","title":"DeviceCompliance","data":{"type":"object","description":"Device compliance information showing license usage compared to installed device counts for specific device types.","properties":{"deviceType":{"type":"string","description":"Type of device for which compliance is being reported, determining applicable license requirements.","enum":["IOT_CTRL","UNASSIGNED_DEVICE_TYPE","WIFI","LTE","SWITCH","ANALYTICS","RWG","EDGE","VIRTUAL_EDGE","APSW","EDGE_SECS","EDGE_SECL","SLTN_PIN_FOR_IDENTITY","SLTN_TOKEN","SLTN_PMS_INTEGRATION","SLTN_URL_FILTERING","NOKIA_OLTS"]},"installedDeviceCount":{"type":"integer","format":"int64","description":"Total number of devices of this type that are currently installed and active in the system."},"usedLicenseCount":{"type":"integer","format":"int64","description":"Number of licenses currently consumed or allocated for this device type to ensure compliance."}}}},"components/schemas/LicenseComplianceResponseV2":{"id":"components/schemas/LicenseComplianceResponseV2","kind":"json-schema","title":"LicenseComplianceResponseV2","data":{"type":"object","description":"Version 2 response object containing license compliance information for multiple tenants with enhanced compliance details.","properties":{"compliances":{"type":"array","description":"List of tenant specific license compliance information including usage metrics, device counts, and compliance status for each tenant.","items":{"$ref":"#/components/schemas/TenantLicenseComplianceV2"}}}}},"components/schemas/LicenseComplianceV2":{"id":"components/schemas/LicenseComplianceV2","kind":"json-schema","title":"LicenseComplianceV2","data":{"type":"object","description":"Version 2 license compliance information extending base compliance data with enhanced expiration date tracking for both paid and trial licenses.","properties":{"licenseType":{"type":"string","description":"Type of license being tracked for compliance, determining the applicable rules and usage restrictions.","enum":["UNKNOWN","APSW","URLF","EDGE_SECS","EDGE_SECL","SLTN_TOKEN"]},"tenantId":{"type":"string","description":"Unique identifier of the tenant for which license compliance information is being reported."},"tenantName":{"type":"string","description":"Human-readable name of the tenant associated with the license compliance data."},"deviceCompliances":{"type":"array","description":"List of device compliance details showing license usage breakdown by device type.","items":{"$ref":"#/components/schemas/DeviceCompliance"}},"totalActivePaidLicenseCount":{"type":"integer","format":"int64","description":"Total number of currently active paid licenses available for this tenant."},"totalActiveTrialLicenseCount":{"type":"integer","format":"int64","description":"Total number of currently active trial licenses available for this tenant."},"totalActivePaidAssignedLicenseCount":{"type":"integer","format":"int64","description":"Total number of active paid licenses assigned by this MSP tenant (always zero for REC accounts)."},"totalActiveTrialAssignedLicenseCount":{"type":"integer","format":"int64","description":"Total number of active trial licenses assigned by this MSP tenant (always zero for REC accounts)."},"nextTotalPaidExpiringLicenseCount":{"type":"integer","format":"int64","description":"Total number of paid licenses that will expire in the next period, used for expiration planning and renewal notifications."},"nextTotalTrialExpiringLicenseCount":{"type":"integer","format":"int64","description":"Total number of trial licenses that will expire in the next period, used for trial expiration tracking and conversion planning."},"complianceType":{"type":"string","description":"Type of compliance reporting context, indicating whether this is for MSP summary or individual account compliance tracking.","enum":["SELF","MSP_SUMMARY"]},"totalMspEcPaidAssignedLicenseCount":{"type":"integer","format":"int64","description":"Total number of paid licenses assigned to MSP enterprise customers, applicable when consolidated SKU is enabled."},"totalMspEcTrialAssignedLicenseCount":{"type":"integer","format":"int64","description":"Total number of trial licenses assigned to MSP enterprise customers, applicable when consolidated SKU is enabled."},"paidLicenseGapForMspEcs":{"type":"integer","format":"int64","description":"License gap specifically for MSP enterprise customers paid licenses, showing remaining paid license capacity for customer assignments."},"trialLicenseGapForMspEcs":{"type":"integer","format":"int64","description":"License gap specifically for MSP enterprise customers trial licenses, showing remaining trial license capacity for customer assignments."},"consolidatedSkuEnabled":{"type":"boolean","description":"Flag indicating whether consolidated SKU functionality is enabled for this MSP tenant, affecting license allocation calculations."},"extendedTrialEnabled":{"type":"boolean","description":"Flag indicating whether extended trial license functionality is enabled, allowing trial license extensions and enhanced trial management."},"nextPaidExpirationDate":{"type":"string","description":"Date when the next batch of paid licenses will expire, used for proactive renewal planning and license management."},"nextTrialExpirationDate":{"type":"string","description":"Date when the next batch of trial licenses will expire, used for trial conversion planning and customer engagement."},"licensesUsed":{"type":"integer","format":"int64","description":"Total number of licenses currently in use, calculated by summing used license counts across all device compliance records."},"licenseGap":{"type":"integer","format":"int64","description":"Overall license gap calculation considering consolidated SKU settings, compliance type, and license allocation across paid and trial licenses."},"availablePaidLicenseCountForMspEcs":{"type":"integer","format":"int64","description":"Available paid license count for MSP enterprise customers, calculated as the maximum of zero or the paid license gap."},"availableTrialLicenseCountForMspEcs":{"type":"integer","format":"int64","description":"Available trial license count for MSP enterprise customers, calculated based on extended trial configuration and trial license gap."},"availableLicenseCountForMyAccount":{"type":"integer","format":"int64","description":"License gap for the account itself, representing available license capacity for direct tenant usage."}}}},"components/schemas/TenantLicenseComplianceV2":{"id":"components/schemas/TenantLicenseComplianceV2","kind":"json-schema","title":"TenantLicenseComplianceV2","data":{"type":"object","description":"Tenant specific license compliance information containing both self managed and MSP enterprise customer summary data for a particular license type.","properties":{"licenseType":{"type":"string","description":"Type of license for which compliance information is being reported within this tenant context.","enum":["UNKNOWN","APSW","URLF","EDGE_SECS","EDGE_SECL","SLTN_TOKEN"]},"self":{"$ref":"#/components/schemas/LicenseComplianceV2","description":"License compliance information for the tenant's own account and direct usage."},"mspEcSummary":{"$ref":"#/components/schemas/LicenseComplianceV2","description":"Summary compliance information for MSP enterprise customers managed by this tenant (null for SELF compliance type)."}}}},"components/schemas/EntitlementBannerRequestDto":{"id":"components/schemas/EntitlementBannerRequestDto","kind":"json-schema","title":"EntitlementBannerRequestDto","data":{"type":"object","description":"Request data transfer object for entitlement banner operations, containing filtering criteria to determine which license types should be displayed in banner notifications.","properties":{"filters":{"$ref":"#/components/schemas/Filters","description":"Filter criteria for determining which entitlement banners to display, containing license type specifications and usage type preferences."}}}},"components/schemas/Filters":{"id":"components/schemas/Filters","kind":"json-schema","title":"Filters","data":{"type":"object","description":"Filter criteria used to determine which entitlement banners should be displayed based on license type and usage preferences.","properties":{"licenseType":{"type":"array","description":"List of license types to filter entitlement banners for, determining which specific license categories should be included in banner notifications.","items":{"type":"string"}},"usageType":{"type":"string","deprecated":true,"description":"Usage type filter for banner display, specifying whether to show banners for self managed or assigned licenses; defaults to SELF and is deprecated in V2."}}}},"components/schemas/EntitlementBannerInfo":{"id":"components/schemas/EntitlementBannerInfo","kind":"json-schema","title":"EntitlementBannerInfo","data":{"type":"object","description":"Individual entitlement banner information containing license notification details, expiration dates, and usage statistics for display purposes.","properties":{"type":{"type":"string"},"multipleLicense":{"type":"boolean","description":"Indicates whether the banner notification applies to multiple license types or a single license category."},"effectDate":{"type":"string","description":"Effective date when the banner notification becomes relevant or when the license condition takes effect, formatted as a string."},"effectiveDays":{"type":"integer","format":"int64","description":"Number of days remaining until the license expires or becomes effective, used for countdown notifications."},"licenseCount":{"type":"integer","format":"int32","description":"Total number of licenses affected by this banner notification, indicating the scope of the license condition."},"licenseType":{"type":"string","description":"Type of license that this banner notification applies to, specifying the license category or product."},"usageType":{"type":"string","description":"Usage type classification for the banner notification, typically indicating self managed or assigned license usage patterns."},"message":{"type":"string"}}}},"components/schemas/EntitlementBannerResponseDto":{"id":"components/schemas/EntitlementBannerResponseDto","kind":"json-schema","title":"EntitlementBannerResponseDto","data":{"type":"object","description":"Response containing entitlement banner information with details about license notifications, expiration warnings, and usage alerts.","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementBannerInfo"}}}}},"components/schemas/CalculatorFilterRequestDtoV2":{"id":"components/schemas/CalculatorFilterRequestDtoV2","kind":"json-schema","title":"CalculatorFilterRequestDtoV2","data":{"type":"object","description":"Version 2 of calculator filter request containing criteria for license availability calculations, including usage type, license type filters, and trial license specifications","properties":{"usageType":{"type":"string","description":"Type of usage. Possible values: SELF (default), ASSIGNED, UNKNOWN. Defaults to ASSIGNED when the consolidated feature flag is enabled.","enum":["SELF","ASSIGNED","UNKNOWN"],"example":"ASSIGNED"},"licenseType":{"type":"array","description":"Type of license","example":"APSW","items":{"type":"string"},"uniqueItems":true},"tier":{"type":"string","description":"When set, license pool queries use this SKU/service tier instead of the tenant's stored account tier.","example":"Platinum"},"isTrial":{"type":"boolean","description":"Flag indicating if looking for trial license availability.","example":true}}}},"components/schemas/CalculatorRequestDtoV2":{"id":"components/schemas/CalculatorRequestDtoV2","kind":"json-schema","title":"CalculatorRequestDtoV2","data":{"type":"object","description":"Calculator Request V2","properties":{"effectiveDate":{"type":"string","description":"Start date from which the license is valid.","example":"2024-01-22","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"expirationDate":{"type":"string","description":"End date until which the license is valid. Required if operator max quantity is selected.","example":"2025-02-21","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"quantity":{"type":"integer","format":"int32","description":"Number of licenses available. Required if operator max period is selected.","example":5},"operator":{"type":"string","description":"Operator to be used.","enum":["MAX_QUANTITY","MAX_PERIOD"],"example":"MAX_QUANTITY"},"filters":{"$ref":"#/components/schemas/CalculatorFilterRequestDtoV2","description":"Filter criteria for the request."}},"required":["effectiveDate","filters","operator"]}},"components/schemas/CalculatorRequestDtoBase":{"id":"components/schemas/CalculatorRequestDtoBase","kind":"json-schema","title":"CalculatorRequestDtoBase","data":{"type":"object","description":"Calculator Request","properties":{"effectiveDate":{"type":"string","description":"Start date from which the license is valid.","example":"2024-01-22","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"expirationDate":{"type":"string","description":"End date until which the license is valid. Required if operator max quantity is selected.","example":"2025-02-21","pattern":"^\\d{4}-\\d{2}-\\d{2}$"},"quantity":{"type":"integer","format":"int32","description":"Number of licenses available. Required if operator max period is selected.","example":5},"operator":{"type":"string","description":"Operator to be used.","enum":["MAX_QUANTITY","MAX_PERIOD"],"example":"MAX_QUANTITY"}},"required":["effectiveDate","operator"]}},"components/schemas/CalculatorDataDto2":{"id":"components/schemas/CalculatorDataDto2","kind":"json-schema","title":"CalculatorDataDto2","data":{"type":"object","description":"Version 2 of calculator data containing detailed license information including effective dates, expiration dates, quantities, license types, trial status, and SKU tier details","properties":{"effectiveDate":{"type":"string","format":"date-time","description":"Effective date of the license.","example":"Thu Mar 07 00:00:00 GMT 2024"},"expirationDate":{"type":"string","format":"date-time","description":"Expiration date of the license.","example":"Fri Mar 07 23:59:59 GMT 2031"},"quantity":{"type":"integer","format":"int64","description":"Number of licenses","example":5},"licenseType":{"type":"string","description":"Type of license","example":"APSW"},"skuTier":{"type":"string","description":"Sku Tier.","example":"Silver"},"isTrial":{"type":"boolean","description":"Indicates whether this is a trial license.","example":false}},"required":["effectiveDate","isTrial"]}},"components/schemas/CalculatorResponseDtoV2":{"id":"components/schemas/CalculatorResponseDtoV2","kind":"json-schema","title":"CalculatorResponseDtoV2","data":{"type":"object","description":"Version 2 of calculator response containing calculated license availability data with detailed license information, effective dates, and quantities","properties":{"status":{"type":"string","description":"Status of the response.","example":"success"},"message":{"type":"string","description":"Message providing additional details about the response.","example":"Object created/updated successfully."},"data":{"type":"array","description":"List of object containing available license details.","items":{"$ref":"#/components/schemas/CalculatorDataDto2"}}},"required":["data"]}},"components/schemas/SyncEntitlementRequestDto":{"id":"components/schemas/SyncEntitlementRequestDto","kind":"json-schema","title":"SyncEntitlementRequestDto","data":{"type":"object","description":"Request data transfer object for synchronizing entitlement information, containing usage type, status, and refresh type parameters for entitlement synchronization operations.","properties":{"usageType":{"type":"string","deprecated":true,"description":"Usage type for entitlement synchronization, specifying the context of the sync operation; deprecated and not used in V2."},"status":{"type":"string"},"refreshType":{"type":"string","description":"Type of refresh operation to perform during synchronization, determining the scope and method of the entitlement data refresh.","enum":["FULL","DELTA","PAGINATED"],"example":"PAGINATED"}}}},"components/schemas/AcceptedDto":{"id":"components/schemas/AcceptedDto","kind":"json-schema","title":"AcceptedDto","data":{"type":"object","description":"Response object indicating that a request has been accepted for processing, containing tracking information and status details.","properties":{"link":{"type":"string","format":"uri","description":"URI link for tracking or retrieving the status of the accepted request."},"desc":{"type":"string","description":"Human-readable description providing details about the accepted request, its purpose, and expected processing outcome."},"requestId":{"type":"string","description":"Unique identifier assigned to track the accepted request throughout its processing life cycle, enabling status monitoring and correlation with logs."}}}},"schema_662":{"kind":"json-schema","data":{"type":"string"},"id":"schema_662"},"schema_663":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_663"},"schema_664":{"kind":"json-schema","data":{"$ref":"#/components/schemas/CalculatorRequestDtoBase"},"id":"schema_664"}},"exampleStore":{},"securitySchemeStore":{},"servers":[{"url":"https://api.ruckus.cloud","description":"RUCKUS One API host for North American region."},{"url":"https://api.eu.ruckus.cloud","description":"RUCKUS One API host for European region."},{"url":"https://api.asia.ruckus.cloud","description":"RUCKUS One API host for Asian region."}]},"options":{"hideReplay":true,"hideDownloadButtons":false,"codeSamples":{"languages":[{"lang":"Payload"},{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Java"},{"lang":"C#"},{"lang":"PHP"},{"lang":"Go"},{"lang":"Ruby"},{"lang":"R"}]},"downloadUrls":[{"title":"Download PDF","url":"https://docs.ruckus.cloud/static/experimental_apis/entitlement-api-0.2.0-experimental-openapi3.pdf"}],"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true,"position":"off"},"disableRouter":true,"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Entitlements","description":"Overview\n\nThis experimental RUCKUS One Licensing API document describes upcoming behavioral changes to selected licensing endpoints.\n\nWhat This Experimental API Covers\n\n- Consolidated MSP Licensing: RUCKUS One MSP internal licensing is being consolidated so that the MSP own account no longer requires separate REC licenses compared to the MSP licenses used for MSP EC tenants.\n- Current State vs. New Behavior: Historically, REC licenses were required for the MSP own account while MSP licenses were required for MSP ECs. Under the new behavior, MSPs use a unified MSP licensing model across own-account and EC usage.\n\nScope of Impact\n\n- The behavioral changes only affect RUCKUS One MSP customers and are expected to be adopted through newer API versions.\n- The changes do not affect RUCKUS One RECs, but REC customers can also migrate to the newer API versions for additional clarity.\n\nUsage & Compatibility\n\n- These changes are exposed through the v1.2 and v1.3 licensing APIs documented here.\n- Existing clients should review their usage of entitlement and compliance APIs for MSP tenants in light of the unified licensing model.\n\nImportant Notes\n\n- Please follow the RUCKUS One attention notes by going to the RUCKUS One portal and navigating to Subscriptions > Compliance to see when these changes will take effect in your region.\n\nAdditional Information\n\n- If you need more information related to consolidated licensing, refer to https://support.ruckuswireless.com/articles/000015527"}},"baseSlug":"/experimental_apis/entitlement-api-0.2.0-experimental-openapi3","routesMapping":{}}