---
schema_version: "1"
id: 144d9c5ee0f9c407d3c04ae9afeafd2c67fccfaaba58d701f803e2d671be4ea5
title: Variable Definition
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/bi_dev_guide_rest/bi_responses_variable_definition.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_definition.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: f9db608cc3c9ef545819ca05fd69a15b800aebb770df087d9dc204902a39356f
description: The variable definition for an Analytics template. Specific variable type responses are listed here.
---
# Variable Definition

The variable definition for an Analytics template. Specific variable type responses are listed here.

Properties

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d455912e61">Property Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e64">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e67">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e70">Filter Group and Version</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e73">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">computed​Value</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">Object</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The computed value of the variable. This value is set by integrated apex
                    implementations.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 38.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">38.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name">
                    <samp class="codeph nolang">default​Value</samp>
                  </td>

                  <td class="entry" headers="d455912e64" data-title="Type">Object</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The default value of the variable.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">description</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">String</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The description of the variable.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">exclude​Selected</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">Boolean</td>

                  <td class="entry" headers="d455912e67" data-title="Description">Indicates whether this variable excludes already selected values or
                    not.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">excludes</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">String[]</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The list of values to exclude from the variable selection.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">label</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">String</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The label for the variable.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">most​Recent​Value</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">Object</td>

                  <td class="entry" headers="d455912e67" data-title="Description">The value specified in the most recent app creation process.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">required</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type">Boolean</td>

                  <td class="entry" headers="d455912e67" data-title="Description">Indicates whether the variable is required or not.</td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d455912e61" data-title="Property Name"><samp class="codeph nolang">variable​Type</samp></td>

                  <td class="entry" headers="d455912e64" data-title="Type"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_variable_type.htm" title="The abstract type for an Analytics template variable.">Variable​Type</a></td>

                  <td class="entry" headers="d455912e67" data-title="Description">The type of the variable. Valid variable types are:
                    <ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_array_type.htm" title="The array type of an Analytics template variable.">Array​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_boolean_type.htm" title="The boolean type of an Analytics template variable.">Boolean​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm" title="The sobject field type of an Analytics template variable.">Calculated​Insight​Field​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm" title="The sobject type of an Analytics template variable.">Calculated​Insight​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_connector_type.htm" title="The connector type of an Analytics template variable.">Connector​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm" title="The sobject field type of an Analytics template variable.">Data​Lake​Object​Field​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm" title="The sobject type of an Analytics template variable.">Data​Lake​Object​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm" title="The sobject field type of an Analytics template variable.">Data​Model​Object​Field​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm" title="The sobject type of an Analytics template variable.">Data​Model​Object​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_any_field_type.htm" title="The dataset generic field type of an Analytics template variable.">Dataset​Any​Field​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_date_type.htm" title="The date in a dateset type of an Analytics template variable.">Dataset​Date​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_dimension_type.htm" title="The dimension in a dateset type of an Analytics template variable.">Dataset​Dimension​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_measure_type.htm" title="The measure in a dateset type of an Analytics template variable.">Dataset​Measure​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_dataset_type.htm" title="The dateset type of an Analytics template variable.">Dataset​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_date_time_type.htm" title="The date time type of an Analytics template variable.">Date​Time​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_number_type.htm" title="The number type of an Analytics template variable.">Number​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_object_type.htm" title="The object type of an Analytics template variable.">Object​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_field_type.htm" title="The sobject field type of an Analytics template variable.">SObject​Field​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_sobject_type.htm" title="The sobject type of an Analytics template variable.">SObject​Type</a></samp></li>

                      <li class="li"><samp class="codeph nolang"><a class="xref" href="https://developer.salesforce.com/docs/atlas.en-us.bi_dev_guide_rest.meta/bi_dev_guide_rest/bi_responses_string_type.htm" title="The string type of an Analytics template variable.">String​Type</a></samp></li>

                    </ul>

                  </td>

                  <td class="entry" headers="d455912e70" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e73" data-title="Available Version">36.0</td>

                </tr>

              </tbody>

            </table>

Array Type

ArrayType inherits properties from the abstract [VariableType](#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 |
| items​Type | [Variable​Type](#VariableType) | The variable type contents of the array variable type. | Small, 36.0 | 36.0 |
| size​Limit | [Size​Limit](#SizeLimit) | The size limit of the array. | Small, 36.0 | 36.0 |

Boolean Type

BooleanType inherits properties from the abstract [VariableType](#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](#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](#BaseObjectType).

Dataset Date Type

DatasetDateType inherits properties from the abstract [BaseObjectType](#BaseObjectType).

Dataset Dimension Type

DatasetDimensionType inherits properties from the abstract [BaseObjectType](#BaseObjectType).

Dataset Measure Type

DatasetMeasureType inherits properties from the abstract [BaseObjectType](#BaseObjectType).

Dataset Type

DatasetType inherits properties from the abstract [BaseObjectType](#BaseObjectType).

Date Time Type

DateTimeType inherits properties from the abstract [VariableType](#VariableType).

Number Type

NumberType inherits properties from the abstract [VariableType](#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](#BaseObjectType).

SObject Field Type

SObjectFieldType inherits properties from the abstract [BaseObjectType](#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 |
| --- | --- | --- | --- | --- |
| data​Type | 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](#BaseObjectType).

String Type

StringType inherits properties from the abstract [VariableType](#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](#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, [Variable​Type>](#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 |
| strict​Validation | 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

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d455912e1251">Property Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e1254">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e1257">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e1260">Filter Group and Version</th>

                  <th class="featureTableHeader vertical-align-top " id="d455912e1263">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d455912e1251" data-title="Property Name"><samp class="codeph nolang">type</samp></td>

                  <td class="entry" headers="d455912e1254" data-title="Type">Variable​Type​Enum</td>

                  <td class="entry" headers="d455912e1257" data-title="Description">The type of the variable. Valid values are:<ul class="ul bulletList">
                      <li class="li"><samp class="codeph nolang">ArrayType</samp></li>

                      <li class="li"><samp class="codeph nolang">BooleanType</samp></li>

                      <li class="li"><samp class="codeph nolang">ConnectorType</samp></li>

                      <li class="li"><samp class="codeph nolang">DatasetAnyFieldType</samp></li>

                      <li class="li"><samp class="codeph nolang">DatasetDateType</samp></li>

                      <li class="li"><samp class="codeph nolang">DatasetDimensionType</samp></li>

                      <li class="li"><samp class="codeph nolang">DatasetMeasureType</samp></li>

                      <li class="li"><samp class="codeph nolang">DatasetType</samp></li>

                      <li class="li"><samp class="codeph nolang">DateTimeType</samp></li>

                      <li class="li"><samp class="codeph nolang">NumberType</samp></li>

                      <li class="li"><samp class="codeph nolang">ObjectType</samp></li>

                      <li class="li"><samp class="codeph nolang">SobjectFieldType</samp></li>

                      <li class="li"><samp class="codeph nolang">SobjectType</samp></li>

                      <li class="li"><samp class="codeph nolang">StringType</samp></li>

                    </ul>
                  </td>

                  <td class="entry" headers="d455912e1260" data-title="Filter Group and Version">Small, 36.0</td>

                  <td class="entry" headers="d455912e1263" data-title="Available Version">36.0</td>

                </tr>

              </tbody>

            </table>

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 |