FormulaData

The details of the Formula to add to the system.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

formatString

The numerical format mask needed to format values

-

string

dynamicCaption

The script code needed to drive the caption of the formula dynamically

-

string

description

A description for the item

-

string

parentDimension

The name of the data model dimension that this formulated item will be attached to

Y

string

parentHierarchy

The name of the data model hierarchy/attribute within the specified dimension, that this formulated item will be attached to. This is not required for "measures"

-

string

msOlapProps

Additional formula properties specific to OLAP data sources only

-

MSOlapProperties

folderId

The ID of the folder where this item will be stored

Y

string

uuid

tags

Tags for the item that can be used in content searches

-

string [ ]

formulaSyntax

The script syntax of the calculation logic.

Y

string

itemName

The name of the item as it appears in the content system

Y

string

connectionId

The ID of the semantic data model that the item is attached to

Y

string

uuid

id

The id of the item

-

string

uuid

solveOrder

The solve number to drive the order in which the formula is resolved in relation to other formulas used

-

integer

int32

*Required elements are only used for API parameters

Usages
  • /API3/analytics/getFormula
  • /API3/analytics/setFormula