Dimensions API
Manage the dimensions in your analytic model.
Note: Alpha This API is in alpha. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued. If you are interested in using this API, please contact your
Who can use this feature?
To use the APIs, you must have a Visier account with a profile that has the API capability. If you don't have an account, contact your administrator. They will create an account for you with permissions that allow you to view data.
In addition to an API profile, your API user must have a profile with the following capability:
- Model: Write (access level), API (view level)
- Direct Publish (if ProjectID header is not used)
Not sure if you have this feature or capability? Reach out to your administrator.
Overview
A dimension in Visier is a design object that organizes unique values of an attribute into a list or a hierarchical structure for use as a filter or group by in your solution. Use Visier APIs to create, update, and delete dimensions or retrieve your existing dimensions. For more information about dimensions, see Dimensions.
The Dimensions API improves on the existing dimension-related Data Model API endpoints with the ability to filter your GET requests to specific dimension types or analytic objects, and the option to create, update, delete dimensions.
Note: The Dimensions API is currently limited to leveled dimensions and parent-child dimensions.
You can use the Dimensions API to:
- Retrieve a specific dimension or all dimensions
- Create new dimensions
- Update existing dimensions
- Delete dimension
Tip: If you submit API requests for changes that cause a project to publish to production, each request is individually published to production, resulting in hundreds or thousands of production versions. We recommend that you use the ProjectID request header to make changes in a project. For more information, see Projects API.