Sign in
latestOpenAPI 3.0.32026-08-19299284712.8 KB

67d9f45bb99b

Data Tables

Update Data Table Dimensions

Creates and modifies dimensions tied to a data table

post/data-tables/{data_table_id}/dimensions

Path parameters

data_table_idstring uuid required

Query parameters

flatboolean

Whether or not the POSTed body contains a nested or flat dimensional structure

full_listboolean

Whether or not the full list is provided, if set to True any dimensions not in this list will be marked as disabled

tld_namestring

A TLD name to associate all the provided dimensions with

Headers

X-Company-IDstring required

Associates request with company

Request body

idinteger required
parent_idinteger nullable required
currency_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

numberstring nullable
created_atstring date-time required
{"stackTrail":"components:schemas:SourceDimensionTree:properties:children","oasType":"schema","type":"unknown"}
data_table_idstring uuid required
descriptionstring nullable
requires_mappingboolean required
can_be_sign_flippedboolean required

Response

idinteger required
parent_idinteger nullable required
currency_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

numberstring nullable
created_atstring date-time required
{"stackTrail":"components:schemas:SourceDimensionTree:properties:children","oasType":"schema","type":"unknown"}
data_table_idstring uuid required
descriptionstring nullable
requires_mappingboolean required
can_be_sign_flippedboolean required