Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Dimensions

Get Dimensions Tree

This endpoint retrieves the company's dimensions structured in their hierarchy

get/dimensions/tree

Query parameters

can_be_mappedboolean

The result will be limited to dimensions that can be mapped to source systems.

inactiveboolean

The result will also include inactive dimensions.

include_operationsboolean

The result will include data about which operations are allowed against a given dimension (i.e. disable_block_reason, enable_block_reason).

include_tag_membersboolean

The result will also include tag members.

include_tagsboolean

The result will also include tags.

tld_idinteger

The result will be limited to dimensions under this top-level dimension

Headers

X-Company-IDstring required

Associates request with company

Response

The Dimension

idinteger required
parent_idinteger nullable required
namestring required
activeboolean required
status'ENABLED' | 'DISABLING_VALUES' | 'CLEARING_VALUES' | 'VALUES_CLEARED' | 'DISABLED'
  • ENABLED - Enabled
  • DISABLING_VALUES - Disabling Values
  • CLEARING_VALUES - Clearing Values
  • VALUES_CLEARED - Values Cleared
  • DISABLED - Disabled
type'BASIC' | 'FORMULA' | 'TAG'
  • BASIC - Basic
  • FORMULA - Formula
  • TAG - Tag
formulastring required
write_protection'NONE' | 'BLOCK' | 'ACTUALS' | 'AI'
  • NONE - None
  • BLOCK - Block
  • ACTUALS - Actuals
  • AI - AI
positioninteger
special_case_idstring nullable
datestring date nullable
has_childrenboolean
write_block_reasonstring required

If the dimension cannot be written to, return the reason why. Otherwise, return nothing.

Args: obj: The model object to be checked if can be written to.

Returns: str (Optional): The error blocking the dimension from being written to, if one exists

metadatastring nullable