API Custom Dimension

Introduction

CCH Tagetik allows you to manage custom dimensions also via OPEN RESTful APIs.

API title:		Custom Dimension openapi 3.0.3
Description:		API for Account dimension management
Version:		1.000
Authentication:		OAuth2, API Key, JWT, Basic Auth

Prerequisites

In order to use these APIs, the user must authenticate through the authentication mode chosen for [CCH Tagetik].

Moreover, APIs must also be enabled in the Repository. For reverse proxies, further settings are necessary. They can be used with both http and https protocols.

For more details on authentication and enabling, see Enabling the REST API and API Authentication.

Request format: JSON

Response format: JSON

URL

/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}

Http Method	Endpoint	Body of the request	Query string parameters	Body of the answer	HTTP response body	Response Status (Exception)
GET	/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}			Custom dimension	200 (OK)	404 (Not found) 403 (Access to unauthorised resource) 401 (Unauthorised)

Fields in Response

Dataset Field	Supported Values
id	string
descriptions.[lingua]	string
validity.startDate	date
validity.endDate	date
customAttributes	string
updateInfo.user	string
updateInfo.date	date
updateInfo.origin	string

The 'descriptions' field consists of a key-value array where the key is the abbreviated wording of a language and the value is a string

Example of request

Method	GET
Endpoint	/dimensions/v1/{dbID}/{customDimIdentifier}/elements/{id}
Body	-
Example of response	{ "id": "AU", "descriptions": { "en": "Innsbruck", "it": "Innsbruck", "es": "Innsbruck", "fr": "Innsbruck" }, "validity": { "startDate": "2025-11-03T00:00:00.000+0000", "endDate": "2025-11-26T00:00:00.000+0000" }, "customAttributes": null, "updateInfo": { "user": "USER_BS", "date": "2025-11-24T11:29:22.561+0000", "origin": "INPUT_WEB" } }