[Index]
Relation to view all dial plan elements with the same Dial Plan name.
Model ref.: relation/DP_REL
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": {
"PhysicalLocation": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "dial plan name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Description",
"title": "Description"
},
"plName": {
"type": "string",
"description": "Physical Location Name",
"title": "Physical Location Name"
}
}
},
"type": "array",
"title": "Physical Location"
},
"ConfBridge": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Description",
"title": "Description"
},
"name": {
"type": "string",
"description": "Conference Bridge Name",
"title": "Conference Bridge Name"
},
"devicePool": {
"type": "string",
"description": "Device Pool",
"title": "Device Pool"
},
"location": {
"type": "string",
"description": "Location",
"title": "Location"
},
"trp": {
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
],
"type": "string",
"description": "Use Trusted Relay Point",
"title": "Use Trusted Relay Point"
},
"cbType": {
"default": "Cisco IOS Conference Bridge",
"choices": [
{
"value": "Cisco IOS Conference Bridge",
"title": "Cisco IOS Conference Bridge"
},
{
"value": "Cisco IOS Enhanced Conference Bridge",
"title": "Cisco IOS Enhanced Conference Bridge"
}
],
"type": "string",
"description": "Conference Bridge Type",
"title": "Conference Bridge Type"
}
}
},
"type": "array",
"title": "Conf Bridge"
},
"CalledPartyTransformation": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "A meaningful description for this called party transformation pattern.",
"title": "Description"
},
"numplan": {
"default": "Cisco CallManager",
"title": "Called Party Numbering Plan",
"type": "string",
"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"
}
]
},
"pattern": {
"required": true,
"type": "string",
"description": "The pattern for this called party transformation.",
"title": "Pattern"
},
"partition": {
"type": "string",
"description": "The route partition to which this calling party transformation",
"title": "Route Partition"
},
"prefixdigits": {
"type": "string",
"title": "Called Party Prefix Digits"
},
"numtype": {
"default": "Cisco CallManager",
"title": "Called Party Number Type",
"type": "string",
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
]
},
"discarddigits": {
"title": "Discard Digits",
"type": "string",
"choices": [
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"transformmask": {
"type": "string",
"title": "Called Party Transformation Mask"
}
}
},
"type": "array",
"title": "Called Party Transformation"
},
"DP-Reg-Loc": {
"items": {
"type": "object",
"properties": {
"locationWithinVideo": {
"default": "0",
"type": "string",
"description": "Within Video Bandwidth",
"title": "Within Video Bandwidth"
},
"locationWithinAudio": {
"default": "0",
"type": "string",
"description": "Within Audio Bandwidth",
"title": "Within Audio Bandwidth"
},
"dpoolmrgl": {
"type": "string",
"description": "MRGL",
"title": "Media Resource Group List"
},
"locationBetween": {
"items": {
"type": "object",
"properties": {
"betweenAudioBW": {
"default": "Unlimited",
"choices": [
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Audio Bandwidth",
"title": "Audio Bandwidth"
},
"betweenVideoBW": {
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Video Bandwidth (kbps)",
"title": "Video Bandwidth (kbps)"
},
"betweenWeight": {
"default": "50",
"type": "string",
"description": "Weight",
"title": "Weight"
},
"betweenImmersiveBW": {
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
],
"type": "string",
"description": "Immersive Bandwidth",
"title": "Immersive Bandwidth"
},
"betweenLocationName": {
"type": "string",
"description": "Location Name",
"title": "Location Name"
}
}
},
"type": "array",
"description": "Between Location",
"title": "Links - Bandwidth Between and Adjacent Locations"
},
"srstSipPort": {
"default": "5060",
"pattern": "^[0-9]*|$",
"type": "string",
"description": "SRST SIP Port.",
"title": "SIP Port"
},
"srstPort": {
"default": "2000",
"pattern": "^[0-9]*|$",
"type": "string",
"description": "SRST Port.",
"title": "Port"
},
"dpoolLocation": {
"default": "Hub_None",
"type": "string",
"description": "Location",
"title": "Location"
},
"regionName": {
"type": "string",
"description": "Region Name",
"title": "Region Name"
},
"locationCustom": {
"default": "False",
"type": "boolean",
"description": "Add Custom Location",
"title": "Add Custom Location"
},
"srstSipIpAddress": {
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$",
"type": "string",
"description": "SRST SIP Network IP Address.",
"title": "SIP Network/IP Address"
},
"dpoolDateTime": {
"type": "string",
"description": "Date/Time Group",
"title": "Date/Time Group"
},
"locationWithinImmersive": {
"default": "0",
"type": "string",
"description": "Within Immersive Kbits",
"title": "Within Immersive Kbits"
},
"dpoollrg_ARRAY": {
"items": {
"type": "object",
"properties": {
"lrgName": {
"default": "Standard Local Route Group",
"type": "string",
"description": "Local Route Group Name",
"title": "LRG Name"
},
"rgName": {
"type": "string",
"description": "Route Group Name",
"title": "Route Group Name"
}
}
},
"type": "array",
"description": "Standard Local Route Groups",
"title": "Standard Local Route Groups"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"dpoolCucmGroup": {
"type": "string",
"description": "Call Manager Group",
"title": "Call Manager Group"
},
"srstCustom": {
"type": "boolean",
"description": "Add Custom SRST Reference",
"title": "Add Custom SRST Reference"
},
"regionRelated": {
"items": {
"type": "object",
"properties": {
"relatedVideoBWImmersive": {
"default": "2147483647",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"type": "string",
"description": "Immersive Video Bandwidth",
"title": "Maximum Session Bit Rate for Immersive Video Calls"
},
"relatedLossy": {
"default": "Use System Default",
"choices": [
{
"value": "Keep Current Setting",
"title": "Keep Current Setting"
},
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Low Loss",
"title": "Low Loss"
},
{
"value": "Lossy",
"title": "Lossy"
}
],
"type": "string",
"description": "Lossy Network",
"title": "Lossy Network"
},
"relatedCodec": {
"default": "Use System Default",
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "Factory Default lossy",
"title": "Factory Default lossy"
},
{
"value": "Factory Default low loss",
"title": "Factory Default low loss"
}
],
"type": "string",
"description": "Codec Preference",
"title": "Audio Codec Preference List"
},
"relatedVideoBW": {
"default": "384",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
],
"type": "string",
"description": "Video Bandwidth",
"title": "Maximum Session Bit Rate for Video Calls"
},
"relatedAudioBW": {
"default": "64 kbps (G.711)",
"choices": [
{
"value": "0",
"title": "Use System Default"
},
{
"value": "7",
"title": "7 kbps (GSM-HR, G.723.1)"
},
{
"value": "8",
"title": "8 kbps (G.729)"
},
{
"value": "13",
"title": "13 kbps (GSM-FR, AMR)"
},
{
"value": "16",
"title": "16 kbps (iLBC, G.728)"
},
{
"value": "24",
"title": "24 kbps (AMR-WB)"
},
{
"value": "32",
"title": "32 kbps (iSAC, G.722.1)"
},
{
"value": "64",
"title": "64 kbps (G.711)"
},
{
"value": "128",
"title": "128 kbps (AAC-LD [LATM])"
},
{
"value": "256",
"title": "256 kbps (L16, AAC-LD)"
}
],
"type": "string",
"description": "Audio Bandwidth",
"title": "Maximum Audio Bit Rate"
},
"relatedRegionName": {
"type": "string",
"description": "Related Region Name",
"title": "Related Region Name"
}
}
},
"type": "array",
"description": "Related Region",
"title": "Related Region"
},
"srstIpAddress": {
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$",
"type": "string",
"description": "SRST Gateway IP Address.",
"title": "IP Address"
},
"srstName": {
"type": "string",
"description": "Name of new SRST Reference.",
"title": "Name"
},
"dpoolRegion": {
"default": "Default",
"type": "string",
"description": "Region",
"title": "Region"
},
"srstSecure": {
"type": "boolean",
"description": "Is SRST Secure?",
"title": "Is SRST Secure?"
},
"devicePoolCustom": {
"default": false,
"type": "boolean",
"title": "Add Device Pool"
},
"locationRelated": {
"items": {
"type": "object",
"properties": {
"rsvpSetting": {
"default": "Use System Default",
"choices": [
{
"value": "Use System Default",
"title": "Use System Default"
},
{
"value": "No Reservation",
"title": "No Reservation"
},
{
"value": "Optional(Video Desired)",
"title": "Optional(Video Desired)"
},
{
"value": "Mandatory",
"title": "Mandatory"
},
{
"value": "Mandatory(Video Desired)",
"title": "Mandatory(Video Desired)"
},
{
"value": "Allow Subscription",
"title": "Allow Subscription"
},
{
"value": "Disallow Subscription",
"title": "Disallow Subscription"
}
],
"type": "string",
"description": "RSVP Setting",
"title": "RSVP Setting"
},
"relatedLocationName": {
"type": "string",
"title": "Location Name"
}
}
},
"type": "array",
"description": "Location RSVP Settings",
"title": "Location RSVP Settings"
},
"dpoolName": {
"type": "string",
"description": "Device Pool Name",
"title": "Device Pool Name"
},
"dpoolSRST": {
"choices": [
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Use Default Gateway",
"title": "Use Default Gateway"
}
],
"required": false,
"type": "string",
"description": "SRST Reference",
"title": "SRST Reference"
},
"locationName": {
"type": "string",
"description": "Location Name",
"title": "Location Name"
},
"dpoolPhysLoc": {
"type": "string",
"description": "Physical Location",
"title": "Physical Location"
},
"regionCustom": {
"default": "False",
"type": "boolean",
"title": "Add Custom Region"
}
}
},
"type": "array",
"title": "Dp-Reg-Loc"
},
"CTIRoutePoint": {
"items": {
"type": "object",
"properties": {
"deviceName": {
"required": true,
"type": "string",
"description": "The name for this CTI route point.",
"title": "Device Name"
},
"dpName": {
"required": true,
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Meaningful description for this CTI route point.",
"title": "Description"
},
"cgPtyTransCss": {
"type": "string",
"title": "Calling Party Transformation CSS"
},
"useTrustedRelayPoint": {
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
],
"required": true,
"type": "string",
"title": "Use Trusted Relay Point"
},
"useDevPoolCgPtyTransCss": {
"type": "boolean",
"title": "Use Device Pool Calling Party Transformation CSS"
},
"geolocation": {
"type": "string",
"title": "Geolocation"
},
"ctirplinecss": {
"type": "string",
"description": "CTI Route Point Line CSS",
"title": "CTI Route Point Line CSS"
},
"devicePool": {
"required": true,
"type": "string",
"title": "Device Pool"
},
"location": {
"type": "string",
"title": "Location"
},
"ctirplinept": {
"type": "string",
"description": "CTI Route Point Line Partition",
"title": "CTI Route Point Line Partition"
},
"ctirplinedesc": {
"type": "string",
"description": "CTI Route Point Line Description",
"title": "CTI Route Point Line Description"
},
"css": {
"type": "string",
"title": "Calling Search Space"
},
"ctirpline": {
"type": "string",
"description": "CTI Route Point DN",
"title": "CTI Route Point DN"
}
}
},
"type": "array",
"title": "Cti Route Point"
},
"SIPTrunk": {
"items": {
"type": "object",
"properties": {
"mrgl": {
"type": "string",
"description": "Media Resource Group List",
"title": "Media Resource Group List"
},
"callClass": {
"default": "OffNet",
"choices": [
{
"value": "OnNet",
"title": "OnNet"
},
{
"value": "OffNet",
"title": "OffNet"
}
],
"type": "string",
"description": "Call Classification",
"title": "Call Classification"
},
"runOnAllNodes": {
"default": false,
"type": "boolean",
"description": "Run On All Active Unified CM Nodes",
"title": "Run On All Active Unified CM Nodes"
},
"prefixDn": {
"pattern": "^[0-9]+$",
"type": "string",
"title": "Inbound Prefix DN"
},
"sipNormScript": {
"type": "string",
"description": "SIP Normalization Script",
"title": "SIP Normalization Script"
},
"dtmfSignalingMethod": {
"default": "No Preference",
"title": "dtmfSignalingMethod",
"type": "string",
"choices": [
{
"value": "No Preference",
"title": "No Preference"
},
{
"value": "Out of Band",
"title": "Out of Band"
},
{
"value": "RFC 2833",
"title": "RFC 2833"
},
{
"value": "OOB and RFC 2833",
"title": "OOB and RFC 2833"
}
]
},
"stsp": {
"default": "Non Secure SIP Trunk Profile",
"type": "string",
"description": "SIP Trunk Security Profile",
"title": "SIP Trunk Security Profile"
},
"redirectDivHeadDel-In": {
"default": "false",
"title": "Redirecting Diversion Header Delivery - Inbound",
"type": "boolean",
"choices": [
{
"value": "true",
"title": "True"
},
{
"value": "false",
"title": "False"
}
]
},
"location": {
"type": "string",
"description": "Location",
"title": "Location"
},
"useDevicePoolCntdPnTransformationCss": {
"default": "false",
"type": "boolean",
"title": "Use Device Pool Connected Party Transformation CSS"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"inboundCSS": {
"type": "string",
"description": "Inbound Call CSS",
"title": "Inbound Call CSS"
},
"sipArray": {
"items": {
"type": "object",
"properties": {
"destinationV6": {
"type": "string",
"description": "Destination Address IPv6",
"title": "Destination Address IPv6"
},
"destination": {
"type": "string",
"description": "Destination Address",
"title": "Destination Address"
},
"destSRV": {
"type": "boolean",
"description": "Destination Address is an SRV",
"title": "Destination Address is an SRV"
},
"port": {
"type": "string",
"description": "Destination Port",
"title": "Destination Port"
}
}
},
"type": "array",
"description": "SIP Information",
"title": "SIP Information"
},
"cdpnTransformationCssName": {
"type": "string",
"title": "Called Party Transformation CSS"
},
"callingAndCalledPartyInfoFormat": {
"default": "Deliver URI and DN in connected party, if available",
"title": "callingAndCalledPartyInfoFormat",
"type": "string",
"choices": [
{
"value": "Deliver DN only in connected party",
"title": "Deliver DN only in connected party"
},
{
"value": "Deliver URI only in connected party, if available",
"title": "Deliver URI only in connected party, if available"
},
{
"value": "Deliver URI and DN in connected party, if available",
"title": "Deliver URI and DN in connected party, if available"
}
]
},
"desc": {
"type": "string",
"description": "Description",
"title": "Description"
},
"name": {
"type": "string",
"description": "SIP Trunk Name",
"title": "SIP Trunk Name"
},
"redirectDivHeadDel-Out": {
"default": "false",
"title": "Redirecting Diversion Header Delivery - Outbound",
"type": "boolean",
"choices": [
{
"value": "true",
"title": "True"
},
{
"value": "false",
"title": "False"
}
]
},
"rerouteCallingSearchSpaceName": {
"type": "string",
"title": "Rerouting Calling Search Space"
},
"devicePool": {
"items": {
"type": "object",
"attr_props": [
{
"title": "Member",
"type": "string",
"description": "Member",
"name": "member"
},
{
"title": "Member Selective Order",
"type": "number",
"description": "Member Selective Order",
"name": "memberOrder"
}
]
},
"type": "string",
"description": "Device Pool",
"title": "Device Pool"
},
"incomingPrefix": {
"pattern": "^[0-9]+$",
"type": "string",
"title": "Incoming Number Prefix"
},
"referCallingSearchSpaceName": {
"type": "string",
"title": "Out-Of-Dialog Refer Calling Search Space"
},
"cgpnTransformationCssName": {
"type": "string",
"title": "Calling Party Transformation CSS"
},
"sipProf": {
"default": "Standard SIP Profile",
"type": "string",
"description": "SIP Profile",
"title": "SIP Profile"
}
}
},
"type": "array",
"title": "Sip Trunk"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Dial Plan Description",
"title": "Description"
},
"RouteGroup": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "Route Group Name",
"title": "Route Group Name"
},
"rgArray": {
"items": {
"type": "object",
"properties": {
"device": {
"type": "string",
"title": "Device"
}
}
},
"type": "array",
"description": "Route Group Devices",
"title": "Route Group Devices"
},
"distalg": {
"default": "Circular",
"choices": [
{
"value": "Top Down",
"title": "Top Down"
},
{
"value": "Circular",
"title": "Circular"
}
],
"type": "string",
"description": "Distribution Algorithm",
"title": "Distribution Algorithm"
}
}
},
"type": "array",
"title": "Route Group"
},
"MTP": {
"items": {
"type": "object",
"properties": {
"mtpDP": {
"type": "string",
"description": "MTP Device Pool",
"title": "MTP Device Pool"
},
"trust": {
"default": "false",
"choices": [
{
"value": "true",
"title": "true"
},
{
"value": "false",
"title": "false"
}
],
"type": "boolean",
"description": "Trusted Relay Point",
"title": "Trusted Relay Point"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "MTP Name",
"title": "MTP Name"
},
"description": {
"type": "string",
"description": "MTP Description",
"title": "MTP Description"
}
}
},
"type": "array",
"title": "Mtp"
},
"Partition": {
"items": {
"type": "object",
"properties": {
"useOrigDeviceTimeZone": {
"default": true,
"type": "boolean",
"description": "Use Originating Device Time Zone",
"title": "Use Originating Device Time Zone"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"timeSchedule": {
"type": "string",
"description": "Partition Time Schedule",
"title": "Partition Time Schedule"
},
"name": {
"type": "string",
"description": "Partition Name",
"title": "Partition Name"
},
"description": {
"type": "string",
"description": "Partition Description",
"title": "Partition Description"
}
}
},
"type": "array",
"title": "Partition"
},
"CallingPartyTransformation": {
"items": {
"type": "object",
"properties": {
"cglineIdpres": {
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
],
"required": true,
"type": "string",
"title": "Calling Line ID Presentation"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "A meaningful description for this calling party transformation pattern.",
"title": "Description"
},
"cgptynumplan": {
"default": "Cisco CallManager",
"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"
}
],
"required": true,
"type": "string",
"title": "Calling Party Numbering Plan"
},
"pattern": {
"required": true,
"type": "string",
"description": "The pattern for this calling party transformation.",
"title": "Pattern"
},
"partition": {
"type": "string",
"description": "The route partition to which this calling party transformation belongs.",
"title": "Partition"
},
"prefixdigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"usecallingpartyexternalphonenummask": {
"default": "Default",
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"cgptynumtype": {
"default": "Cisco CallManager",
"choices": [
{
"value": "Cisco CallManager",
"title": "Cisco CallManager"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "National",
"title": "National"
},
{
"value": "International",
"title": "International"
},
{
"value": "Subscriber",
"title": "Subscriber"
}
],
"required": true,
"type": "string",
"title": "Calling Party Number Type"
},
"transformmask": {
"type": "string",
"title": "Calling Party Transform Mask"
},
"discarddigits": {
"title": "Calling Party Discard Digits",
"type": "string",
"choices": [
{
"value": "PreDot",
"title": "PreDot"
}
]
}
}
},
"type": "array",
"title": "Calling Party Transformation"
},
"RoutePatterns": {
"items": {
"type": "object",
"properties": {
"provideOutsideDialTone": {
"type": "boolean",
"title": "Provide Outside Dial Tone"
},
"callingPartyPrefixDigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"callingPartyTransformMask": {
"type": "string",
"title": "Calling Party Transform Mask"
},
"reqClientMatterCode": {
"type": "boolean",
"title": "Require Client Matter Code"
},
"reqForcedAuthCode": {
"type": "boolean",
"title": "Require Forced Authorization Code"
},
"releaseClause": {
"default": "No Error",
"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"
}
],
"type": "string",
"description": "If this is a blocking pattern, select the release clause when the call is blocked.",
"title": "Release Clause"
},
"allowOverlapSending": {
"type": "boolean",
"title": "Allow Overlap Sending"
},
"calledPartyDiscardDigits": {
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
],
"required": false,
"type": "string",
"title": "Called Party Discard Digits"
},
"numPlan": {
"type": "string",
"title": "Numbering Plan"
},
"pattern": {
"type": "string",
"description": "Route Pattern",
"title": "Route Pattern"
},
"patternPrecedence": {
"default": "Default",
"title": "MLPP Precedence",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Executive Override",
"title": "Executive Override"
},
{
"value": "Flash",
"title": "Flash"
},
{
"value": "Flash Override",
"title": "Flash Override"
},
{
"value": "Immediate",
"title": "Immediate"
},
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Routine",
"title": "Routine"
}
]
},
"routeFilter": {
"type": "string",
"description": "Route Filter",
"title": "Route Filter"
},
"routeOption": {
"default": "Route this pattern",
"title": "Route Option",
"type": "string",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"routePartition": {
"default": "Originating Device",
"type": "string",
"description": "Route Partition",
"title": "Route Partition"
},
"authLevel": {
"default": "0",
"type": "string",
"title": "Authorization Level"
},
"dpLocal": {
"default": "{{ fn.false }}",
"type": "boolean",
"description": "Route pattern designation as local dialing built from Dial Plan Input Data",
"title": "Local Dialing"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"gatewayName": {
"type": "string",
"title": "Gateway Name"
},
"description": {
"type": "string",
"description": "Route Pattern Description",
"title": "Route Pattern Description"
},
"calledPartyPrefixDigits": {
"type": "string",
"title": "Called Party Prefix Digits (Outgoing Calls)"
},
"routeList": {
"type": "string",
"title": "Route List"
},
"calledPartyTransformMask": {
"type": "string",
"title": "Called Party Transform Mask"
},
"cgLinePresBit": {
"default": "Default",
"title": "Calling Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"default": "Default",
"title": "Connected Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"callClassification": {
"default": "OffNet",
"choices": [
{
"value": "OffNet",
"title": "OffNet"
},
{
"value": "OnNet",
"title": "OnNet"
}
],
"type": "string",
"description": "OnNet or Offnet call",
"title": "Call Classification"
},
"allowDeviceOverride": {
"type": "boolean",
"title": "Allow Device Override"
},
"useCallingPartyExternalPhoneNumMask": {
"default": "Default",
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"choices": [
{
"value": "Off",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"cgNamePresBit": {
"default": "Default",
"title": "Calling Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"default": "Default",
"title": "Connected Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"urgentPriority": {
"type": "boolean",
"title": "Urgent Priority"
}
}
},
"type": "array",
"title": "Route Patterns"
},
"TimeSchedule": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"time_schedule_members": {
"items": {
"type": "object",
"properties": {
"timePeriodName": {
"type": "string",
"description": "A time period that is part of this time schedule.",
"title": "Time Period Name"
}
}
},
"type": "array",
"title": "Time Periods"
},
"name": {
"required": true,
"type": "string",
"description": "The name for this time schedule.",
"title": "Time Schedule Name"
},
"description": {
"type": "string",
"description": "A meaningful description for this time schedule.",
"title": "Description"
}
}
},
"type": "array",
"title": "Time Schedule"
},
"MediaResourceGroupList": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "Media Resource Group List Name",
"title": "Media Resource Group List Name"
},
"mrgArray": {
"items": {
"type": "object",
"properties": {
"mrgs": {
"type": "string",
"description": "Media Resource Group",
"title": "Media Resource Group"
}
}
},
"type": "array",
"description": "Media Resource Groups",
"title": "Media Resource Groups"
}
}
},
"type": "array",
"title": "Media Resource Group List"
},
"TimePeriod": {
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"description": "The name for this Dial Plan.",
"title": "Dial Plan Name"
},
"tod_start": {
"description": "Time of Day Start",
"title": "Time of Day Start",
"default": "No Office Hours",
"required": true,
"choices": [
{
"value": "No Office Hours",
"title": "No Office Hours"
}
],
"type": "any"
},
"tod_end_day_of_month": {
"default": "0",
"type": "integer",
"description": "Optional end day of month for this period.",
"title": "End Day of Month"
},
"tod_end": {
"description": "The end time for this period.",
"title": "Time of Day End",
"default": "No Office Hours",
"required": true,
"choices": [
{
"value": "No Office Hours",
"title": "No Office Hours"
}
],
"type": "any"
},
"time_period_description": {
"type": "string",
"description": "A meaningful description for this time period.",
"title": "Description"
},
"tod_start_day": {
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
],
"type": "string",
"description": "Optional start day for this period.",
"title": "Start Day"
},
"tod_start_day_of_month": {
"default": "0",
"type": "integer",
"description": "Optional start day of month for this period.",
"title": "Start Day of Month"
},
"tod_end_day": {
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
],
"type": "string",
"description": "Optional end day for this period.",
"title": "End Day"
},
"tod_start_month": {
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
],
"type": "string",
"description": "Optional start month for this period.",
"title": "Start Month"
},
"tod_end_month": {
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
],
"type": "string",
"description": "Optional end month for this period.",
"title": "End Month"
},
"name": {
"required": true,
"type": "string",
"description": "The name for this time period.",
"title": "Time Period Name"
}
}
},
"type": "array",
"title": "Time Period"
},
"CSS": {
"items": {
"type": "object",
"properties": {
"usage": {
"default": "General",
"type": "string",
"title": "Partition Usage"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "CSS Name",
"title": "CSS Name"
},
"members": {
"minItems": 0,
"items": {
"type": "object",
"properties": {
"index": {
"pattern": "^[0-9]*",
"type": "string",
"title": "Partition Index"
},
"partition": {
"required": true,
"type": "string",
"description": "Route Partition Names",
"title": "Route Partition Names"
}
}
},
"type": "array",
"description": "The array of default partitions associated with this calling search space.",
"title": "Partitions"
},
"description": {
"type": "string",
"description": "CSS Description",
"title": "CSS Description"
}
}
},
"type": "array",
"title": "Css"
},
"notes": {
"type": "string",
"description": "Dial Plan Notes",
"title": "Notes"
},
"MediaResourceGroup": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"devicesArray": {
"items": {
"type": "object",
"properties": {
"mResource": {
"type": "string",
"description": "Media Resource",
"title": "Media Resource"
}
}
},
"type": "array",
"description": "Devices for this Group",
"title": "Devices for this Group"
},
"name": {
"type": "string",
"description": "Media Resource Group Name",
"title": "Media Resource Group Name"
},
"multicast": {
"default": "false",
"type": "boolean",
"description": "Use Multi-cast for MOH Audio",
"title": "Use Multi-cast for MOH Audio"
},
"description": {
"type": "string",
"description": "Description",
"title": "Description"
}
}
},
"type": "array",
"title": "Media Resource Group"
},
"Transcoder": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "Transcoder Name",
"title": "Transcoder Name"
},
"devicePool": {
"type": "string",
"description": "Device Pool",
"title": "Device Pool"
},
"trp": {
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
],
"type": "string",
"description": "Use Trusted Relay Point",
"title": "Use Trusted Relay Point"
},
"type": {
"default": "Cisco IOS Media Termination Point",
"choices": [
{
"value": "Cisco IOS Media Termination Point",
"title": "Cisco IOS Media Termination Point"
},
{
"value": "Cisco IOS Enhanced Media Termination Point",
"title": "Cisco IOS Enhanced Media Termination Point"
}
],
"type": "string",
"description": "Transcoder Type",
"title": "Transcoder Type"
},
"description": {
"type": "string",
"description": "Description",
"title": "Description"
}
}
},
"type": "array",
"title": "Transcoder"
},
"CallPark": {
"items": {
"type": "object",
"properties": {
"cucm": {
"required": true,
"type": "string",
"description": "Cisco Unified Communications Manager",
"title": "Cisco Unified Communications Manager"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"partition": {
"type": "string",
"description": "Partition",
"title": "Partition"
},
"description": {
"type": "string",
"description": "Call Park Description",
"title": "Call Park Description"
},
"callParkNumRange": {
"required": true,
"type": "string",
"description": "Call Park Number/Range",
"title": "Call Park Number/Range"
}
}
},
"type": "array",
"title": "Call Park"
},
"dpType": {
"title": "Dial Plan Type",
"type": "string",
"choices": [
{
"value": "Provider",
"title": "Multi-tenant / Shared Architecture"
},
{
"value": "Customer",
"title": "Global"
},
{
"value": "Site",
"title": "Site"
}
]
},
"SIPRoutePattern": {
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "A meaningful description for this SIP route pattern.",
"title": "Description"
},
"callingPartyPrefixDigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"useCallerCss": {
"type": "boolean",
"title": "Use Caller CSS"
},
"pattern": {
"required": true,
"type": "string",
"description": "The SIP route pattern.",
"title": "Pattern"
},
"sipTrunkName": {
"required": true,
"type": "string",
"title": "Sip Trunk/Route List Name"
},
"dnOrPatternIpv6": {
"type": "string",
"title": "Dn or Pattern IPv6"
},
"routeOption": {
"default": "Route this pattern",
"title": "Route Option",
"type": "string",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"connLinePresBit": {
"default": "Default",
"title": "Connected Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"domainRoutingCssName": {
"type": "string",
"title": "Domain Routing Css Name"
},
"useCallingPartyExternalPhoneNumMask": {
"default": "Default",
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"cgLinePresBit": {
"default": "Default",
"title": "Calling Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"cgNamePresBit": {
"default": "Default",
"title": "Calling Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"usage": {
"description": "The usage for this SIP route pattern.",
"title": "Usage",
"default": "Domain Routing",
"required": true,
"choices": [
{
"value": "Domain Routing",
"title": "Domain Routing"
}
],
"type": "string"
},
"routeOnUserPart": {
"type": "boolean",
"title": "Route On User Part"
},
"connNamePresBit": {
"default": "Default",
"title": "Connected Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"routePartitionName": {
"required": true,
"type": "string",
"description": "The route partition to which this pattern belongs.",
"title": "Route Partition"
},
"callingPartyTransformationMask": {
"type": "string",
"title": "Calling Party Transformation Mask"
}
}
},
"type": "array",
"title": "Sip Route Pattern"
},
"AdvertisedPatterns": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"patternType": {
"default": "Enterprise Number",
"choices": [
{
"value": "Enterprise Number",
"title": "Enterprise Number"
},
{
"value": "+E.164 Number",
"title": "+E.164 Number"
}
],
"type": "string",
"description": "Pattern Type",
"title": "Pattern Type"
},
"pstnFailStrip": {
"default": "0",
"type": "string",
"description": "Pstn Fail Strip",
"title": "Pstn Fail Strip"
},
"pattern": {
"type": "string",
"description": "Pattern",
"title": "Pattern"
},
"pstnFailoverPrependDigits": {
"default": "0",
"type": "string",
"description": "PSTN Failover Prepend Digits",
"title": "PSTN Failover Prepend Digits"
},
"pstnRule": {
"default": "No PSTN",
"choices": [
{
"value": "No PSTN",
"title": "No PSTN"
},
{
"value": "Specify",
"title": "Specify"
},
{
"value": "Use pattern",
"title": "Use pattern"
}
],
"type": "string",
"description": "Hosted Route PSTN Rule",
"title": "Hosted Route PSTN Rule"
},
"description": {
"type": "string",
"description": "Pattern Description",
"title": "Pattern Description"
}
}
},
"type": "array",
"title": "Advertised Patterns"
},
"RouteList": {
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "Route List Name",
"title": "Route List Name"
},
"routeListEnabled": {
"type": "boolean",
"title": "Route List Enabled"
},
"runOnEveryNode": {
"type": "boolean",
"title": "Run On Every Node"
},
"callManagerGroup": {
"items": {
"type": "object",
"attr_props": [
{
"title": "Member",
"type": "string",
"description": "Member",
"name": "member"
},
{
"title": "Member Selective Order",
"type": "number",
"description": "Member Selective Order",
"name": "memberOrder"
}
]
},
"type": "string",
"title": "Call Manager Group Name"
},
"members": {
"minItems": 0,
"items": {
"type": "object",
"properties": {
"calledPartyDiscardDigits": {
"default": "None",
"title": "Called Party Discard Digits",
"type": "string",
"choices": [
{
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"callingPartyPrefixDigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"callingPartyTransformMask": {
"type": "string",
"title": "Calling Party Transform Mask"
},
"selectionOrder": {
"type": "string",
"title": "Selection Order"
},
"useCallingPartyExternalPhoneNumMask": {
"default": "Default",
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"calledPartyPrefixDigits": {
"type": "string",
"title": "Called Party Prefix Digits (Outgoing Calls)"
},
"calledPartyTransformMask": {
"type": "string",
"title": "Called Party Transform Mask"
},
"routeGroupName": {
"type": "string",
"title": "Route Group Name"
}
}
},
"type": "array",
"title": "Members"
},
"description": {
"type": "string",
"description": "Route List Description",
"title": "Route List Description"
}
}
},
"type": "array",
"title": "Route List"
},
"TransPattern": {
"items": {
"type": "object",
"properties": {
"provideOutsideDialTone": {
"type": "boolean",
"title": "Provide Outside Dial Tone"
},
"callingPartyPrefixDigits": {
"type": "string",
"title": "Calling Party Prefix Digits (Outgoing Calls)"
},
"callingPartyTransformMask": {
"type": "string",
"title": "Calling Party Transform Mask"
},
"nextHopByCallingPtyNum": {
"type": "boolean",
"title": "Route Next Hop By Calling Party Number"
},
"releaseClause": {
"default": "No Error",
"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"
}
],
"type": "string",
"description": "If this is a blocking pattern, select the release clause when the call is blocked.",
"title": "Release Clause"
},
"calledPartyDiscardDigits": {
"title": "Called Party Discard Digits",
"type": "string",
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"pattern": {
"type": "string",
"description": "Translation Pattern",
"title": "Translation Pattern"
},
"routeOption": {
"default": "Route this pattern",
"title": "Route Option",
"type": "string",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"noWaitInterdigitTimeoutSubseqHops": {
"type": "boolean",
"title": "Do Not Wait For Interdigit Timeout On Subsequent Hops"
},
"css": {
"type": "string",
"title": "Css"
},
"dpLocal": {
"default": "{{ fn.false }}",
"type": "boolean",
"description": "Translation pattern designation as local dialing built from Dial Plan Input Data",
"title": "Local Dialing"
},
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Translation Pattern Description",
"title": "Translation Pattern Description"
},
"calledPartyPrefixDigits": {
"type": "string",
"title": "Called Party Prefix Digits (Outgoing Calls)"
},
"calledPartyTransformMask": {
"type": "string",
"title": "Called Party Transform Mask"
},
"cgLinePresBit": {
"default": "Default",
"title": "Calling Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"default": "Default",
"title": "Connected Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"partition": {
"type": "string",
"description": "Partition",
"title": "Partition"
},
"useCallingPartyExternalPhoneNumMask": {
"type": "boolean",
"title": "Use Calling Party's External Phone Number Mask"
},
"cgNamePresBit": {
"default": "Default",
"title": "Calling Name Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"default": "Default",
"title": "Connected Line Presentation Bit",
"type": "string",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"useOrigCss": {
"type": "boolean",
"title": "Use Originator's Calling Search Space"
},
"urgentPriority": {
"type": "boolean",
"title": "Urgent Priority"
}
}
},
"type": "array",
"title": "Trans Pattern"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/DP_REL/add/ |
|
The GUI Add form of relation/DP_REL 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/DP_REL/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/DP_REL/ |
|
The relation/DP_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/DP_REL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "dpName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/DP_REL/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/DP_REL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/DP_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/DP_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/relation/DP_REL/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "relation/DP_REL",
"model_specific_actions": [
"add",
"export",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove"
],
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/DP_REL. | GET | /api/relation/DP_REL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/DP_REL as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/DP_REL/[pkid]/ | hierarchy=[hierarchy] | The relation/DP_REL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/DP_REL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/DP_REL. |