GET api/admin/v{version}/server/cache/settings

Request Information

URI Parameters

Name	Description	Type	Additional information
version		string	None.

Body Parameters

None.

Response Information

Resource Description

CacheSettings

Name	Type	Additional information
CachingEnabled	boolean	None.
CacheLoggingEnabled	boolean	None.
Caches	Collection of CacheSetting	None.

Response Formats

application/json, text/json

Sample:

{
  "CachingEnabled": true,
  "CacheLoggingEnabled": true,
  "Caches": [
    {
      "StillExists": true,
      "CacheName": "sample string 1",
      "IsCacheEnabled": true,
      "IsCacheLoggingEnabled": true,
      "CompactionPercentage": 4.1,
      "ExpirationScanFrequency": "00:00:00.1234567",
      "ExpirationScanFrequencyTimeSpan": "00:00:00.1234567",
      "SizeLimit": 7,
      "TrackLinkedCacheEntries": true,
      "TrackStatistics": true,
      "EntrySize": 10,
      "EntryPriority": 0,
      "EntrySlidingExpiration": "00:00:00.1234567",
      "EntrySlidingExpirationTimeSpan": "00:00:00.1234567",
      "EntryAbsoluteExpirationRelativeToNow": "00:00:00.1234567",
      "EntryAbsoluteExpirationRelativeToNowTimeSpan": "00:00:00.1234567",
      "EntryExpirationType": 0,
      "CollectionEntrySize": 15,
      "CollectionEntryPriority": 0,
      "CollectionEntrySlidingExpiration": "00:00:00.1234567",
      "CollectionEntrySlidingExpirationTimeSpan": "00:00:00.1234567",
      "CollectionEntryAbsoluteExpirationRelativeToNow": "00:00:00.1234567",
      "CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan": "00:00:00.1234567",
      "CollectionEntryExpirationType": 0,
      "CacheDescription": "sample string 20"
    },
    {
      "StillExists": true,
      "CacheName": "sample string 1",
      "IsCacheEnabled": true,
      "IsCacheLoggingEnabled": true,
      "CompactionPercentage": 4.1,
      "ExpirationScanFrequency": "00:00:00.1234567",
      "ExpirationScanFrequencyTimeSpan": "00:00:00.1234567",
      "SizeLimit": 7,
      "TrackLinkedCacheEntries": true,
      "TrackStatistics": true,
      "EntrySize": 10,
      "EntryPriority": 0,
      "EntrySlidingExpiration": "00:00:00.1234567",
      "EntrySlidingExpirationTimeSpan": "00:00:00.1234567",
      "EntryAbsoluteExpirationRelativeToNow": "00:00:00.1234567",
      "EntryAbsoluteExpirationRelativeToNowTimeSpan": "00:00:00.1234567",
      "EntryExpirationType": 0,
      "CollectionEntrySize": 15,
      "CollectionEntryPriority": 0,
      "CollectionEntrySlidingExpiration": "00:00:00.1234567",
      "CollectionEntrySlidingExpirationTimeSpan": "00:00:00.1234567",
      "CollectionEntryAbsoluteExpirationRelativeToNow": "00:00:00.1234567",
      "CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan": "00:00:00.1234567",
      "CollectionEntryExpirationType": 0,
      "CacheDescription": "sample string 20"
    }
  ]
}

text/html

Sample:

{"CachingEnabled":true,"CacheLoggingEnabled":true,"Caches":[{"StillExists":true,"CacheName":"sample string 1","IsCacheEnabled":true,"IsCacheLoggingEnabled":true,"CompactionPercentage":4.1,"ExpirationScanFrequency":"00:00:00.1234567","ExpirationScanFrequencyTimeSpan":"00:00:00.1234567","SizeLimit":7,"TrackLinkedCacheEntries":true,"TrackStatistics":true,"EntrySize":10,"EntryPriority":0,"EntrySlidingExpiration":"00:00:00.1234567","EntrySlidingExpirationTimeSpan":"00:00:00.1234567","EntryAbsoluteExpirationRelativeToNow":"00:00:00.1234567","EntryAbsoluteExpirationRelativeToNowTimeSpan":"00:00:00.1234567","EntryExpirationType":0,"CollectionEntrySize":15,"CollectionEntryPriority":0,"CollectionEntrySlidingExpiration":"00:00:00.1234567","CollectionEntrySlidingExpirationTimeSpan":"00:00:00.1234567","CollectionEntryAbsoluteExpirationRelativeToNow":"00:00:00.1234567","CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan":"00:00:00.1234567","CollectionEntryExpirationType":0,"CacheDescription":"sample string 20"},{"StillExists":true,"CacheName":"sample string 1","IsCacheEnabled":true,"IsCacheLoggingEnabled":true,"CompactionPercentage":4.1,"ExpirationScanFrequency":"00:00:00.1234567","ExpirationScanFrequencyTimeSpan":"00:00:00.1234567","SizeLimit":7,"TrackLinkedCacheEntries":true,"TrackStatistics":true,"EntrySize":10,"EntryPriority":0,"EntrySlidingExpiration":"00:00:00.1234567","EntrySlidingExpirationTimeSpan":"00:00:00.1234567","EntryAbsoluteExpirationRelativeToNow":"00:00:00.1234567","EntryAbsoluteExpirationRelativeToNowTimeSpan":"00:00:00.1234567","EntryExpirationType":0,"CollectionEntrySize":15,"CollectionEntryPriority":0,"CollectionEntrySlidingExpiration":"00:00:00.1234567","CollectionEntrySlidingExpirationTimeSpan":"00:00:00.1234567","CollectionEntryAbsoluteExpirationRelativeToNow":"00:00:00.1234567","CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan":"00:00:00.1234567","CollectionEntryExpirationType":0,"CacheDescription":"sample string 20"}]}

