Fetch Dimensions:
Fetch a list of all dimension names in the specified application.
API Query: | Dimensions?$select=Name |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions?$select=Name |
API Call Type: | GET |
Fetch Dimensions - detailed:
Fetch a list of all dimensions with expanded detail.
API Query: | Dimensions?$expand=* |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions?$expand=* |
API Call Type: | GET |
Fetch Subsets:
Fetch a list of all subsets within a given dimension.
API Query: | Dimensions('}Subsets_<dimension_name>')/Hierarchies('}Subsets_<dimension_name>')/Elements?$select=Name,Type |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('}Subsets_<dimension_name>')/Hierarchies('}Subsets_<dimension_name>')/Elements?$select=Name,Type |
API Call Type: | GET |
Fetch Elements:
Fetch a list of all element names and data types from a dimension.
API Query: | Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements?$select=Name,Type |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements?$select=Name,Type |
API Call Type: | GET |
Fetch Element Subset:
Fetch a list of all element names and data types from a dimension subset.
API Query: | Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Subsets('<subset_name>')/Elements?$select=Name,Type |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Subsets('<subset_name>')/Elements?$select=Name,Type |
API Call Type: | GET |
Fetch Elements with Attributes:
Fetch a list of all element with their attributes and aliases.
API Query: | Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements |
API Call Type: | GET |
Delete Dimension:
Delete a named dimension.
API Query: | Dimensions('<dimension_name>') |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>') |
API Call Type: | DELETE |
Delete Subset:
Delete a named subset.
API Query: | Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Subsets('<subset_name>') |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Subsets('<subset_name>') |
API Call Type: | DELETE |
Create Dimension:
Create a new dimension.
API Query: | Dimensions |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions |
Post Body: | {"Name":"<dimension_name>","Hierarchies":[{"Name":"<dimension_name>"}]} |
API Call Type: | POST |
Add Element:
Add an element to a dimension with type ('Numeric','String' or 'Consolidated').
API Query: | Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements |
Full URL: | https://<hostname>/tm1/api/<tm1_application>/api/v1/Dimensions('<dimension_name>')/Hierarchies('<dimension_name>')/Elements |
Post Body: | {"Name": "<element_name>", "Type":"<element_type>"} |
API Call Type: | POST |