DMModel

The type code is DMM

reservedWords
Array of strings
isDataModel
boolean
typedId
string
keyFieldNames
Array of strings
object
property name*
additional property
string
lastUpdateDate
string <date-time>
fieldNames
Array of strings
dbTable
string
type
string
Possible values: "DATASOURCE" "DS_VIEW" "DATAMART" "SIM_DATAMART" "FEED" "DW_TABLE" "MODEL" "VIEW" "ROLLUP"
sourceFile
string <= 255 characters
paramsLookupTableName
string
view
boolean
calcItemsLookupTableName
string
legacyParamsLookupTableName
string
legacyCalcItemsLookupTableName
string
userGroupViewDetails
string <= 255 characters
locked
boolean
object
additional property
Array of objects
Array
resultName
string
resultLabel
string
result
string
excludeFromExport
boolean
warnings
Array of strings
alertMessage
string
alertType
string
Possible values: "CRITICAL" "RED" "YELLOW"
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"
suffix
string
resultType
string
cssProperties
string
userGroup
string
resultGroup
string
overrideValueOptions
Array of strings or null
overrideAllowEmpty
boolean
labelTranslations
string
overridable
boolean
overridden
boolean
resultDescription
string
calculationMessages
string
targetDate
string <date-time>
modelNatureUN
string
object
property name*
additional property
string
object
version
integer
typedId
string
uniqueName
string
label
string
object
version
integer
typedId
string
uniqueName
string
label
string
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
modelTypeDefJson
string
object
logic
string
libLogic
string
analysisLogic
string
evalLogic
string
recordLogic
string
generatesData
boolean
generatesTables
boolean
generatesRecords
boolean
generatesTrees
boolean
Array of objects
Array
name
string
label
string
category
string
logic
string
distributed
boolean
createDate
string
createdBy
integer
lastUpdateDate
string
lastUpdateBy
integer
modelNatureUN
string
modelTypeDefJson
string
version
integer
dbKey
string
uniqueName
string <= 255 characters
numberOfItems
integer
object
property name*
additional property
string
userGroupEdit
string <= 255 characters
calcItemsLookupTableId
integer
Array of objects
Array
name
string
label
string
object
property name*
additional property
string
rank
integer
format
string
measureType
string
Possible values: "PERUNIT" "EXTENDED" "FIXED"
functionalType
string
Possible values: "PERUNITBASIS" "PERCENTBASIS" "PRICINGDATE" "LEVEL" "ALTKEY" "OBSOLETE_CONVERSIONFROM" "OBSOLETE_CONVERSIONTO" "OBSOLETE_CONVERSIONRATE" "OBSOLETE_BASECCY" "OBSOLETE_BASEUOM" "TIMEDIMENSION" "OBSOLETE_DELETE"
visibility
integer
defaultValue
string
sourceField
string
expression
string
function
string
Possible values: "SUM" "AVG" "MIN" "MAX" "COUNT" "EVERY" "ANY" "COUNTDISTINCT" "COUNT_DISTINCT" "PERCENTILE_DISC" "PERCENTILE_CONT" "ROW_NUMBER" "ROW_ID" "PERCENT_RANK" "CUME_DIST" "NTILE" "BIN_IDX" "BIN_ABS" "BIN_PCT" "ISNULL" … 32 more
formulaElement
string
object
property name*
additional property
string
system
boolean
numeric
boolean
key
boolean
deleted
boolean
calculated
boolean
persisted
boolean
dimension
boolean
deployed
boolean
queryable
boolean
auxiliary
boolean
partitioningKey
boolean
time
boolean
aggregation
boolean
dbColumn
string
dbTable
string
type
string
Possible values: "NUMBER" "QUANTITY" "TEXT" "DATE" "MONEY" "CURRENCY" "UOM" "LOB" "DATETIME" "BOOLEAN" "INTEGER"
source
string
owningFC
string
object
skuField
string
targetDateField
string
simulationSet
string
formulaName
string
targetDate
string <date-time>
feederFormulaName
string
Array of objects
Array
name
string
label
string
lookupTableId
string
url
string
type
string
value
string
valueHint
string
readOnly
boolean
object
parameterGroup
string
required
boolean
labelTranslations
string
addUnknownValues
boolean
typedId
string
alwaysEditable
boolean
inputs
Array of objects
object
object
valueOptions
Array of strings
inputParams
Array of objects
mappingParams
Array of objects
Array of objects
Array
elementName
string
elementLabel
string
formulaName
string
formulaDate
string <date-time>
elementGroups
Array of strings
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"
key
boolean
selected
boolean
displayedInPriceShop
boolean
targetFields
Array of strings
status
string
Possible values: "DRAFT" "PENDING" "SCHEDULED" "PROCESSING" "SCHEDULED_DIRTY" "ERROR" "READY" "CANCELLED"
formulaName
string <= 255 characters
lastUpdateByName
string
modelTypeUN
string <= 255 characters
parentUniqueName
string <= 255 characters
deployed
boolean
hasRowLevelAnalysis
boolean
paramsLookupTableId
integer
calculationDate
string
dataModelSourceName
string <= 255 characters
valid
boolean
loadableFields
Array of strings
isQueryDefined
boolean
rootModelSourceName
string <= 255 characters
keyFields
Array of objects
auxiliary
boolean
parentTypedId
string <= 255 characters
itemListFilterField
string
rowCount
integer
itemAttributeMetaClass
string
createDate
string <date-time>
lastDataModificationDate
string <date-time>
label
string <= 255 characters
isSimpleModel
boolean
queryable
boolean
dbView
string
createdBy
integer
itemClass
string
sourceName
string
calculationStartDate
string
lastUpdateBy
integer
{
  • "reservedWords": [
    • "string"
    ],
  • "isDataModel": true,
  • "typedId": "string",
  • "keyFieldNames": [
    • "string"
    ],
  • "inputs": {
    • "property1": "string",
    • "property2": "string"
    },
  • "lastUpdateDate": "2019-08-24T14:15:22Z",
  • "fieldNames": [
    • "string"
    ],
  • "dbTable": "string",
  • "type": "DATASOURCE",
  • "sourceFile": "string",
  • "paramsLookupTableName": "string",
  • "view": true,
  • "calcItemsLookupTableName": "string",
  • "legacyParamsLookupTableName": "string",
  • "legacyCalcItemsLookupTableName": "string",
  • "userGroupViewDetails": "string",
  • "locked": true,
  • "calculationResults": {
    • "property1": [
      • {
        • "resultName": "string",
        • "resultLabel": "string",
        • "result": "string",
        • "excludeFromExport": true,
        • "warnings": [
          ],
        • "alertMessage": "string",
        • "alertType": "CRITICAL",
        • "displayOptions": 0,
        • "formatType": "NUMERIC",
        • "suffix": "string",
        • "resultType": "string",
        • "cssProperties": "string",
        • "userGroup": "string",
        • "resultGroup": "string",
        • "overrideValueOptions": [
          ],
        • "overrideAllowEmpty": true,
        • "labelTranslations": "string",
        • "overridable": true,
        • "overridden": true,
        • "resultDescription": "string"
        }
      ],
    • "property2": [
      • {
        • "resultName": "string",
        • "resultLabel": "string",
        • "result": "string",
        • "excludeFromExport": true,
        • "warnings": [
          ],
        • "alertMessage": "string",
        • "alertType": "CRITICAL",
        • "displayOptions": 0,
        • "formatType": "NUMERIC",
        • "suffix": "string",
        • "resultType": "string",
        • "cssProperties": "string",
        • "userGroup": "string",
        • "resultGroup": "string",
        • "overrideValueOptions": [
          ],
        • "overrideAllowEmpty": true,
        • "labelTranslations": "string",
        • "overridable": true,
        • "overridden": true,
        • "resultDescription": "string"
        }
      ]
    },
  • "calculationMessages": "string",
  • "targetDate": "2019-08-24T14:15:22Z",
  • "modelNatureUN": "string",
  • "query": {
    • "property1": "string",
    • "property2": "string"
    },
  • "modelType": {
    • "version": 0,
    • "typedId": "string",
    • "uniqueName": "string",
    • "label": "string",
    • "modelNature": {
      • "version": 0,
      • "typedId": "string",
      • "uniqueName": "string",
      • "label": "string",
      • "createDate": "string",
      • "createdBy": 0,
      • "lastUpdateDate": "string",
      • "lastUpdateBy": 0,
      • "modelTypeDefJson": "string"
      },
    • "modelTypeDef": {
      • "logic": "string",
      • "libLogic": "string",
      • "analysisLogic": "string",
      • "evalLogic": "string",
      • "recordLogic": "string",
      • "generatesData": true,
      • "generatesTables": true,
      • "generatesRecords": true,
      • "generatesTrees": true,
      • "calcSteps": [
        • {
          }
        ]
      },
    • "createDate": "string",
    • "createdBy": 0,
    • "lastUpdateDate": "string",
    • "lastUpdateBy": 0,
    • "modelNatureUN": "string",
    • "modelTypeDefJson": "string"
    },
  • "version": 0,
  • "dbKey": "string",
  • "uniqueName": "string",
  • "numberOfItems": 0,
  • "messages": {
    • "property1": "string",
    • "property2": "string"
    },
  • "userGroupEdit": "string",
  • "calcItemsLookupTableId": 0,
  • "fields": [
    • {
      • "name": "string",
      • "label": "string",
      • "labelTranslations": {
        • "property1": "string",
        • "property2": "string"
        },
      • "rank": 0,
      • "format": "string",
      • "measureType": "PERUNIT",
      • "functionalType": "PERUNITBASIS",
      • "visibility": 0,
      • "defaultValue": "string",
      • "sourceField": "string",
      • "expression": "string",
      • "function": "SUM",
      • "formulaElement": "string",
      • "messages": {
        • "property1": "string",
        • "property2": "string"
        },
      • "system": true,
      • "numeric": true,
      • "key": true,
      • "deleted": true,
      • "calculated": true,
      • "persisted": true,
      • "dimension": true,
      • "deployed": true,
      • "queryable": true,
      • "auxiliary": true,
      • "partitioningKey": true,
      • "time": true,
      • "aggregation": true,
      • "dbColumn": "string",
      • "dbTable": "string",
      • "type": "NUMBER",
      • "source": "string",
      • "owningFC": "string"
      }
    ],
  • "calculationConfig": {
    • "skuField": "string",
    • "targetDateField": "string",
    • "simulationSet": "string",
    • "formulaName": "string",
    • "targetDate": "2019-08-24T14:15:22Z",
    • "feederFormulaName": "string",
    • "feederInputParams": [
      • {
        • "name": "string",
        • "label": "string",
        • "lookupTableId": "string",
        • "url": "string",
        • "type": "string",
        • "value": "string",
        • "valueHint": "string",
        • "readOnly": true,
        • "filter": {
          },
        • "parameterGroup": "string",
        • "required": true,
        • "labelTranslations": "string",
        • "addUnknownValues": true,
        • "typedId": "string",
        • "alwaysEditable": true,
        • "inputs": [
          ],
        • "parameterConfig": {
          },
        • "formattingOptions": {
          },
        • "valueOptions": [
          ]
        }
      ],
    • "inputParams": [
      • { }
      ],
    • "mappingParams": [
      • { }
      ],
    • "outputElements": [
      • {
        • "elementName": "string",
        • "elementLabel": "string",
        • "formulaName": "string",
        • "formulaDate": "2019-08-24T14:15:22Z",
        • "elementGroups": [
          ],
        • "formatType": "NUMERIC",
        • "key": true,
        • "selected": true,
        • "displayedInPriceShop": true
        }
      ],
    • "targetFields": [
      • "string"
      ]
    },
  • "status": "DRAFT",
  • "formulaName": "string",
  • "lastUpdateByName": "string",
  • "modelTypeUN": "string",
  • "parentUniqueName": "string",
  • "deployed": true,
  • "hasRowLevelAnalysis": true,
  • "paramsLookupTableId": 0,
  • "calculationDate": "string",
  • "dataModelSourceName": "string",
  • "valid": true,
  • "loadableFields": [
    • "string"
    ],
  • "isQueryDefined": true,
  • "rootModelSourceName": "string",
  • "keyFields": [
    • { }
    ],
  • "auxiliary": true,
  • "parentTypedId": "string",
  • "itemListFilterField": "string",
  • "rowCount": 0,
  • "itemAttributeMetaClass": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "lastDataModificationDate": "2019-08-24T14:15:22Z",
  • "label": "string",
  • "isSimpleModel": true,
  • "queryable": true,
  • "dbView": "string",
  • "createdBy": 0,
  • "itemClass": "string",
  • "sourceName": "string",
  • "calculationStartDate": "string",
  • "lastUpdateBy": 0
}