Formula

The Formula object. The type code is F.

lastUpdateByName
string <= 255 characters
createdByName
string
typedId
string
lastUpdateDate
string <date-time>
label
string <= 255 characters
formulaNature
string <= 255 characters
version
integer
simulationSet
string <= 255 characters
uniqueName
string <= 255 characters
formulaType
string
Possible values: "PRICING" "WORKFLOW" "LIBRARY"
createdBy
integer
Array of objects
Array
version
integer
typedId
string
elementName
string
elementLabel
string
elementDescription
string
elementGroups
Array of strings
conditionElementName
string
hideWarnings
boolean
excludeFromExport
boolean
protectedExpression
boolean
elementTimeout
integer
displayOptions
integer
formatType
string
Possible values: "NUMERIC" "NUMERIC_LONG" "MONEY" "PERCENT" "TEXT" "MONEY_EUR" "MONEY_USD" "MONEY_GBP" "MONEY_JPY" "MONEY_CHF" "MONEY_PLN" "DATETIME" "DATE" "INTEGER" "LINK" "COMPLEX" "SPARKLINE"
elementSuffix
string
allowOverride
boolean
summarize
boolean
hideOnNull
boolean
userGroup
string
cssProperties
string
resultGroup
string
combinationType
string
Possible values: "ADD" "SUBTRACT" "RESULT" "INFO" "FUNCTION" "BRICK" "PYTHON"
object
message
string
operator
string
threshold
number
comparisonElement
string
redAlert
object
yellowAlert
object
labelTranslations
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
formulaExpression
string
userGroupEdit
string <= 255 characters
userGroupViewDetails
string <= 255 characters
validAfter
string <date>
Array of objects
Array
name
string
label
string
labelTranslations
string
group
string
dataType
string
inputType
string
formatType
string
from
string
to
string
values
string
required
boolean
alwaysEditable
boolean
status
string <= 255 characters
Possible values: "ACTIVE" "SIMULATIONONLY" "INACTIVE"
createDate
string <date-time>
lastUpdateBy
integer
{
  • "lastUpdateByName": "string",
  • "createdByName": "string",
  • "typedId": "string",
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "formulaNature": "string",
  • "version": 0,
  • "simulationSet": "string",
  • "uniqueName": "string",
  • "formulaType": "PRICING",
  • "createdBy": 0,
  • "elements": [
    • {
      • "version": 0,
      • "typedId": "string",
      • "elementName": "string",
      • "elementLabel": "string",
      • "elementDescription": "string",
      • "elementGroups": [
        • "string"
        ],
      • "conditionElementName": "string",
      • "hideWarnings": true,
      • "excludeFromExport": true,
      • "protectedExpression": true,
      • "elementTimeout": 0,
      • "displayOptions": 0,
      • "formatType": "NUMERIC",
      • "elementSuffix": "string",
      • "allowOverride": true,
      • "summarize": true,
      • "hideOnNull": true,
      • "userGroup": "string",
      • "cssProperties": "string",
      • "resultGroup": "string",
      • "combinationType": "ADD",
      • "criticalAlert": {
        • "message": "string",
        • "operator": "string",
        • "threshold": 0,
        • "comparisonElement": "string"
        },
      • "redAlert": { },
      • "yellowAlert": { },
      • "labelTranslations": "string",
      • "createDate": "string",
      • "createdBy": 0,
      • "lastUpdateDate": "string",
      • "lastUpdateBy": 0,
      • "formulaExpression": "string"
      }
    ],
  • "userGroupEdit": "string",
  • "userGroupViewDetails": "string",
  • "validAfter": "2019-08-24",
  • "inputDescriptors": [
    • {
      • "name": "string",
      • "label": "string",
      • "labelTranslations": "string",
      • "group": "string",
      • "dataType": "string",
      • "inputType": "string",
      • "formatType": "string",
      • "from": "string",
      • "to": "string",
      • "values": "string",
      • "required": true,
      • "alwaysEditable": true
      }
    ],
  • "status": "ACTIVE",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastUpdateBy": 0
}