CRM Analytics REST API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Variable Definition
- Properties
-
Property Name Type Description Filter Group and Version Available Version computedValue Object The computed value of the variable. This value is set by integrated apex implementations. Small, 38.0 38.0 defaultValue Object The default value of the variable. Small, 36.0 36.0 description String The description of the variable. Small, 36.0 36.0 excludeSelected Boolean Indicates whether this variable excludes already selected values or not. Small, 36.0 36.0 excludes String[] The list of values to exclude from the variable selection. Small, 36.0 36.0 label String The label for the variable. Small, 36.0 36.0 mostRecentValue Object The value specified in the most recent app creation process. Small, 36.0 36.0 required Boolean Indicates whether the variable is required or not. Small, 36.0 36.0 variableType VariableType The type of the variable. Valid variable types are: - ArrayType
- BooleanType
- CalculatedInsightFieldType
- CalculatedInsightType
- ConnectorType
- DataLakeObjectFieldType
- DataLakeObjectType
- DataModelObjectFieldType
- DataModelObjectType
- DatasetAnyFieldType
- DatasetDateType
- DatasetDimensionType
- DatasetMeasureType
- DatasetType
- DateTimeType
- NumberType
- ObjectType
- SObjectFieldType
- SObjectType
- StringType
Small, 36.0 36.0
- Array Type
-
ArrayType inherits properties from the abstract VariableType. These base properties appear in ArrayType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version enums Object The restricted list of enumerated values for the array. Small, 36.0 36.0 itemsType VariableType The variable type contents of the array variable type. Small, 36.0 36.0 sizeLimit SizeLimit The size limit of the array. Small, 36.0 36.0 - Boolean Type
-
BooleanType inherits properties from the abstract VariableType. These base properties appear in BooleanType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version enums Boolean[] The restricted list of enumerated values for the boolean variable type. Small, 36.0 36.0 - Connector Type
-
ConnectorType inherits properties from the abstract VariableType. These base properties appear in ConnectorType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version enums String[] The restricted list of enumerated string values for the connector variable type. Small, 48.0 48.0 - Dataset Any Field Type
-
DatasetAnyFieldType inherits properties from the abstract BaseObjectType.
- Dataset Date Type
-
DatasetDateType inherits properties from the abstract BaseObjectType.
- Dataset Dimension Type
-
DatasetDimensionType inherits properties from the abstract BaseObjectType.
- Dataset Measure Type
-
DatasetMeasureType inherits properties from the abstract BaseObjectType.
- Dataset Type
-
DatasetType inherits properties from the abstract BaseObjectType.
- Date Time Type
-
DateTimeType inherits properties from the abstract VariableType.
- Number Type
-
NumberType inherits properties from the abstract VariableType. These base properties appear in NumberType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version enums Double[] The restricted list of enumerated double values for the numeric variable type. Small, 36.0 36.0 max Double The maximum allowed value of the number. Small, 36.0 36.0 min Double The minimum allowed value of the number. Small, 36.0 36.0 - Object Type
-
ObjectType inherits properties from the abstract BaseObjectType.
- SObject Field Type
-
SObjectFieldType inherits properties from the abstract BaseObjectType. These base properties appear in SObjectFieldType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version dataType String The sObject field data type when a default field is not supplied. The valid data types are XSD data types, for example: xsd:string Small, 36.0 36.0 - SObject Type
-
SObjectType inherits properties from the abstract BaseObjectType.
- String Type
-
StringType inherits properties from the abstract VariableType. These base properties appear in StringType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version enums String[] The restricted list of enumerated values for the string variable type. Small, 36.0 36.0 - Base Object Type
-
BaseObjectType inherits properties from the abstract VariableType. These base properties appear in BaseObjectType alongside the properties defined explicitly in the following table.
Property Name Type Description Filter Group and Version Available Version properties Map<String, VariableType> The defined properties and types of the object variable type. Small, 36.0 36.0 required String[] The required properties of the object variable type. Small, 36.0 36.0 strictValidation Boolean Indicates whether to use strict validation when unexpected properties exist in the object's payload or not. Small, 36.0 36.0 - Variable Type
-
Property Name Type Description Filter Group and Version Available Version type VariableTypeEnum The type of the variable. Valid values are: - ArrayType
- BooleanType
- ConnectorType
- DatasetAnyFieldType
- DatasetDateType
- DatasetDimensionType
- DatasetMeasureType
- DatasetType
- DateTimeType
- NumberType
- ObjectType
- SobjectFieldType
- SobjectType
- StringType
Small, 36.0 36.0 - Size Limit
-
Property Name Type Description Filter Group and Version Available Version min Integer The minimum number of elements in the array. Small, 37.0 37.0 max Integer The maximum number of elements in the array. Small, 37.0 37.0