[Index]
Relation for Hunt Group elements (including Pilot, List)
Model ref.: relation/HuntGroupRelation
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": {
"parkMonForwardNoRetrieve": {
"title": "Park Mon Forward No Retrieve",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"destination": {
"name": "destination",
"title": "Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"usePersonalPreferences": {
"name": "usePersonalPreferences",
"title": "Use Personal Preferences",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"title": "Calling Search Space No Retrieve External",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
}
}
},
"asciiAlertingName": {
"description": " Enter an alerting name for the hunt pilot in ASCII format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones. ",
"title": "ASCII Alerting Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 32,
"type": [
"string",
"null"
]
},
"callingPartyPrefixDigits": {
"description": " Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The appended prefix digit does not affect which directory numbers route to the assigned device. \n \n \n ",
"title": "Prefix Digits",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"blockEnable": {
"title": "Block this pattern",
"minItems": 1,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean",
"description": "If the checkbox is checked, then block this pattern. Also choose the required Release Clause. If the checkbox is unchecked, then Route this pattern."
},
"prefixDigitsOut": {
"description": " Enter prefix digits in the Prefix Digits (Outgoing Calls) field. Valid entries include the digits 0 through 9; the wildcard characters asterisk (*) and octothorpe (#); the international escape character +; and blank. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The appended prefix digit does not affect which directory numbers route to the assigned device. \n \n \n ",
"title": "Prefix Digits",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"callingPartyNumberingPlan": {
"description": " Choose the format for the numbering plan in calling party directory numbers. Cisco Unified Communications Manager sets the calling DN numbering plan. We recommend that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because your system does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non-national type number. Choose one of the following options: \n \n \n \n Cisco Unified Communications Manager\u2014Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number. \n \n ISDN\u2014Use when you are dialing outside the dialing plan for your country. \n \n National Standard\u2014Use when you are dialing within the dialing plan for your country. \n \n Private\u2014Use when you are dialing within a private network. \n \n Unknown\u2014Use when the dialing plan is unknown. \n ",
"title": "Calling Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"connectedLinePresentationBit": {
"description": " Cisco Unified Communications Manager uses connected line ID presentation (COLP/COLR) as a supplementary service to allow or restrict the called party phone number on a call-by-call basis. Choose whether you want Cisco Unified Communications Manager to allow or restrict the display of the connected party phone number on the calling party phone display for this hunt pilot. Choose Default if you do not want to change the connected line ID presentation. Choose Allowed if you want to display the connected party phone number. Choose Restricted if you want Cisco Unified Communications Manager to block the display of the connected party phone number. If a call that originates from an IP phone on your system encounters a device, such as a trunk, gateway, or route pattern, that has the Connected Line ID Presentation set to Default, the presentation value is automatically set to Allowed. ",
"title": "Connected Line ID Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callPickupGroupName": {
"description": "Choose the number that can be dialed to answer calls to this directory number (in the specified partition). \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n The Call Pickup Group setting has been moved to this section from the Forward settings section.\n \n \n \n ",
"title": "Call Pickup Group",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"routePartitionName": {
"description": " If you want to use a partition to restrict access to the hunt pilot, choose the desired partition from the drop-down list box. If you do not want to restrict access to the hunt pilot, choose <None> for the partition. You can configure the number of partitions that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more partitions exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Partitions window, then find and choose a partition name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters. \n \n \n \n \n \n \n Note\u00a0\u00a0\u00a0 \n Make sure that the combination of hunt pilot, route filter, and partition is unique within the Cisco Unified Communications Manager cluster. \n \n \n ",
"title": "Route Partition",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/RoutePartition",
"choices": []
},
"releaseClause": {
"title": "Block this pattern",
"minItems": 0,
"required": false,
"choices": [
{
"value": "No Error",
"title": "No Error"
},
{
"value": "Unallocated Number",
"title": "Unallocated Number"
},
{
"value": "Call Rejected",
"title": "Call Rejected"
},
{
"value": "Number Changed",
"title": "Number Changed"
},
{
"value": "Invalid Number Format",
"title": "Invalid Number Format"
},
{
"value": "Precedence Level Exceeded",
"title": "Precedence Level Exceeded"
}
],
"default": "No Error",
"maxItems": 1,
"type": "string"
},
"displayConnectedNumber": {
"description": "Check this check box to display the directory number of the answering phone as the connected party when a call is routed through a hunt list. Uncheck this check box to display the hunt pilot number as the connected party when a call is routed through a hunt list. ",
"title": "Display Line Group Member DN as Connected Party",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"calledPartyNumberingPlan": {
"description": " Choose the format for the numbering plan in called party directory numbers. Cisco Unified Communications Manager sets the called DN numbering plan. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because your system does not recognize European national dialing patterns. You can also change this setting when you are connecting to PBXs by using routing as a non-national type number. Choose one of the following options: \n \n \n \n Cisco Unified Communications Manager\u2014Use when the Cisco Unified Communications Manager sets the Numbering Plan in the directory number. \n \n ISDN\u2014Use when you are dialing outside the dialing plan for your country. \n \n National Standard\u2014Use when you are dialing within the dialing plan for your country. \n \n Private\u2014Use when you are dialing within a private network. \n \n Unknown\u2014Use when the dialing plan is unknown. \n ",
"title": "Called Party Numbering Plan",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "ISDN",
"title": "ISDN"
},
{
"value": "National Standard",
"title": "National Standard"
},
{
"value": "Private",
"title": "Private"
},
{
"value": "Unknown",
"title": "Unknown"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"callingPartyNumberType": {
"description": " Choose the format for the number type in calling party directory numbers. Cisco Unified Communications Manager sets the calling directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because your system does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the calling directory number to be encoded to a non-national numbering plan type. Choose one of the following options: \n \n \n \n Cisco Unified Communications Manager\u2014The Cisco Unified Communications Manager sets the directory number type. \n \n Unknown\u2014The dialing plan is unknown. \n \n National\u2014Use when you are dialing within the dialing plan for your country. \n \n International\u2014Use when you are dialing outside the dialing plan for your country. \n \n Subscriber\u2014Use when you are dialing a subscriber by using a shortened subscriber number. \n ",
"title": "Calling Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"provideOutsideDialtone": {
"description": " Provide Outside Dial Tone indicates that Cisco Unified Communications Manager routes the calls off the local network. Check this check box for each hunt pilot that routes the call off the local network and provides outside dial tone to the calling device. To route the call in the network, leave the check box unchecked. ",
"title": "Provide Outside Dial Tone",
"minItems": 0,
"required": false,
"default": true,
"maxItems": 1,
"type": "boolean"
},
"calledPartyTransformationMask": {
"description": " Enter a transformation mask value. Valid entries include the digits 0 through 9; the wildcard characters X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If the field is blank, no transformation takes place. Cisco Unified Communications Manager sends the dialed digits exactly as dialed. ",
"title": "Called Party Transform Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"pattern": {
"description": " Enter the hunt pilot, including numbers and wildcards (do not use spaces); for example, for NANP, enter 9.@ for typical local access, or 8XXX for a typical private network numbering plan. Valid characters include the uppercase characters A, B, C, and D and \\+, which represents the international escape character +. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Ensure that the directory hunt pilot, which uses the chosen partition, route filter, and numbering plan combination, is unique. Check the hunt pilot, translation pattern, directory number, call park number, call pickup number, message waiting on/off, or meet me number if you receive an error that indicates duplicate entries. You can also check the route plan report. \n \n \n ",
"title": "Hunt Pilot",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"patternPrecedence": {
"description": " Choose an MLPP precedence setting for this hunt pilot from the drop-down list box: \n \n \n \n Executive Override\u2014Highest precedence setting for MLPP calls. \n \n Flash Override\u2014Second highest precedence setting for MLPP calls. \n \n Flash\u2014Third highest precedence setting for MLPP calls. \n \n Immediate\u2014Fourth highest precedence setting for MLPP calls. \n \n Priority\u2014Fifth highest precedence setting for MLPP calls. \n \n Routine\u2014Lowest precedence setting for MLPP calls. \n \n Default\u2014Does not override the incoming precedence level but rather lets it pass unchanged. \n ",
"title": "MLPP Precedence",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Flash Override",
"title": "Flash Override"
},
{
"value": "Flash",
"title": "Flash"
},
{
"value": "Immediate",
"title": "Immediate"
},
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Routine",
"title": "Routine"
},
{
"value": "Default",
"title": "Default"
},
{
"value": "Executive Override",
"title": "Executive Override"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingLinePresentationBit": {
"description": " Cisco Unified Communications Manager uses calling line ID presentation (CLIP/CLIR) as a supplementary service to allow or restrict the originating caller phone number on a call-by-call basis. Choose whether you want the Cisco Unified Communications Manager to allow or restrict the display of the calling party phone number on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling line ID presentation. Choose Allowed if you want your system to allow the display of the calling number. Choose Restricted if you want your system to block the display of the calling number. ",
"title": "Calling Line ID Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"maxHuntduration": {
"description": "Value \"-1\" in the response means no value has been assigned and internally the CM will use default setting i.e., 1800s.",
"title": "Maximum Hunt Timer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"integer",
"null"
]
},
"huntListName": {
"description": " Choose the hunt list for which you are adding a hunt pilot from the drop-down list box. After you choose a hunt list, click the Edit link to the right to edit the hunt list. ",
"title": "Hunt List",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/HuntList/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"target_model_type": "device/cucm/HuntList",
"choices": []
},
"alertingName": {
"description": " Enter an alerting name for the hunt pilot in UNICODE format. This name gets displayed on phones that the hunt pilot dials when it receives an incoming call, along with calling party information. The phone users can use this information to answer the call accordingly. This name also gets displayed on the calling phone. If you do not enter a name, the hunt pilot DN displays on the phones. ",
"title": "Alerting Name",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"connectedNamePresentationBit": {
"description": " Cisco Unified Communications Manager uses connected name presentation (CONP/CONR) as a supplementary service to allow or restrict the called party name on a call-by-call basis. Choose whether you want your system to allow or restrict the display of the connected party name on the calling party phone display for this hunt pilot. Choose Default if you do not want to change the connected name presentation. Choose Allowed if you want to display the connected party name. Choose Restricted if you want your system to block the display of the connected party name. ",
"title": "Connected Name Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"description": {
"description": " Enter a description of the hunt pilot. The description can include up to 50 characters in any language, but it cannot include double-quotes (\"), percentage sign (%), ampersand (&), or angle brackets (<>). ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"callingNamePresentationBit": {
"description": " Cisco Unified Communications Manager uses calling name presentation (CNIP/CNIR) as a supplementary service to allow or restrict the originating caller name on a call-by-call basis. Choose whether you want the your system to allow or restrict the display of the calling party name on the called party phone display for this hunt pilot. Choose Default if you do not want to change calling name presentation. Choose Allowed if you want your system to display the calling name information. Choose Restricted if you want your system to block the display of the calling name information. ",
"title": "Calling Name Presentation",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"dialPlanName": {
"description": " Choose a numbering plan. ",
"title": "Numbering Plan",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/DialPlan/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/DialPlan",
"choices": []
},
"e164Mask": {
"description": " Enter an external number mask value for the hunt pilot. Cisco Unified Communications Manager uses this mask to format calling line identification for external (outbound) calls. When AAR initiates a reroute, the system applies this external number mask to the hunt pilot number to form a fully qualified DN of the called party, which allows AAR to reroute properly in out-of-bandwidth conditions. ",
"title": "External Number Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"digitDiscardInstructionName": {
"title": "Digit Discard Instruction Name",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/DiscardDigitInstruction/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/DiscardDigitInstruction",
"choices": []
},
"useCallingPartyPhoneMask": {
"description": " Check the check box if you want the full, external phone number to be used for calling line identification (CLID) on outgoing calls. You may also configure an External Phone Number Mask on all phone devices. \n \n \n \n Note\u00a0\u00a0\u00a0 \n The calling party transformation settings that are assigned to the line groups in a hunt list override any calling party transformation settings that are assigned to a hunt pilot that is associated with that hunt list. \n \n \n ",
"title": "Use Calling Party's External Phone Number Mask",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
},
{
"value": "Default",
"title": "Default"
}
],
"default": "Default",
"maxItems": 1,
"type": "string"
},
"callingPartyTransformationMask": {
"description": " Enter a transformation mask value. Valid entries include the digits 0 through 9, the wildcard character X, asterisk (*), and octothorpe (#); the international escape character +; and blank. If this field is blank and the preceding field is not checked, no calling party transformation takes place. ",
"title": "Calling Party Transform Mask",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"calledPartyNumberType": {
"description": " Choose the format for the number type in called party directory numbers. Cisco Unified Communications Manager sets the called directory number (DN) type. Cisco recommends that you do not change the default value unless you have advanced experience with dialing plans such as NANP or the European dialing plan. You may need to change the default in Europe because your system does not recognize European national dialing patterns. You can also change this setting when you are connecting to a PBX that expects the called directory number to be encoded to a non-national type numbering plan. Choose one of the following options: \n \n \n \n Cisco Unified Communications Manager\u2014Use when the Cisco Unified Communications Manager sets the directory number type. \n \n Unknown\u2014Use when the dialing plan is unknown. \n \n National\u2014Use when you are dialing within the dialing plan for your country. \n \n International\u2014Use when you are dialing outside the dialing plan for your country. \n \n Subscriber\u2014Use when you are dialing a subscriber by using a shortened subscriber number. \n ",
"title": "Called Party Number Type",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"default": "Cisco CallManager",
"maxItems": 1,
"type": "string"
},
"queueCalls": {
"title": "Queue Calls",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"maxCallersInQueue": {
"description": "Enter an integer value for the number of callers allowed in the queue for this hunt pilot. The default value is 32. The field range is from 1 to 100. When the maximum number of callers in queue has been reached, and if subsequent calls need to be disconnected, select the \u201cDisconnect the call\u201d radio button. When the maximum number of callers in queue has been reached, and if subsequent calls need to be routed to a secondary destination, select the \u201cRoute the call to this destination\u201d radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the \u201cFull Queue Calling Search Space\u201d from the drop-down list (optional). ",
"title": "Maximum Number of Callers Allowed in Queue",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer",
"name": "maxCallersInQueue"
},
"callingSearchSpacePilotQueueFull": {
"name": "callingSearchSpacePilotQueueFull",
"title": "Full Queue Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"networkHoldMohAudioSourceID": {
"name": "networkHoldMohAudioSourceID",
"title": "Network Hold MOH Source & Announcements",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "sourceId",
"maxItems": 1,
"type": [
"string",
"null",
"integer"
],
"target": "/api/device/cucm/MohAudioSource/choices/?field=sourceId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/MohAudioSource",
"choices": []
},
"queueFullDestination": {
"name": "queueFullDestination",
"title": "Queue Full Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"callingSearchSpaceNoAgent": {
"name": "callingSearchSpaceNoAgent",
"title": "No hunt members logged in or registered Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"noAgentDestination": {
"name": "noAgentDestination",
"title": "No Agent Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
},
"callingSearchSpaceMaxWaitTime": {
"name": "callingSearchSpaceMaxWaitTime",
"title": "Maximum Wait Time Calling Search Space",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
},
"maxWaitTimeInQueue": {
"description": "Enter an integer value to set the maximum wait time, in seconds, in a queue. The default value is 900 seconds. The field range is from 10 to 3600 seconds. When the maximum wait time in queue has been reached, and if the queued caller needs to be disconnected, select the \u201cDisconnect the call\u201d radio button. When the maximum wait time in queue has been reached, and if the queued caller needs to be routed to a secondary destination, select the \u201cRoute the call to this destination\u201d radio button. Provide a specific device DN, shared line DN, or another Hunt Pilot DN. You may also select the \u201cMaximum Wait Time Calling Search Space\u201d from the drop-down list (optional). ",
"title": "Maximum Wait Time in Queue",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "integer",
"name": "maxWaitTimeInQueue"
},
"maxWaitTimeDestination": {
"name": "maxWaitTimeDestination",
"title": "Max Wait Time Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"maxLength": 50,
"type": [
"string",
"null"
]
}
}
},
"routeFilterName": {
"description": " If your hunt pilot includes the @ wildcard, you may choose a route filter. The optional act of choosing a route filter restricts certain number patterns. The route filters that display depend on the numbering plan that you choose from the Numbering Plan drop-down list box. You can configure the number of items that display in this drop-down list box by using the Max List Box Items enterprise parameter. If more route filters exist than the Max List Box Items enterprise parameter specifies, the Find button displays next to the drop-down list box. Click the Find button to display the Find and List Route Filters window, then find and choose a route filter name. \n \n \n \n Note\u00a0\u00a0\u00a0 \n To set the maximum list box items, choose System > Enterprise Parameters and choose Unified CMAdmin Parameters. \n \n \n ",
"title": "Route Filter",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RouteFilter/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/RouteFilter",
"choices": []
},
"forwardHuntNoAnswer": {
"title": "Forward Hunt No Answer",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"destination": {
"description": " When a call that was routed via the hunt list is parked, the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter value is used (unless it is blank) to forward the parked call when the service parameter Park Monitoring Forward No Retrieve Timer expires. If the parameter value of the Hunt Pilot Park Monitoring Forward No Retrieve Destination parameter is blank, then the call will be forwarded to the destination configured in the Directory Number Configuration window when the Park Monitoring Forward No Retrieve Timer expires. Specify the following values: \n \n \n \n Destination\u2014This setting specifies the directory number to which a parked call is forwarded when the service parameter Park Monitoring Forward No Retrieve Timer expires. Use any dialable phone number, including an outside destination. \n \n Calling Search Space\u2014A calling search space comprises an ordered list of route partitions that are typically assigned to devices. Calling search spaces determine the partitions that calling devices search when they are attempting to complete a call. \n ",
"title": "CFNA Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
],
"name": "destination"
},
"usePersonalPreferences": {
"name": "usePersonalPreferences",
"title": "Use Personal Preferences",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"title": "CSS CFNA",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
}
}
},
"patternUrgency": {
"description": " If the dial plan contains overlapping hunt lists, Cisco Unified Communications Manager would not route the call until the interdigit timer expires (even if it is possible to dial a sequence of digits to choose a current match). Check this check box to interrupt interdigit timing when Cisco Unified Communications Manager must route a call immediately. ",
"title": "Urgent Priority",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "boolean"
},
"aarNeighborhoodName": {
"description": " Choose an Automated Alternate Routing (AAR) group from the drop-down list box. ",
"title": "AAR Group",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/AarGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/AarGroup",
"choices": []
},
"forwardHuntBusy": {
"title": "Forward Hunt Busy",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"destination": {
"name": "destination",
"title": "CFB Destination",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"string",
"null"
]
},
"usePersonalPreferences": {
"name": "usePersonalPreferences",
"title": "Use Personal Preferences",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"callingSearchSpaceName": {
"name": "callingSearchSpaceName",
"title": "CSS CFB",
"minItems": 0,
"format": "uri",
"required": false,
"target_attr": "name",
"maxItems": 1,
"type": [
"string",
"null"
],
"target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "device/cucm/Css",
"choices": []
}
}
},
"HuntList": {
"title": "Hunt List",
"type": "object",
"properties": {
"callManagerGroupName": {
"description": "Choose a \n Cisco Unified Communications Manager Group from the drop-down list. The Hunt List registers to the first node in the \n Cisco Unified Communications Manager Group. \n \n \n \n Note\u00a0\u00a0\u00a0 \n If you choose a \n Cisco Unified Communications Manager group that has only one node that is configured, you receive a warning. To avoid this issue, choose a group that is configured with more than one node. \n \n \n ",
"title": "Cisco Unified Communications Manager Group",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/CallManagerGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"target_model_type": "device/cucm/CallManagerGroup",
"choices": []
},
"description": {
"description": "Enter a description to help you identify further details about the hunt list that do not fit into the name. ",
"title": "Description",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": "string"
},
"routeListEnabled": {
"description": "Check this check box to enable your hunt list immediately when you click Save. No system reset is required. ",
"title": "Enable this Hunt List (change effective on Save; no reset required)",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"members": {
"title": "Members",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"selectionOrder": {
"name": "selectionOrder",
"title": "Selection Order",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
},
"lineGroupName": {
"name": "lineGroupName",
"title": "Line Group Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"string",
"null"
]
}
}
},
"required": false,
"type": "array"
}
}
},
"voiceMailUsage": {
"description": "If this hunt list is to be used for voicemail, check this check box. If you this check box, the route list control process keeps a count of the setups that are being served to the hunt list, and will not allow more setups than the number of available devices. As a result, each device in the hunt list is treated as if it has a Busy Trigger and related Maximum Number of Calls of one. ",
"title": "For Voice Mail Usage",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
},
"name": {
"description": "The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure each hunt list name is unique to the route plan. \n \n \n \n Note\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your hunt lists. The CompanynameLocationCalltype format provides enough detail and is short enough so you can easily identify a hunt list. \n \n \n ",
"title": "Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"LineGroup": {
"title": "Line Group",
"type": "array",
"items": {
"type": "object",
"properties": {
"huntAlgorithmNoAnswer": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that does not answer. This option gets applied at the member level. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group when the RNA reversion timeout value elapses for the first member. Cisco Unified Communications Manager then proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first member of this line group and the member does not answer the call. \n ",
"title": "No Answer",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"name": {
"description": " Enter a name for this line group. The name can comprise up to 50 alphanumeric characters and can contain any combination of spaces, periods (.), hyphens (-), and underscore characters (_). Ensure that each line group name is unique to the route plan. \n \n \n \n Timesaver\u00a0\u00a0\u00a0 \n Use concise and descriptive names for your line groups. The CompanynameLocationGroup format usually provides a sufficient level of detail and is short enough to enable you to quickly and easily identify a line group. For example, CiscoDallasAA1 identifies a Cisco Access Analog line group for the Cisco office in Dallas. \n \n \n ",
"title": "Line Group Name",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": "string"
},
"distributionAlgorithm": {
"description": " Choose a distribution algorithm, which applies at the line-group level, from the options in the drop-down list box: \n \n \n \n Top Down\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. \n \n Circular\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to idle or available members starting from the (n+1)th member of a route group, where the nth member is the next sequential member in the list who is either idle or busy but not \"down.\" If the nth member is the last member of a route group, Cisco Unified Communications Manager distributes a call starting from the top of the route group. \n \n Longest Idle Time\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager only distributes a call to idle members, starting from the longest idle member to the least idle member of a line group. \n \n Broadcast\u2014If you choose this distribution algorithm, Cisco Unified Communications Manager distributes a call to all idle or available members of a line group simultaneously. See the Note in the description of the Selected DN/Route Partition field for additional limitations in using the Broadcast distribution algorithm. \n The default value specifies Longest Idle Time. ",
"title": "Distribution Algorithm",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Top Down",
"title": "Top Down"
},
{
"value": "Circular",
"title": "Circular"
},
{
"value": "Longest Idle Time",
"title": "Longest Idle Time"
},
{
"value": "Broadcast",
"title": "Broadcast"
}
],
"default": "Longest Idle Time",
"maxItems": 1,
"type": "string"
},
"huntAlgorithmNotAvailable": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is not available. The Not Available condition occurs when none of the phones that are associated with the DN in question is registered. Not Available also occurs when extension mobility is in use and the DN/user is not logged in. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering the first unavailable member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first unavailable member of this line group. \n ",
"title": "Not Available",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"members": {
"title": "Members",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"member": {
"name": "member",
"title": "Member",
"minItems": 0,
"items": {
"type": [
"object",
"null"
],
"properties": {
"directoryNumber": {
"description": "The uuid attribute is read here",
"title": "Directory Number",
"minItems": 1,
"required": true,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"pattern": {
"description": " Enter the character(s) that are found in the directory number that you are seeking and click the Find button. Directory numbers that match the character(s) that you entered display in the Available DN/Route Partition box. ",
"title": "Directory Number Contains",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "pattern",
"maxItems": 1,
"target": "/api/device/cucm/Line/choices/?field=pattern&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": "string",
"name": "pattern",
"target_model_type": "device/cucm/Line",
"choices": []
},
"routePartitionName": {
"description": " Choose a route partition for this line group from the drop-down list box. The default value specifies <None>. If you click Find, the Available DN/Route Partition list box displays all DNs that belong to the chosen partition. ",
"title": "Partition",
"minItems": 1,
"format": "uri",
"required": true,
"target_attr": "name",
"maxItems": 1,
"target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"type": [
"string",
"null"
],
"name": "routePartitionName",
"target_model_type": "device/cucm/RoutePartition",
"choices": []
}
},
"name": "directoryNumber"
},
"lineSelectionOrder": {
"name": "lineSelectionOrder",
"title": "Line Selection Order",
"minItems": 1,
"required": false,
"maxItems": 1,
"type": "integer"
}
}
},
"required": false,
"type": "array"
}
}
},
"rnaReversionTimeOut": {
"description": " Enter a time, in seconds, after which Cisco Unified Communications Manager will distribute a call to the next available or idle member of this line group or to the next line group if the call is not answered and if the first hunt option, Try next member; then, try next group in Hunt List, is chosen. The RNA Reversion Timeout applies at the line-group level to all members. ",
"title": "RNA Reversion Timeout",
"minItems": 1,
"required": true,
"default": 10,
"maxItems": 1,
"type": "integer"
},
"huntAlgorithmBusy": {
"description": " For a given distribution algorithm, choose a hunt option for Cisco Unified Communications Manager to use if a call is distributed to a member of a line group that is busy. Choose from the options in the drop-down list box: \n \n \n \n Try next member; then, try next group in Hunt List\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. If unsuccessful, Cisco Unified Communications Manager then tries the next line group in a hunt list. \n \n Try next member, but do not go to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager distributes a call to idle or available members starting from the first idle or available member of a line group to the last idle or available member. Cisco Unified Communications Manager stops trying upon reaching the last member of the current line group. \n \n Skip remaining members, and go directly to next group\u2014If you choose this hunt option, Cisco Unified Communications Manager skips the remaining members of this line group upon encountering a busy member. Cisco Unified Communications Manager proceeds directly to the next line group in a hunt list. \n \n Stop hunting\u2014If you choose this hunt option, Cisco Unified Communications Manager stops hunting after trying to distribute a call to the first busy member of this line group. \n ",
"title": "Busy",
"minItems": 1,
"required": true,
"choices": [
{
"value": "Try next member; then, try next group in Hunt List",
"title": "Try next member; then, try next group in Hunt List"
},
{
"value": "Try next member, but do not go to next group",
"title": "Try next member, but do not go to next group"
},
{
"value": "Skip remaining members, and go directly to next group",
"title": "Skip remaining members, and go directly to next group"
},
{
"value": "Stop hunting",
"title": "Stop hunting"
}
],
"default": "Try next member; then, try next group in Hunt List",
"maxItems": 1,
"type": "string"
},
"autoLogOffHunt": {
"description": "If this check box is checked, line members will be logged off the hunt list automatically. Line members can log back in using the \"HLOG\" softkey or PLK. ",
"title": "Automatically Logout Hunt Member on No Answer",
"minItems": 0,
"required": false,
"default": false,
"maxItems": 1,
"type": "boolean"
}
}
}
}
}
},
"HF": {
"title": "Hf",
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"queue_calls_checkbox": {
"type": "boolean",
"title": "Queue Calls"
},
"cfna_action": {
"choices": [
{
"value": "do_not_forward",
"title": "Do Not Forward Unanswered Calls"
},
{
"value": "use_device_forward_settings",
"title": "Use Forward Settings of Device that Forwarded to Hunt Pilot"
},
{
"value": "forward_to_dest",
"title": "Forward Unanswered Calls to Destination"
}
],
"type": "string",
"title": "Forward Hunt No Answer Action"
},
"cfb_action": {
"choices": [
{
"value": "do_not_forward",
"title": "Do Not Forward Busy Calls"
},
{
"value": "use_device_forward_settings",
"title": "Use Forward Settings of Device that Forwarded to Hunt Pilot"
},
{
"value": "forward_to_dest",
"title": "Forward Busy Calls to Destination"
}
],
"type": "string",
"title": "Forward Hunt Busy Action"
}
}
}
},
"schema_version": "1.1.3"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HuntGroupRelation/add/ |
|
The GUI Add form of relation/HuntGroupRelation 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/HuntGroupRelation | 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/HuntGroupRelation/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HuntGroupRelation/[pkid1]", "/api/relation/HuntGroupRelation/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HuntGroupRelation/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HuntGroupRelation |
|
{"hrefs": ["/api/relation/HuntGroupRelation/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HuntGroupRelation |
|
{"hrefs": ["/api/relation/HuntGroupRelation/[pkid1]", "/api/relation/HuntGroupRelation/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HuntGroupRelation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HuntGroupRelation/export/ |
|
{ "hrefs":["/api/relation/HuntGroupRelation/[pkid1]", "/api/relation/HuntGroupRelation/[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/HuntGroupRelation and the JSON format can be used to import instances of relation/HuntGroupRelation.
GET http://[host-proxy]/api/relation/HuntGroupRelation/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HuntGroupRelation | POST | /api/relation/HuntGroupRelation/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/relation/HuntGroupRelation/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/relation/HuntGroupRelation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HuntGroupRelation/ |
|
The relation/HuntGroupRelation schema and all instances as JSON. |
(The list will return 0 to 3 relation/HuntGroupRelation instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "huntListName",
"direction": "asc",
"current": "/api/relation/HuntGroupRelation/?skip=0&limit=3&order_by=huntListName&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"configuration_template",
"list",
"export",
"get",
"bulk_update",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "relation/HuntGroupRelation",
"summary_attrs": [
{
"name": "huntListName",
"title": "Hunt List"
},
{
"name": "description",
"title": "Description"
},
{
"name": "pattern",
"title": "Hunt Pilot Pattern"
},
{
"name": "routePartitionName",
"title": "Route Partition"
},
{
"name": "callPickupGroupName",
"title": "Call Pickup Group"
},
{
"name": "forwardHuntNoAnswer.destination",
"title": "CFNA Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "forwardHuntBusy.destination",
"title": "CFB Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.queueFullDestination",
"title": "Queue Full Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.noAgentDestination",
"title": "No Hunt Members Answer/Available Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HuntGroupRelation/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"update",
"field_display_policy",
"remove",
"help",
"add",
"configuration_template",
"list",
"export",
"get",
"export_bulkload_template",
"move"
],
"schema_version": "1.1.3",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HuntGroupRelation/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HuntGroupRelation",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HuntGroupRelation/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/HuntGroupRelation/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/relation/HuntGroupRelation/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/relation/HuntGroupRelation/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HuntGroupRelation/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HuntGroupRelation/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"parkMonForwardNoRetrieve": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"routeFilterName": null,
"callingPartyPrefixDigits": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1Si11-Feature-PT",
"releaseClause": "No Error",
"displayConnectedNumber": false,
"calledPartyNumberingPlan": "Cisco CallManager",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": true,
"asciiAlertingName": null,
"pattern": "8326010",
"patternPrecedence": "Default",
"prefixDigitsOut": null,
"maxHuntduration": null,
"huntListName": "Birmingham-HL",
"alertingName": null,
"connectedNamePresentationBit": "Default",
"blockEnable": false,
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"e164Mask": "+44124452XXXX",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"calledPartyNumberType": "Cisco CallManager",
"calledPartyTransformationMask": null,
"forwardHuntNoAnswer": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"patternUrgency": false,
"aarNeighborhoodName": null,
"forwardHuntBusy": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "CL2-AB-C-Birmingham (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-C.CL2-AB-C-Birmingham"
},
"meta": {
"model_type": "relation/HuntGroupRelation",
"summary_attrs": [
{
"name": "huntListName",
"title": "Hunt List"
},
{
"name": "description",
"title": "Description"
},
{
"name": "pattern",
"title": "Hunt Pilot Pattern"
},
{
"name": "routePartitionName",
"title": "Route Partition"
},
{
"name": "callPickupGroupName",
"title": "Call Pickup Group"
},
{
"name": "forwardHuntNoAnswer.destination",
"title": "CFNA Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "forwardHuntBusy.destination",
"title": "CFB Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.queueFullDestination",
"title": "Queue Full Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.noAgentDestination",
"title": "No Hunt Members Answer/Available Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Birmingham-HL",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae8a0c2affa931cce3923c4",
"href": "/api/data/HierarchyNode/5ae8a0c2affa931cce3923c4"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/",
"pkid": "5aeb7c38affa931cce4458b1"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f22affa931cce38d2f4",
"5ae8a0c2affa931cce3923c4",
"5aeb7c38affa931cce4458b1"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5aeb7c38affa931cce4458b1/?model_type=relation/HuntGroupRelation",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/help",
"support_async": false,
"title": "Help"
}
},
{
"AddLineGroup": {
"method": "POST",
"class": "add",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/+AddLineGroup/",
"support_async": true,
"title": "Add Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
},
{
"DelLineGroup": {
"method": "POST",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/+DelLineGroup/",
"support_async": true,
"title": "Del Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
}
],
"summary": "false"
},
"pkid": "5aeb7c38affa931cce4458b1"
},
{
"data": {
"parkMonForwardNoRetrieve": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"calledPartyTransformationMask": null,
"callingPartyPrefixDigits": null,
"patternUrgency": false,
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1Si26-Feature-PT",
"releaseClause": "No Error",
"displayConnectedNumber": false,
"calledPartyNumberingPlan": "Cisco CallManager",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": true,
"asciiAlertingName": null,
"pattern": "8703330",
"patternPrecedence": "Default",
"prefixDigitsOut": null,
"maxHuntduration": null,
"dialPlanName": null,
"alertingName": null,
"connectedNamePresentationBit": "Default",
"blockEnable": false,
"callingNamePresentationBit": "Default",
"huntListName": "Sales-HQ-Lyon",
"e164Mask": "+33562194011",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"calledPartyNumberType": "Cisco CallManager",
"routeFilterName": null,
"forwardHuntNoAnswer": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"callingPartyNumberingPlan": "Cisco CallManager",
"aarNeighborhoodName": null,
"forwardHuntBusy": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"callingLinePresentationBit": "Default",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "CL1-AB-DS-HQ-Lyon (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group.AB-DS.CL1-AB-DS-HQ-Lyon"
},
"meta": {
"model_type": "relation/HuntGroupRelation",
"summary_attrs": [
{
"name": "huntListName",
"title": "Hunt List"
},
{
"name": "description",
"title": "Description"
},
{
"name": "pattern",
"title": "Hunt Pilot Pattern"
},
{
"name": "routePartitionName",
"title": "Route Partition"
},
{
"name": "callPickupGroupName",
"title": "Call Pickup Group"
},
{
"name": "forwardHuntNoAnswer.destination",
"title": "CFNA Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "forwardHuntBusy.destination",
"title": "CFB Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.queueFullDestination",
"title": "Queue Full Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.noAgentDestination",
"title": "No Hunt Members Answer/Available Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Sales-HQ-Lyon",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae8a1e8affa931cce39619d",
"href": "/api/data/HierarchyNode/5ae8a1e8affa931cce39619d"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/",
"pkid": "5b0c116caffa931eb41ba438"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89f25affa931cce38d369",
"5ae8a1e8affa931cce39619d",
"5b0c116caffa931eb41ba438"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5b0c116caffa931eb41ba438/?model_type=relation/HuntGroupRelation",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/help",
"support_async": false,
"title": "Help"
}
},
{
"AddLineGroup": {
"method": "POST",
"class": "add",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/+AddLineGroup/",
"support_async": true,
"title": "Add Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
},
{
"DelLineGroup": {
"method": "POST",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5b0c116caffa931eb41ba438/+DelLineGroup/",
"support_async": true,
"title": "Del Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
}
],
"summary": "false"
},
"pkid": "5b0c116caffa931eb41ba438"
}
]
}
(Show the first instance)
{
"data": {
"parkMonForwardNoRetrieve": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"routeFilterName": null,
"callingPartyPrefixDigits": null,
"callingPartyNumberingPlan": "Cisco CallManager",
"connectedLinePresentationBit": "Default",
"routePartitionName": "Cu1Si11-Feature-PT",
"releaseClause": "No Error",
"displayConnectedNumber": false,
"calledPartyNumberingPlan": "Cisco CallManager",
"callingPartyNumberType": "Cisco CallManager",
"provideOutsideDialtone": true,
"asciiAlertingName": null,
"pattern": "8326010",
"patternPrecedence": "Default",
"prefixDigitsOut": null,
"maxHuntduration": null,
"huntListName": "Birmingham-HL",
"alertingName": null,
"connectedNamePresentationBit": "Default",
"blockEnable": false,
"callingNamePresentationBit": "Default",
"dialPlanName": null,
"e164Mask": "+44124452XXXX",
"digitDiscardInstructionName": null,
"useCallingPartyPhoneMask": "Off",
"callingPartyTransformationMask": null,
"calledPartyNumberType": "Cisco CallManager",
"calledPartyTransformationMask": null,
"forwardHuntNoAnswer": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"patternUrgency": false,
"aarNeighborhoodName": null,
"forwardHuntBusy": {
"destination": null,
"usePersonalPreferences": false,
"callingSearchSpaceName": null
},
"callingLinePresentationBit": "Default",
"HuntList": {
"voiceMailUsage": false,
"callManagerGroupName": "Default",
"members": {
"member": [
{
"selectionOrder": 1,
"lineGroupName": "Birmingham-LG"
}
]
},
"routeListEnabled": true,
"name": "Birmingham-HL",
"LineGroup": [
{
"huntAlgorithmNoAnswer": "Try next member; then, try next group in Hunt List",
"name": "Birmingham-LG",
"distributionAlgorithm": "Longest Idle Time",
"huntAlgorithmNotAvailable": "Try next member; then, try next group in Hunt List",
"members": {
"member": [
{
"directoryNumber": {
"pattern": "8328301",
"routePartitionName": "Cu1-DirNum-PT"
},
"lineSelectionOrder": 0
},
{
"directoryNumber": {
"pattern": "8328302",
"routePartitionName": "Cu1-DirNum-PT"
},
"lineSelectionOrder": 1
}
]
},
"rnaReversionTimeOut": 10,
"huntAlgorithmBusy": "Try next member; then, try next group in Hunt List",
"autoLogOffHunt": false
}
]
}
},
"meta": {
"model_type": "relation/HuntGroupRelation",
"summary_attrs": [
{
"name": "huntListName",
"title": "Hunt List"
},
{
"name": "description",
"title": "Description"
},
{
"name": "pattern",
"title": "Hunt Pilot"
},
{
"name": "routePartitionName",
"title": "Route Partition"
},
{
"name": "callPickupGroupName",
"title": "Call Pickup Group"
},
{
"name": "forwardHuntNoAnswer.destination",
"title": "CFNA Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "forwardHuntBusy.destination",
"title": "CFB Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.queueFullDestination",
"title": "Queue Full Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "queueCalls.noAgentDestination",
"title": "No Agent Destination",
"allow_ordering": false,
"allow_filtering": true
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "Birmingham-HL",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/CallManager/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"children": [],
"parent": [
{
"pkid": "5ae8a0c2affa931cce3923c4",
"href": "/api/data/HierarchyNode/5ae8a0c2affa931cce3923c4"
}
],
"self": [
{
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/",
"pkid": "5aeb7c38affa931cce4458b1"
}
]
},
"schema_version": "1.1.3",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5aeb7c38affa931cce4458b1/?hierarchy=[hierarchy]&model_type=relation/HuntGroupRelation",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"AddLineGroup": {
"method": "POST",
"class": "add",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/+AddLineGroup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Add Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
},
{
"DelLineGroup": {
"method": "POST",
"class": "delete",
"href": "/api/relation/HuntGroupRelation/5aeb7c38affa931cce4458b1/+DelLineGroup/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Del Line Group",
"schema": "HuntList.LineGroup",
"submit": "payload"
}
}
]
},
"pkid": "5aeb7c38affa931cce4458b1"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HuntGroupRelation. | GET | /api/relation/HuntGroupRelation/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HuntGroupRelation as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/relation/HuntGroupRelation/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HuntGroupRelation/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HuntGroupRelation | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HuntGroupRelation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HuntGroupRelation/[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/HuntGroupRelation and the JSON format can be used to import instances of relation/HuntGroupRelation.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HuntGroupRelation/[pkid] | hierarchy=[hierarchy] | The relation/HuntGroupRelation instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HuntGroupRelation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HuntGroupRelation. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Add Line Group | POST | /api/relation/HuntGroupRelation/[pkid]/+AddLineGroup | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Del Line Group | POST | /api/relation/HuntGroupRelation/[pkid]/+DelLineGroup | hierarchy=[hierarchy] | If payload required: |