Settings resource

This resource is part of the Settings API section of the Web Services API.

Overview

The settings resource includes properties that describe the settings group, whether it's a system settings group or a custom settings group. Settings groups are returned from GET requests to /api/v2/settings or GET requests to /api/v2/settings?subresources=*.

See System settings and Custom settings for details about how to work with these types of settings groups and settings.

Sample data

{  
   "settings":[  
      {  
         "name":"CC-AverageWaitingTime",
         "displayName":"CC-AverageWaitingTime",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-AverageWaitingTime",
         "path":"/settings/CC-AverageWaitingTime"
      },
      {  
         "name":"CC-CurrMaxCallWaitingTime",
         "displayName":"CC-CurrMaxCallWaitingTime",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-CurrMaxCallWaitingTime",
         "path":"/settings/CC-CurrMaxCallWaitingTime"
      },
      {  
         "name":"CC-Current_In_Queue",
         "displayName":"CC-Current_In_Queue",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-Current_In_Queue",
         "path":"/settings/CC-Current_In_Queue"
      },
      {  
         "name":"CC-ServiceLevel",
         "displayName":"CC-ServiceLevel",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-ServiceLevel",
         "path":"/settings/CC-ServiceLevel"
      },
      {  
         "name":"CC-Total_Abandoned",
         "displayName":"CC-Total_Abandoned",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-Total_Abandoned",
         "path":"/settings/CC-Total_Abandoned"
      },
      {  
         "name":"CC-Total_Answered",
         "displayName":"CC-Total_Answered",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CC-Total_Answered",
         "path":"/settings/CC-Total_Answered"
      },
      {  
         "name":"CCStat-CurrentTargetState",
         "displayName":"CCStat-CurrentTargetState",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/CCStat-CurrentTargetState",
         "path":"/settings/CCStat-CurrentTargetState"
      },
      {  
         "name":"voice",
         "displayName":"Voice",
         "key":"name",
         "uri":"http://198.51.100.3:8090/api/v2/settings/voice",
         "path":"/settings/voice"
      },
      {  
         "name":"voice-operations",
         "displayName":"Voice Operations",
         "key":"operationName",
         "uri":"http://198.51.100.3:8090/api/v2/settings/voice-operations",
         "path":"/settings/voice-operations"
      },
      {  
         "name":"dispositions",
         "displayName":"dispositions",
         "uri":"http://198.51.100.3:8090/api/v2/settings/dispositions",
         "path":"/settings/dispositions"
      },
      {  
         "name":"general-settings",
         "displayName":"General Settings",
         "uri":"http://198.51.100.3:8090/api/v2/settings/general-settings",
         "path":"/settings/general-settings"
      },
      {  
         "name":"agent-states",
         "displayName":"Agent States",
         "uri":"http://198.51.100.3:8090/api/v2/settings/agent-states",
         "path":"/settings/agent-states"
      }
   ]
}

Resource details

Field	Description
name	A URI-compatible name for the settings group. This name is used as part of the URI to access the group: (for example, GET /settings/my-settings-group)
displayName	Name that describes the settings group.
key	The name of the key attribute for this group's settings. Whenever an individual setting needs to be modified, this key attribute is used to identify the setting. The value of the key attribute must be unique for every setting and is read-only after the setting has been created. A setting may not be created without this attribute. If the key attribute is missing, then Web Services uses "name" as the default identifying attribute.
uri	The URI to the settings group.
path	The path to the settings resource.