topic accesstypeoverview QRS API mentioned Experimental in Integration, Extension & APIs

accesstypeoverview QRS API mentioned Experimental

fabdulazeez — Mon, 13 May 2024 05:47:13 GMT

Is it safe to use the "accesstypeoverview" API, considering its stability index is labeled as Experimental and potential modifications? If not, what would be a more suitable API to utilize in production for retrieving license details such as total, available, and allocated licenses for both professional and analyzer types?

Re: accesstypeoverview QRS API mentioned Experimental

Marc — Thu, 23 May 2024 01:54:50 GMT

The API is safe to use with the version of Qlik Sense where it is available. However, the experimental flag indicates that the API may undergo changes, such as modifications to input parameters or output details, or it may be deprecated between versions without prior notice.

If you decide to use an experimental API in your application, be aware that it may break when you apply the next patch or upgrade.

It is important to check the status of the API before performing an upgrade. Consider the criticality of the API to your application, identify possible workarounds, and ensure that it is included in your update or upgrade testing.

https://help.qlik.com/en-US/sense-developer/May2023/Content/Sense_Helpsites/api-governance.htm

Experimental

This API is under development. Do not rely on it. It may change or be removed in future versions.

The AccessTypeOverview API is utilized by the QMC when navigating to `qmc/licenseusagesummary`. Given that there have been no changes in the API schemas over the past three years, it is likely safe to use. However, ensure you have done your due diligence before upgrading or patching to avoid any potential issues.

help.qlik.com/en-US/sense-developer/May2022/APIs/RepositoryServiceAPI/index.html?page=1514

https://help.qlik.com/en-US/sense-developer/May2023/APIs/RepositoryServiceAPI/index.html?page=1555

https://help.qlik.com/en-US/sense-developer/May2024/APIs/RepositoryServiceAPI/index.html?page=1576