API Root URL
All API sets have the following URL format:
<api-root>/``<domain>``/``<version>``/``...(API-specific suffix)
<api-root>Root endpoint of all REST APIs depends on the type of deployment of CCH Tagetik (On-Premises or Cloud) and, in the case of Cloud service, the chosen authentication mode. See the following paragraphs<domain>the name of the API set, or functionality (e.g.aih,audit, ...)<version>Current version of the API set (v1,v2...). As newer versions of a set of APIs come out, older ones may be deprecated and, in later versions, discontinued. Sets with versionv0are intended to be experimental and may be discontinued in new versions without further notice and without a deprecation period.
On-Premises Environments¶
The <api-root> has the following format
<application url>/api/
where:
<application url>is the same url used to access the web application
Example:
Cloud Environments¶
On some regions of Tagetik Cloud, a new API access service is available that supports various authentication strategies. For information on which regions this service is enabled, please consult the release notes.
In these cases, the <api-root> has the following format
<tenant>.api.saastagetik.com/<authentication strategy>/
where:
<tenant>is the name of the current tenant (e.g.abcprod)<authentication strategystrategy> one amongoauth2,basic,api-keyandjwt, depending on the authentication strategy used. For further information, see section Authentication - Cloud".<domain>the name of the API set, or functionality (e.g. aih, audit, ...)
Example: