CacheConfiguration Object

This object contains the cache configuration.

Fields

lookupName 0.1required string	The name used to identify the table to external systems. 0.1 min length: `1` 0.1 max length: `128`
lookupVersion 0.1required string	The system-defined internal table version ID (in UUID canonical `string` format). The length constraints are applied to the Unicode Character Representations of the name string. 0.1 min length: `1` 0.1 max length: `128`
configVersion 0.1required string	The system-defined internal cache configuration version ID (in UUID canonical `string` format). The length constraints are applied to the Unicode Character Representations of the name string. 0.1 min length: `1` 0.1 max length: `128`
timeToLiveSeconds 0.1optional string	TTime To Live (TTL) is the maximum time in seconds for each entry to stay in the map. Valid values are integers between 0 and Integer.MAX VALUE 0.1 min: `0` 0.1 max: `2147483647` 0.1 default value: `600`
maxSize 0.1optional string	Configuration that defines the cache's maximum size. Valid values are integers between 0 and Integer.MAX VALUE 0.1 min: `0` 0.1 max: `1` 0.1 default value: `600`
enabled 0.1optional boolean	This is used for enabling or disabling the cache. In case of the legacy cache, it is determined by the timeToLiveSeconds. 0.1 default value: `false`
useLegacyCache 0.1optional boolean	This is used for enabling or disabling the legacy loading cache. 0.1 default value: `false`
source 0.1required string	This is used to determine the source of the cache configuration i.e. if it is using LOOKUP or SERVICE cache configuration. example value `SERVICE`

Example - Example Cache Configuration

  {
    "id": "e6141291-e16a-4d3d-b1e0-fb2f89767cbb",
    "name": "Price Factors",
    "createdBy": "496cff4c-2c7e-4a8e-acc5-bf81c4292b3b",
    "columns": [{
        "name": "Forecasted Volume",
        "dataType": "DECIMAL",
        "constraints": [{
            "name": "unitRequired",
            "type": "BOOLEAN",
            "value": "true"
        }],
        "required": true
    },
    {
        "name": "Historic Revenue",
        "dataType": "DECIMAL",
        "constraints": [{
            "name": "currencyRequired",
            "type": "BOOLEAN",
            "value": "true"
        }],
        "required": true
    },
    {
        "name": "Product Cost",
        "dataType": "DECIMAL",
        "constraints": [
            {
                "name": "unitRequired",
                "type": "BOOLEAN",
                "value": "true"
            },
            {
                "name": "currencyRequired",
                "type": "BOOLEAN",
                "value": "true"
            }
        ],
        "required": true
    },
    {
        "name": "Competitor Influence",
        "dataType": "STRING",
        "required": false
    }],
    "accessSequence": [
        {
            "accessLevel": [
                {
                    "aspectID": "85921462-8431-3951-97c0-558f7b5f8ffc",
                    "aspectName": "CITY",
                    "dimID": "c689acc7-ee13-3482-aa7b-c6a13419431c",
                    "dimName": "LARGE_CITIES"
                },
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        },
        {
            "accessLevel": [
                {
                    "aspectID": "2b848a8c-c886-3253-921a-77c43cd50aae",
                    "aspectName": "STATE",
                    "dimID": "c689acc7-ee13-3482-aa7b-c6a13419431c",
                    "dimName": "LARGE_CITIES"
                },
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        },
        {
            "accessLevel": [
                {
                    "aspectID": "fbd99ad0-1b92-3baf-8686-772a39e3d065",
                    "aspectName": "UPC",
                    "dimID": "28484058-4ffc-329b-94ff-63e1ddbd7189",
                    "dimName": "SAMPLE_PRODUCTS"
                }
            ]
        }
    ],
    "scaleMetadata" :
      {
          "type" : "QUANTITY",
          "offsetType": "NUMERIC",
          "calcType" : "GRADUATED"
      }
  }

Fields

Related API Resources

Example - Example Cache Configuration