Dimensions

Update Dimension By ID

Update individual fields of a dimension model. NOTE: A dimension can NOT be enabled and disabled via this endpoint. Instead see the Dimension Status endpoint.

post/dimensions/{dimension_id}

Request

Base URL
https://api.cubesoftware.com
Auth
- OAuth 2
  Authorization code: https://portal.cubesoftware.com/o/authorize/
  Token URL: https://api.cubesoftware.com/o/token/
- or none

Path parameters

dimension_idinteger required

The ID of the dimension

Headers

X-Company-IDstring required

Associates request with company

Request body

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

Response

The requested dimension