[Index]
This relation wraps the default CUCM device pool element.
Model ref.: relation/HcsLocalRouteGroupREL
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "deviceMobilityGroupName": { "description": " Device mobility groups represent the highest level geographic entities in your network and are used to support the device mobility feature. ", "format": "uri", "minItems": 0, "title": "Device Mobility Group", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/DeviceMobilityGroup", "type": [ "string", "null" ], "target": "/api/device/cucm/DeviceMobilityGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartyUnknownTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Called Party Unknown Transformation Css Name", "type": [ "string", "null" ] }, "calledPartyUnknownPrefix": { "title": "Called Party Unknown Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "callingPartyUnknownTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Calling Party Unknown Transformation Css Name", "type": [ "string", "null" ] }, "calledPartySubscriberTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Called Party Subscriber Transformation Css Name", "type": [ "string", "null" ] }, "callingPartyNationalTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Calling Party National Transformation Css Name", "type": [ "string", "null" ] }, "adjunctCallingSearchSpace": { "description": " From the drop-down list box, choose an existing Calling Search Space (CSS) to use for the devices in this device profile as an adjunct CSS for the Extension Mobility Cross Cluster (EMCC) feature. (To configure a new CSS or modify an existing CSS, choose Call Routing > Class of Control > Calling Search Space in \n Cisco Unified Communications Manager Administration.) Default value specifies None. When configuring the EMCC feature, the administrator must configure a device pool for each remote cluster. If the remote cluster is located in a different country, the adjunct CSS must embrace the partition with which the emergency patterns of that country associate. This configuration facilitates country-specific emergency call routing. For more information about the adjunct CSS, see topics related to EMCC call routing in the \n Cisco Unified Communications Manager Features and Services Guide. ", "format": "uri", "minItems": 0, "title": "Adjunct CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartyUnknownStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Called Party Unknown Strip Digits" }, "autoSearchSpaceName": { "description": " Choose the calling search space to assign to devices in this device pool that auto-register with \n Cisco Unified Communications Manager. The calling search space specifies partitions that devices can search when attempting to complete a call. ", "format": "uri", "minItems": 0, "title": "Calling Search Space for Auto-registration", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "mraServiceDomain": { "minItems": 0, "required": false, "type": [ "string", "null" ], "maxItems": 1, "title": "Mra Service Domain" }, "calledPartySubscriberPrefix": { "title": "Called Party Subscriber Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "localRouteGroupName": { "description": "The Local Route Group Settings enables you to associate the route groups that you add under Call Routing > Route/Hunt > Route Group with the local route groups that you configure on the Local Route Group Names window for any particular device pool.", "format": "uri", "minItems": 0, "title": "Local Route Group Name", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/RouteGroup", "type": "string", "target": "/api/device/cucm/RouteGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "imeEnrolledPatternGroupName": { "description": "Select an Intercompany Media Services Enrolled Group from the drop-down list. For more information, see the Cisco Intercompany Media Engine Installation and Configuration Guide. ", "format": "uri", "minItems": 0, "title": "Intercompany Media Services Enrolled Group", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/ImeEnrolledPatternGroup", "type": [ "string", "null" ], "target": "/api/device/cucm/ImeEnrolledPatternGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "callManagerGroupName": { "description": " Choose the \n Cisco Unified Communications Manager group to assign to devices in this device pool. A \n Cisco Unified Communications Manager group specifies a prioritized list of up to three \n Cisco Unified Communications Managers. The first \n Cisco Unified Communications Manager in the list serves as the primary \n Cisco Unified Communications Manager for that group, and the other members of the group serve as backup \n Cisco Unified Communications Managers for redundancy. ", "format": "uri", "minItems": 1, "title": "Cisco Unified Communications Manager Group", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/CallManagerGroup", "type": "string", "target": "/api/device/cucm/CallManagerGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "singleButtonBarge": { "description": " This setting determines whether the devices or phone users in this device pool have single-button access for barge and cBarge. From the drop-down list box, choose from the following options: \n \n \n \n Off\u2014If you choose this option, the devices in this device pool will have the Single Button Barge/cBarge feature disabled. \n \n Barge\u2014If you choose this option, the devices in this device pool will have the Single Button Barge feature enabled. \n \n CBarge\u2014If you choose this option, the devices in this device pool will have the Single Button cBarge feature enabled. \n \n Default\u2014If you choose this option, the devices in this device pool will use the service parameter setting for the Single Button Barge/cBarge feature. \n ", "title": "Single Button Barge", "minItems": 0, "required": false, "choices": [ { "value": "Off", "title": "Off" }, { "value": "Barge", "title": "Barge" }, { "value": "CBarge", "title": "CBarge" }, { "value": "Default", "title": "Default" } ], "default": "Default", "maxItems": 1, "type": "string" }, "callingPartyTransformationCSS": { "description": " This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device pool. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None for the device pool and you check the Use Device Pool Calling Party Transformation CSS check box in the device configuration window, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing. \n \n \n ", "format": "uri", "minItems": 0, "title": "Calling Party Transformation CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartyNationalPrefix": { "title": "Called Party National Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "callingPartyUnknownStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Calling Party Unknown Strip Digits" }, "callingPartyInternationalTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Calling Party International Transformation Css Name", "type": [ "string", "null" ] }, "networkLocale": { "description": " From the drop-down list box, choose the locale that is associated with phones and gateways. The network locale contains a definition of the tones and cadences that the phones and gateways in the device pool in a specific geographic area use. Make sure that you select a network locale that is supported by all of the phones and gateways that use this device pool. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If the user does not choose a network locale, the locale that is specified in the \n Cisco Unified Communications Manager clusterwide parameters as Default Network Locale applies. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Choose only a network locale that is already installed and supported by the associated devices. The list contains all available network locales for this setting, but not all are necessarily installed. If a device is associated with a network locale that it does not support in the firmware, the device will fail to come up. \n \n \n ", "format": "uri", "minItems": 0, "title": "Network Locale", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Country", "type": [ "string", "null" ], "target": "/api/device/cucm/Country/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "localRouteGroup": { "minItems": 0, "items": { "type": [ "object", "null" ], "properties": { "name": { "name": "name", "format": "uri", "minItems": 0, "title": "Name", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/LocalRouteGroup", "type": "string", "target": "/api/device/cucm/LocalRouteGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "value": { "name": "value", "format": "uri", "minItems": 0, "title": "Value", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/RouteGroup", "type": "string", "target": "/api/device/cucm/RouteGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] } } }, "required": false, "type": "array", "title": "Local Route Group" }, "calledPartyNationalTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Called Party National Transformation Css Name", "type": [ "string", "null" ] }, "cgpnTransformationCssName": { "description": " This setting allows you to localize the calling party number on the device. Make sure that the Calling Party Transformation CSS that you choose contains the calling party transformation pattern that you want to assign to this device pool. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n Before the call occurs, the device must apply the transformation by using digit analysis. If you configure the Calling Party Transformation CSS as None for the device pool and you check the Use Device Pool Calling Party Transformation CSS check box in the device configuration window, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation Pattern in a non-null partition that is not used for routing. \n \n \n ", "format": "uri", "minItems": 0, "title": "Calling Party Transformation CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "regionName": { "description": " Choose the \n Cisco Unified Communications Manager region to assign to devices in this device pool. The \n Cisco Unified Communications Manager region settings specify voice codec that can be used for calls within a region and between other regions. ", "format": "uri", "minItems": 1, "title": "Region", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Region", "type": "string", "target": "/api/device/cucm/Region/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "connectionMonitorDuration": { "description": " This setting defines the time that the \n Cisco Unified IP Phone monitors its connection to \n Cisco Unified Communications Manager before it unregisters from SRST and reregisters to \n Cisco Unified Communications Manager. To use the configuration for the enterprise parameter, you can enter -1 or leave the field blank. The default value for the enterprise parameter equals 120 seconds. Change this setting if you need to disable the connection monitor or if you want to extend the connection monitor time. The maximum number of seconds that you can enter in the field equals 2592000. \n \n \n \n Tip\u00a0\u00a0\u00a0 \n When you change the value of the connection monitor duration, it applies only to the device pool that is being updated. All other device pools use the value in their own connection monitor duration fields or use the value that is configured in the enterprise parameter. \n \n \n For more information, see topics related to survivable remote site telephony in the \n Cisco Unified Communications Manager System Guide. ", "title": "Connection Monitor Duration", "minItems": 0, "required": false, "default": -1, "maxItems": 1, "type": "integer" }, "callingPartySubscriberPrefix": { "title": "Calling Party Subscriber Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "calledPartyInternationalStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Called Party International Strip Digits" }, "revertPriority": { "description": " Choose a clusterwide priority setting for reverted calls that are invoked by the hold reversion feature. This setting specifies which call type, incoming calls or reverted calls, have priority for user actions, such as going off hook. \n \n \n \n Default\u2014If you choose this option, incoming calls have priority. \n \n Highest\u2014If you choose this option, reverted calls have priority. \n The Not Selected setting specifies the reverted call focus priority setting for the default device pool at installation. At installation, incoming calls have priority. You cannot choose this setting in \n Cisco Unified Communications Manager Administration. \n \n \n \n Note\u00a0\u00a0\u00a0 \n This setting applies specifically to hold reverted calls; it does not apply to parked reverted calls. \n \n \n For more information, see topics related to hold reversion in the \n Cisco Unified Communications Manager Features and Services Guide. ", "title": "Reverted Call Focus Priority", "minItems": 0, "required": false, "choices": [ { "value": "Default", "title": "Default" }, { "value": "Highest", "title": "Highest" } ], "default": "Default", "maxItems": 1, "type": "string" }, "redirectingPartyTransformationCSS": { "description": "This setting allows you to transform the redirecting party number on the device to E164 format. \n Cisco Unified Communications Manager includes the transformed number in the diversion header of invite messages for SIP trunks and in the Redirecting Number Information Element of setup message (for H.323 and MGCP) sent out of \n Cisco Unified Communications Manager. Make sure that the Redirecting Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you configure the Redirecting Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Redirecting Party Transformation CSS in a non-null partition that is not used for routing. \n \n \n ", "format": "uri", "minItems": 0, "title": "Redirecting Party Transformation CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "geoLocationName": { "description": " From the drop-down list box, choose a geolocation. You can choose the Unspecified geolocation, which designates that the devices in this device pool do not associate with a geolocation. You can also choose a geolocation that has been configured with the System > Geolocation Configuration menu option. For an explanation of geolocations, including configuration details, see topics related to geolocations and location conveyance in the \n Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocations, see topics related to geolocations and location conveyance in the \n Cisco Unified Communications Manager Features and Services Guide. ", "format": "uri", "minItems": 0, "title": "Geolocation", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/GeoLocation", "type": [ "string", "null" ], "target": "/api/device/cucm/GeoLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartyInternationalPrefix": { "title": "Called Party International Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "dateTimeSettingName": { "description": " Choose the date/time group to assign to devices in this device pool. The date/time group specifies the time zone and the display formats for date and time. ", "format": "uri", "minItems": 1, "title": "Date/Time Group", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/DateTimeGroup", "type": "string", "target": "/api/device/cucm/DateTimeGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "callingPartyNationalStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Calling Party National Strip Digits" }, "elinGroup": { "description": "Select a Wi-Fi Hotspot Profile from the drop-down list box. You may also click View Details to display details about the Wi-Fi Hotspot Profile that you select. ", "title": "Elin Group", "minItems": 0, "required": false, "maxItems": 1, "type": [ "string", "null" ] }, "joinAcrossLines": { "description": " This setting determines whether the Join Across Lines feature is enabled for the devices or phone users in this device pool. From the drop-down list box, choose from the following options: \n \n \n \n Off\u2014If you choose this option, the devices in this device pool will have the Join Across Lines feature disabled. \n \n On\u2014If you choose this option, the devices in this device pool will have the Join Across Lines feature enabled. \n \n Default\u2014If you choose this option, the devices in this device pool will use the service parameter setting for the Join Across Lines feature. \n ", "title": "Join Across Lines", "minItems": 0, "required": false, "choices": [ { "value": "Off", "title": "Off" }, { "value": "On", "title": "On" }, { "value": "Default", "title": "Default" } ], "default": "Default", "maxItems": 1, "type": "string" }, "cdpnTransformationCssName": { "description": " This setting allows you to localize the called party number on the device. Make sure that the Called Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you configure the Called Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Called Party Transformation pattern in a non-null partition that is not used for routing. \n \n \n ", "format": "uri", "minItems": 0, "title": "Called Party Transformation CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "shadow": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "maxItems": 1, "title": "Shadow" }, "callingPartySubscriberStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Calling Party Subscriber Strip Digits" }, "srstName": { "description": " From the drop-down list box, choose a survivable remote site telephony (SRST) reference to assign to devices in this device pool. Choose from the following options: \n \n \n \n Disable\u2014If you choose this option, devices in this device pool will not have SRST reference gateways that are available to them. \n \n Use Default Gateway\u2014If you choose this option, devices in this device pool use the default gateway for SRST. \n \n Existing SRST references\u2014If you choose an SRST reference from the drop-down list, devices in this device pool will use this SRST reference gateway. \n ", "format": "uri", "minItems": 1, "title": "SRST Reference", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Srst", "type": "string", "target": "/api/device/cucm/Srst/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "callingPartyNationalPrefix": { "title": "Calling Party National Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "callingPartyInternationalPrefix": { "title": "Calling Party International Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "callingPartyInternationalStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Calling Party International Strip Digits" }, "name": { "description": " Enter the name of the new device pool that you are creating. You can enter up to 50 characters, which include alphanumeric characters, periods (.), hyphens (-), underscores (_), and blank spaces. ", "title": "Device Pool Name", "minItems": 1, "required": true, "maxItems": 1, "maxLength": 50, "type": "string" }, "cntdPnTransformationCssName": { "description": " This setting is applicable for inbound calls only. This setting allows you to transform the connected party number on the device to display the connected number in another format, such as a DID or E164 number. Cisco Unified Communications Manager includes the transformed number in the headers of various SIP messages, including 200 OK and mid-call update/reinvite messages for SIP calls and in the Connected Number Information Element of CONNECT and NOTIFY messages for H.323 and MGCP calls. Make sure that the Connected Party Transformation CSS that you choose contains the called party transformation pattern that you want to assign to this device pool. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you configure the Connected Party Transformation CSS as None, the transformation does not match and does not get applied. Ensure that you configure the Calling Party Transformation pattern used for Connected Party Transformation in a non-null partition that is not used for routing. \n \n \n ", "format": "uri", "minItems": 0, "title": "Connected Party Transformation CSS", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "callingPartySubscriberTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Calling Party Subscriber Transformation Css Name", "type": [ "string", "null" ] }, "wirelessLanProfileGroup": { "description": "Select a wireless LAN profile group from the drop-down list box. You may also click View Details to display the settings for this wireless LAN profile group. \n \n \n \n Note\u00a0\u00a0\u00a0 \n You can specify the Wireless LAN Profile Group at the Device Pool level or the individual phone level. \n \n \n ", "format": "uri", "minItems": 0, "title": "Wireless Lan Profile Group", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/WlanProfileGroup", "type": [ "string", "null" ], "target": "/api/device/cucm/WlanProfileGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "geoLocationFilterName": { "description": " From the drop-down list box, choose a geolocation filter. If you leave the <None> setting, no geolocation filter gets applied for the devices in this device pool. You can also choose a geolocation filter that has been configured with the System > Geolocation Filter menu option. For an explanation of geolocation filters, including configuration details, see the \n Cisco Unified Communications Manager Features and Services Guide. For an overview and details of how logical partitioning uses geolocation filters, see the \n Cisco Unified Communications Manager Features and Services Guide. ", "format": "uri", "minItems": 0, "title": "Geolocation Filter", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/GeoLocationFilter", "type": [ "string", "null" ], "target": "/api/device/cucm/GeoLocationFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "aarNeighborhoodName": { "description": " Choose the automated alternate routing (AAR) group for this device. The AAR group provides the prefix digits that are used to route calls that are otherwise blocked due to insufficient bandwidth. An AAR group setting of None specifies that no rerouting of blocked calls will be attempted. ", "format": "uri", "minItems": 1, "title": "AAR Group", "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/AarGroup", "type": [ "string", "null" ], "target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "locationName": { "description": " Use locations to implement call admission control (CAC) in a centralized call-processing system. CAC enables you to regulate audio quality and video availability by limiting the amount of bandwidth that is available for audio and video calls over links between locations. The location specifies the total bandwidth that is available for calls to and from this location. From the drop-down list box, choose the appropriate location for this device pool. A location setting of None or Hub_None means that the locations feature does not keep track of the bandwidth that the devices in this device pool consume. A location setting of Phantom specifies a location that enables successful CAC across intercluster trunks that use H.323 protocol or SIP. To configure a new location, use the System > Location menu option. For an explanation of location-based CAC across intercluster trunks, see topics related to location-based CAC in the \n Cisco Unified Communications Manager System Guide. ", "format": "uri", "minItems": 0, "title": "Location", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Location", "type": [ "string", "null" ], "target": "/api/device/cucm/Location/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "physicalLocationName": { "description": " Select the physical location for this device pool. The system uses physical location with the device mobility feature to identify the parameters that relate to a specific geographical location. ", "format": "uri", "minItems": 0, "title": "Physical Location", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/PhysicalLocation", "type": [ "string", "null" ], "target": "/api/device/cucm/PhysicalLocation/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "mediaResourceListName": { "description": " From the drop-down list box, choose a media resource group list. A media resource group list specifies a prioritized list of media resource groups. An application selects the required media resource (for example, a music on hold server, transcoder, or conference bridge) from the available media resource groups according to the priority order that is defined in a media resource group list. ", "format": "uri", "minItems": 0, "title": "Media Resource Group List", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/MediaResourceList", "type": [ "string", "null" ], "target": "/api/device/cucm/MediaResourceList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartyNationalStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Called Party National Strip Digits" }, "mobilityCssName": { "description": " Choose the appropriate calling search space to be used as the device calling search space when the device is roaming and in same device mobility group. ", "format": "uri", "minItems": 0, "title": "Device Mobility Calling Search Space", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "calledPartySubscriberStripDigits": { "minItems": 0, "required": false, "type": [ "integer", "null" ], "maxItems": 1, "title": "Called Party Subscriber Strip Digits" }, "automatedAlternateRoutingCssName": { "description": " Choose the appropriate calling search space for the device to use when automated alternate routing (AAR) is performed. The AAR calling search space specifies the collection of route partitions that are searched to determine how to route a collected (originating) number that is otherwise blocked due to insufficient bandwidth. ", "format": "uri", "minItems": 0, "title": "AAR Calling Search Space", "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "type": [ "string", "null" ], "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "callingPartyUnknownPrefix": { "title": "Calling Party Unknown Prefix", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 16, "type": "string" }, "calledPartyInternationalTransformationCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Called Party International Transformation Css Name", "type": [ "string", "null" ] } }, "schema_version": "2.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/HcsLocalRouteGroupREL/add/ |
|
The GUI Add form of relation/HcsLocalRouteGroupREL as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Create | POST | /api/relation/HcsLocalRouteGroupREL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsLocalRouteGroupREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsLocalRouteGroupREL/[pkid1]", "/api/relation/HcsLocalRouteGroupREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsLocalRouteGroupREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsLocalRouteGroupREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsLocalRouteGroupREL/export/ |
|
{ "hrefs":["/api/relation/HcsLocalRouteGroupREL/[pkid1]", "/api/relation/HcsLocalRouteGroupREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsLocalRouteGroupREL and the JSON format can be used to import instances of relation/HcsLocalRouteGroupREL.
GET http://[host-proxy]/api/relation/HcsLocalRouteGroupREL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/HcsLocalRouteGroupREL | POST | /api/relation/HcsLocalRouteGroupREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/HcsLocalRouteGroupREL/ |
|
The relation/HcsLocalRouteGroupREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsLocalRouteGroupREL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "list", "update", "remove", "add", "bulk_update", "export", "export_bulkload_template" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/HcsLocalRouteGroupREL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 9 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2.1", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/HcsLocalRouteGroupREL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/HcsLocalRouteGroupREL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/HcsLocalRouteGroupREL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsLocalRouteGroupREL/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/HcsLocalRouteGroupREL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/HcsLocalRouteGroupREL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/HcsLocalRouteGroupREL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/HcsLocalRouteGroupREL", "model_specific_actions": [ "help", "get", "clone", "list", "update", "remove", "add", "export", "export_bulkload_template" ], "summary_attrs": [ { "name": "name", "title": "Device Pool Name" }, { "name": "callManagerGroupName", "title": "Cisco Unified Communications Manager Group" }, { "name": "regionName", "title": "Region" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "5f3ae81bce894e001205c1e4", "meta": { "tags": [], "cached": true, "title": "Cu1Si1-DevicePool", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae81bce894e001205c1e4", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/" } ], "parent": [ { "pkid": "5f3ae615ce894e001205697d", "href": "/api/data/HierarchyNode/5f3ae615ce894e001205697d" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/help", "method": "GET", "title": "Help" } }, { "apply": { "support_async": true, "class": "custom", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/+apply/", "method": "POST", "title": "Apply" } } ], "model_type": "relation/HcsLocalRouteGroupREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5bace894e00120559f8", "5f3ae615ce894e001205697d", "5f3ae81bce894e001205c1e4" ], "summary_attrs": [ { "name": "name", "title": "Device Pool Name" }, { "name": "callManagerGroupName", "title": "Cisco Unified Communications Manager Group" }, { "name": "regionName", "title": "Region" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "deviceMobilityGroupName": null, "calledPartyUnknownTransformationCssName": null, "callingPartyUnknownTransformationCssName": null, "calledPartySubscriberTransformationCssName": null, "callingPartyNationalTransformationCssName": null, "adjunctCallingSearchSpace": null, "calledPartyUnknownStripDigits": null, "autoSearchSpaceName": null, "hierarchy_friendly_name": "CL1-AB-C-Paris (Site)", "regionName": "Cu1Si1-Region", "calledPartySubscriberPrefix": "Default", "callManagerGroupName": "Default", "calledPartyUnknownPrefix": "Default", "singleButtonBarge": "Default", "callingPartyTransformationCSS": null, "calledPartyNationalPrefix": "Default", "callingPartyUnknownStripDigits": null, "callingPartyInternationalTransformationCssName": null, "networkLocale": null, "callingPartySubscriberPrefix": "Default", "calledPartyNationalTransformationCssName": null, "cgpnTransformationCssName": null, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "connectionMonitorDuration": -1, "mobilityCssName": null, "localRouteGroup": [ {} ], "calledPartyInternationalStripDigits": null, "revertPriority": "Default", "redirectingPartyTransformationCSS": null, "geoLocationName": null, "calledPartyInternationalPrefix": "Default", "dateTimeSettingName": "CMLocal", "callingPartyNationalStripDigits": null, "elinGroup": null, "joinAcrossLines": "Default", "cdpnTransformationCssName": null, "callingPartySubscriberStripDigits": null, "imeEnrolledPatternGroupName": null, "callingPartyNationalPrefix": "Default", "aarNeighborhoodName": null, "callingPartyInternationalPrefix": "Default", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Paris", "name": "Cu1Si1-DevicePool", "cntdPnTransformationCssName": null, "callingPartySubscriberTransformationCssName": null, "wirelessLanProfileGroup": null, "geoLocationFilterName": null, "srstName": "Disable", "locationName": "Cu1Si1-Location", "physicalLocationName": null, "mediaResourceListName": null, "calledPartyNationalStripDigits": null, "callingPartyInternationalStripDigits": null, "calledPartySubscriberStripDigits": null, "automatedAlternateRoutingCssName": null, "callingPartyUnknownPrefix": "Default", "calledPartyInternationalTransformationCssName": null } }, { "pkid": "5f3ae841ce894e001205d202", "meta": { "tags": [], "cached": true, "title": "Cu1Si2-DevicePool", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae841ce894e001205d202", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/" } ], "parent": [ { "pkid": "5f3ae621ce894e0012056c72", "href": "/api/data/HierarchyNode/5f3ae621ce894e0012056c72" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/help", "title": "Help", "class": "help", "method": "GET" } }, { "apply": { "support_async": true, "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae841ce894e001205d202/+apply/", "title": "Apply", "class": "custom", "method": "POST" } } ], "model_type": "relation/HcsLocalRouteGroupREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5bace894e00120559f8", "5f3ae621ce894e0012056c72", "5f3ae841ce894e001205d202" ], "summary_attrs": [ { "name": "name", "title": "Device Pool Name" }, { "name": "callManagerGroupName", "title": "Cisco Unified Communications Manager Group" }, { "name": "regionName", "title": "Region" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "deviceMobilityGroupName": null, "calledPartyUnknownTransformationCssName": null, "callingPartyUnknownTransformationCssName": null, "calledPartySubscriberTransformationCssName": null, "callingPartyNationalTransformationCssName": null, "adjunctCallingSearchSpace": null, "calledPartyUnknownStripDigits": null, "autoSearchSpaceName": null, "hierarchy_friendly_name": "CL1-AB-C-Grenoble (Site)", "regionName": "Cu1Si2-Region", "calledPartySubscriberPrefix": "Default", "callManagerGroupName": "Default", "calledPartyUnknownPrefix": "Default", "singleButtonBarge": "Default", "callingPartyTransformationCSS": null, "calledPartyNationalPrefix": "Default", "callingPartyUnknownStripDigits": null, "callingPartyInternationalTransformationCssName": null, "networkLocale": null, "callingPartySubscriberPrefix": "Default", "calledPartyNationalTransformationCssName": null, "cgpnTransformationCssName": null, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "connectionMonitorDuration": -1, "mobilityCssName": null, "localRouteGroup": [ {} ], "calledPartyInternationalStripDigits": null, "revertPriority": "Default", "redirectingPartyTransformationCSS": null, "geoLocationName": null, "calledPartyInternationalPrefix": "Default", "dateTimeSettingName": "CMLocal", "callingPartyNationalStripDigits": null, "elinGroup": null, "joinAcrossLines": "Default", "cdpnTransformationCssName": null, "callingPartySubscriberStripDigits": null, "imeEnrolledPatternGroupName": null, "callingPartyNationalPrefix": "Default", "aarNeighborhoodName": null, "callingPartyInternationalPrefix": "Default", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Grenoble", "name": "Cu1Si2-DevicePool", "cntdPnTransformationCssName": null, "callingPartySubscriberTransformationCssName": null, "wirelessLanProfileGroup": null, "geoLocationFilterName": null, "srstName": "Disable", "locationName": "Cu1Si2-Location", "physicalLocationName": null, "mediaResourceListName": null, "calledPartyNationalStripDigits": null, "callingPartyInternationalStripDigits": null, "calledPartySubscriberStripDigits": null, "automatedAlternateRoutingCssName": null, "callingPartyUnknownPrefix": "Default", "calledPartyInternationalTransformationCssName": null } }, { "pkid": "5f3ae875ce894e001205e212", "meta": { "tags": [], "cached": true, "title": "Cu1Si3-DevicePool", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae875ce894e001205e212", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/" } ], "parent": [ { "pkid": "5f3ae62dce894e0012056f66", "href": "/api/data/HierarchyNode/5f3ae62dce894e0012056f66" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/help", "class": "help", "title": "Help" } }, { "apply": { "support_async": true, "method": "POST", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae875ce894e001205e212/+apply/", "class": "custom", "title": "Apply" } } ], "model_type": "relation/HcsLocalRouteGroupREL", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae5bace894e00120559f8", "5f3ae62dce894e0012056f66", "5f3ae875ce894e001205e212" ], "summary_attrs": [ { "name": "name", "title": "Device Pool Name" }, { "name": "callManagerGroupName", "title": "Cisco Unified Communications Manager Group" }, { "name": "regionName", "title": "Region" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "deviceMobilityGroupName": null, "calledPartyUnknownTransformationCssName": null, "callingPartyUnknownTransformationCssName": null, "calledPartySubscriberTransformationCssName": null, "callingPartyNationalTransformationCssName": null, "adjunctCallingSearchSpace": null, "calledPartyUnknownStripDigits": null, "autoSearchSpaceName": null, "hierarchy_friendly_name": "CL1-AB-C-Rennes (Site)", "regionName": "Cu1Si3-Region", "calledPartySubscriberPrefix": "Default", "callManagerGroupName": "Default", "calledPartyUnknownPrefix": "Default", "singleButtonBarge": "Default", "callingPartyTransformationCSS": null, "calledPartyNationalPrefix": "Default", "callingPartyUnknownStripDigits": null, "callingPartyInternationalTransformationCssName": null, "networkLocale": null, "callingPartySubscriberPrefix": "Default", "calledPartyNationalTransformationCssName": null, "cgpnTransformationCssName": null, "summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group", "connectionMonitorDuration": -1, "mobilityCssName": null, "localRouteGroup": [ {} ], "calledPartyInternationalStripDigits": null, "revertPriority": "Default", "redirectingPartyTransformationCSS": null, "geoLocationName": null, "calledPartyInternationalPrefix": "Default", "dateTimeSettingName": "CMLocal", "callingPartyNationalStripDigits": null, "elinGroup": null, "joinAcrossLines": "Default", "cdpnTransformationCssName": null, "callingPartySubscriberStripDigits": null, "imeEnrolledPatternGroupName": null, "callingPartyNationalPrefix": "Default", "aarNeighborhoodName": null, "callingPartyInternationalPrefix": "Default", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL1-AB-C-Rennes", "name": "Cu1Si3-DevicePool", "cntdPnTransformationCssName": null, "callingPartySubscriberTransformationCssName": null, "wirelessLanProfileGroup": null, "geoLocationFilterName": null, "srstName": "Disable", "locationName": "Cu1Si3-Location", "physicalLocationName": null, "mediaResourceListName": null, "calledPartyNationalStripDigits": null, "callingPartyInternationalStripDigits": null, "calledPartySubscriberStripDigits": null, "automatedAlternateRoutingCssName": null, "callingPartyUnknownPrefix": "Default", "calledPartyInternationalTransformationCssName": null } } ] }
(Show the first instance)
{ "pkid": "5f3ae81bce894e001205c1e4", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Cu1Si1-DevicePool", "business_key": {}, "schema_version": "2.1", "references": { "device": [ { "pkid": "5f3ae58ace894e00120550c2", "href": "/api/v0/data/CallManager/5f3ae58ace894e00120550c2" } ], "self": [ { "pkid": "5f3ae81bce894e001205c1e4", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/" } ], "children": [], "parent": [ { "pkid": "5f3ae615ce894e001205697d", "href": "/api/data/HierarchyNode/5f3ae615ce894e001205697d" } ] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "apply": { "support_async": true, "class": "custom", "href": "/api/relation/HcsLocalRouteGroupREL/5f3ae81bce894e001205c1e4/+apply/?hierarchy=[hierarchy]", "method": "POST", "title": "Apply" } } ], "model_type": "relation/HcsLocalRouteGroupREL", "summary_attrs": [ { "name": "name", "title": "Device Pool Name" }, { "name": "callManagerGroupName", "title": "Cisco Unified Communications Manager Group" }, { "name": "regionName", "title": "Region" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "deviceMobilityGroupName": null, "calledPartyUnknownTransformationCssName": null, "callingPartyUnknownTransformationCssName": null, "calledPartySubscriberTransformationCssName": null, "callingPartyNationalTransformationCssName": null, "adjunctCallingSearchSpace": null, "calledPartyUnknownStripDigits": null, "autoSearchSpaceName": null, "regionName": "Cu1Si1-Region", "calledPartySubscriberPrefix": "Default", "callManagerGroupName": "Default", "calledPartyUnknownPrefix": "Default", "singleButtonBarge": "Default", "callingPartyTransformationCSS": null, "calledPartyNationalPrefix": "Default", "callingPartyUnknownStripDigits": null, "callingPartyInternationalTransformationCssName": null, "networkLocale": null, "callingPartySubscriberPrefix": "Default", "calledPartyNationalTransformationCssName": null, "cgpnTransformationCssName": null, "srstName": "Disable", "connectionMonitorDuration": -1, "localRouteGroup": [ {} ], "calledPartyInternationalStripDigits": null, "revertPriority": "Default", "redirectingPartyTransformationCSS": null, "geoLocationName": null, "calledPartyInternationalPrefix": "Default", "dateTimeSettingName": "CMLocal", "callingPartyNationalStripDigits": null, "elinGroup": null, "joinAcrossLines": "Default", "cdpnTransformationCssName": null, "shadow": [], "callingPartySubscriberStripDigits": null, "imeEnrolledPatternGroupName": null, "callingPartyNationalPrefix": "Default", "callingPartyInternationalPrefix": "Default", "callingPartyInternationalStripDigits": null, "name": "Cu1Si1-DevicePool", "cntdPnTransformationCssName": null, "callingPartySubscriberTransformationCssName": null, "wirelessLanProfileGroup": null, "geoLocationFilterName": null, "aarNeighborhoodName": null, "locationName": "Cu1Si1-Location", "physicalLocationName": null, "mediaResourceListName": null, "calledPartyNationalStripDigits": null, "mobilityCssName": null, "calledPartySubscriberStripDigits": null, "automatedAlternateRoutingCssName": null, "callingPartyUnknownPrefix": "Default", "calledPartyInternationalTransformationCssName": null } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/HcsLocalRouteGroupREL. | GET | /api/relation/HcsLocalRouteGroupREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsLocalRouteGroupREL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/HcsLocalRouteGroupREL/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/HcsLocalRouteGroupREL/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsLocalRouteGroupREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsLocalRouteGroupREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsLocalRouteGroupREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsLocalRouteGroupREL/[pkid]/export |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsLocalRouteGroupREL and the JSON format can be used to import instances of relation/HcsLocalRouteGroupREL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/HcsLocalRouteGroupREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsLocalRouteGroupREL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/HcsLocalRouteGroupREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsLocalRouteGroupREL. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Apply | POST | /api/relation/HcsLocalRouteGroupREL/[pkid]/+apply | hierarchy=[hierarchy] | If payload required: |