application/xml, text/xml

Sample:

<CacheSettings xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DispatchITV2.Caching.Common.Settings">
  <CacheLoggingEnabled>true</CacheLoggingEnabled>
  <Caches>
    <CacheSetting>
      <CacheDescription>sample string 20</CacheDescription>
      <CacheName>sample string 1</CacheName>
      <CollectionEntryAbsoluteExpirationRelativeToNow>00:00:00.1234567</CollectionEntryAbsoluteExpirationRelativeToNow>
      <CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan>PT0.1234567S</CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan>
      <CollectionEntryExpirationType>Sliding</CollectionEntryExpirationType>
      <CollectionEntryPriority>Low</CollectionEntryPriority>
      <CollectionEntrySize>15</CollectionEntrySize>
      <CollectionEntrySlidingExpiration>00:00:00.1234567</CollectionEntrySlidingExpiration>
      <CollectionEntrySlidingExpirationTimeSpan>PT0.1234567S</CollectionEntrySlidingExpirationTimeSpan>
      <CompactionPercentage>4.1</CompactionPercentage>
      <EntryAbsoluteExpirationRelativeToNow>00:00:00.1234567</EntryAbsoluteExpirationRelativeToNow>
      <EntryAbsoluteExpirationRelativeToNowTimeSpan>PT0.1234567S</EntryAbsoluteExpirationRelativeToNowTimeSpan>
      <EntryExpirationType>Sliding</EntryExpirationType>
      <EntryPriority>Low</EntryPriority>
      <EntrySize>10</EntrySize>
      <EntrySlidingExpiration>00:00:00.1234567</EntrySlidingExpiration>
      <EntrySlidingExpirationTimeSpan>PT0.1234567S</EntrySlidingExpirationTimeSpan>
      <ExpirationScanFrequency>00:00:00.1234567</ExpirationScanFrequency>
      <ExpirationScanFrequencyTimeSpan>PT0.1234567S</ExpirationScanFrequencyTimeSpan>
      <IsCacheEnabled>true</IsCacheEnabled>
      <IsCacheLoggingEnabled>true</IsCacheLoggingEnabled>
      <SizeLimit>7</SizeLimit>
      <StillExists>true</StillExists>
      <TrackLinkedCacheEntries>true</TrackLinkedCacheEntries>
      <TrackStatistics>true</TrackStatistics>
    </CacheSetting>
    <CacheSetting>
      <CacheDescription>sample string 20</CacheDescription>
      <CacheName>sample string 1</CacheName>
      <CollectionEntryAbsoluteExpirationRelativeToNow>00:00:00.1234567</CollectionEntryAbsoluteExpirationRelativeToNow>
      <CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan>PT0.1234567S</CollectionEntryAbsoluteExpirationRelativeToNowTimeSpan>
      <CollectionEntryExpirationType>Sliding</CollectionEntryExpirationType>
      <CollectionEntryPriority>Low</CollectionEntryPriority>
      <CollectionEntrySize>15</CollectionEntrySize>
      <CollectionEntrySlidingExpiration>00:00:00.1234567</CollectionEntrySlidingExpiration>
      <CollectionEntrySlidingExpirationTimeSpan>PT0.1234567S</CollectionEntrySlidingExpirationTimeSpan>
      <CompactionPercentage>4.1</CompactionPercentage>
      <EntryAbsoluteExpirationRelativeToNow>00:00:00.1234567</EntryAbsoluteExpirationRelativeToNow>
      <EntryAbsoluteExpirationRelativeToNowTimeSpan>PT0.1234567S</EntryAbsoluteExpirationRelativeToNowTimeSpan>
      <EntryExpirationType>Sliding</EntryExpirationType>
      <EntryPriority>Low</EntryPriority>
      <EntrySize>10</EntrySize>
      <EntrySlidingExpiration>00:00:00.1234567</EntrySlidingExpiration>
      <EntrySlidingExpirationTimeSpan>PT0.1234567S</EntrySlidingExpirationTimeSpan>
      <ExpirationScanFrequency>00:00:00.1234567</ExpirationScanFrequency>
      <ExpirationScanFrequencyTimeSpan>PT0.1234567S</ExpirationScanFrequencyTimeSpan>
      <IsCacheEnabled>true</IsCacheEnabled>
      <IsCacheLoggingEnabled>true</IsCacheLoggingEnabled>
      <SizeLimit>7</SizeLimit>
      <StillExists>true</StillExists>
      <TrackLinkedCacheEntries>true</TrackLinkedCacheEntries>
      <TrackStatistics>true</TrackStatistics>
    </CacheSetting>
  </Caches>
  <CachingEnabled>true</CachingEnabled>
</CacheSettings>