[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": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"description": {
"type": "string",
"description": "Dial Plan Description",
"title": "Description"
},
"notes": {
"type": "string",
"description": "Dial Plan Notes",
"title": "Notes"
},
"dpType": {
"choices": [
{
"value": "Provider",
"title": "Multi-tenant / Shared Architecture"
},
{
"value": "Customer",
"title": "Global"
},
{
"value": "IntermediateNode",
"title": "Intermediate"
},
{
"value": "Site",
"title": "Site"
}
],
"type": "string",
"title": "Dial Plan Type"
},
"DP-Reg-Loc": {
"title": "Dp-Reg-Loc",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"devicePoolCustom": {
"title": "Add Device Pool",
"type": "boolean",
"default": false
},
"dpoolName": {
"title": "Device Pool Name",
"description": "Device Pool Name",
"type": "string"
},
"dpoolCucmGroup": {
"title": "Call Manager Group",
"description": "Call Manager Group",
"type": "string"
},
"dpoolRegion": {
"title": "Region",
"description": "Region",
"type": "string",
"default": "Default"
},
"dpoolLocation": {
"title": "Location",
"description": "Location",
"type": "string",
"default": "Hub_None"
},
"dpoolSRST": {
"title": "SRST Reference",
"description": "SRST Reference",
"type": "string",
"required": false,
"choices": [
{
"value": "Disable",
"title": "Disable"
},
{
"value": "Use Default Gateway",
"title": "Use Default Gateway"
}
]
},
"dpoolDateTime": {
"title": "Date/Time Group",
"description": "Date/Time Group",
"type": "string"
},
"dpoolPhysLoc": {
"title": "Physical Location",
"description": "Physical Location",
"type": "string"
},
"regionCustom": {
"title": "Add Custom Region",
"type": "boolean",
"default": "False"
},
"regionName": {
"title": "Region Name",
"description": "Region Name",
"type": "string"
},
"regionRelated": {
"title": "Related Region",
"description": "Related Region",
"type": "array",
"items": {
"type": "object",
"properties": {
"relatedRegionName": {
"title": "Related Region Name",
"description": "Related Region Name",
"type": "string"
},
"relatedCodec": {
"title": "Audio Codec Preference List",
"description": "Codec Preference",
"type": "string",
"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"
}
]
},
"relatedAudioBW": {
"title": "Maximum Audio Bit Rate",
"description": "Audio Bandwidth",
"type": "string",
"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)"
}
]
},
"relatedVideoBW": {
"title": "Maximum Session Bit Rate for Video Calls",
"description": "Video Bandwidth",
"type": "string",
"default": "384",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
]
},
"relatedVideoBWImmersive": {
"title": "Maximum Session Bit Rate for Immersive Video Calls",
"description": "Immersive Video Bandwidth",
"type": "string",
"default": "2147483647",
"choices": [
{
"value": "2",
"title": "Use System Default"
},
{
"value": "0",
"title": "Not Allowed"
}
]
},
"relatedLossy": {
"title": "Lossy Network",
"description": "Lossy Network",
"type": "string",
"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"
}
]
}
}
}
},
"locationCustom": {
"title": "Add Custom Location",
"description": "Add Custom Location",
"type": "boolean",
"default": "False"
},
"locationName": {
"title": "Location Name",
"description": "Location Name",
"type": "string"
},
"locationRelated": {
"title": "Location RSVP Settings",
"description": "Location RSVP Settings",
"type": "array",
"items": {
"type": "object",
"properties": {
"relatedLocationName": {
"title": "Location Name",
"type": "string"
},
"rsvpSetting": {
"title": "RSVP Setting",
"description": "RSVP Setting",
"type": "string",
"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"
}
]
}
}
}
},
"locationBetween": {
"title": "Links - Bandwidth Between and Adjacent Locations",
"description": "Between Location",
"type": "array",
"items": {
"type": "object",
"properties": {
"betweenLocationName": {
"title": "Location Name",
"description": "Location Name",
"type": "string"
},
"betweenAudioBW": {
"title": "Audio Bandwidth",
"description": "Audio Bandwidth",
"type": "string",
"default": "Unlimited",
"choices": [
{
"value": "0",
"title": "Unlimited"
}
]
},
"betweenVideoBW": {
"title": "Video Bandwidth (kbps)",
"description": "Video Bandwidth (kbps)",
"type": "string",
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
]
},
"betweenImmersiveBW": {
"title": "Immersive Bandwidth",
"description": "Immersive Bandwidth",
"type": "string",
"default": "None",
"choices": [
{
"value": "-1",
"title": "None"
},
{
"value": "0",
"title": "Unlimited"
}
]
},
"betweenWeight": {
"title": "Weight",
"description": "Weight",
"type": "string",
"default": "50"
}
}
}
},
"locationWithinImmersive": {
"title": "Within Immersive Kbits",
"description": "Within Immersive Kbits",
"type": "string",
"default": "0"
},
"locationWithinAudio": {
"title": "Within Audio Bandwidth",
"description": "Within Audio Bandwidth",
"type": "string",
"default": "0"
},
"locationWithinVideo": {
"title": "Within Video Bandwidth",
"description": "Within Video Bandwidth",
"type": "string",
"default": "0"
},
"srstCustom": {
"title": "Add Custom SRST Reference",
"description": "Add Custom SRST Reference",
"type": "boolean"
},
"srstName": {
"title": "Name",
"description": "Name of new SRST Reference.",
"type": "string"
},
"srstPort": {
"title": "Port",
"description": "SRST Port.",
"type": "string",
"pattern": "^[0-9]*|$",
"default": "2000"
},
"srstIpAddress": {
"title": "IP Address",
"description": "SRST Gateway IP Address.",
"type": "string",
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$"
},
"srstSipIpAddress": {
"title": "SIP Network/IP Address",
"description": "SRST SIP Network IP Address.",
"type": "string",
"pattern": "^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}|$"
},
"srstSipPort": {
"title": "SIP Port",
"description": "SRST SIP Port.",
"type": "string",
"pattern": "^[0-9]*|$",
"default": "5060"
},
"srstSecure": {
"title": "Is SRST Secure?",
"description": "Is SRST Secure?",
"type": "boolean"
},
"dpoolmrgl": {
"title": "Media Resource Group List",
"description": "MRGL",
"type": "string"
},
"dpoollrg_ARRAY": {
"title": "Standard Local Route Groups",
"description": "Standard Local Route Groups",
"type": "array",
"items": {
"type": "object",
"properties": {
"lrgName": {
"title": "LRG Name",
"description": "Local Route Group Name",
"type": "string",
"default": "Standard Local Route Group"
},
"rgName": {
"title": "Route Group Name",
"description": "Route Group Name",
"type": "string"
}
}
}
}
}
}
},
"TimePeriod": {
"title": "Time Period",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "The name for this Dial Plan.",
"type": "string",
"required": true
},
"name": {
"title": "Time Period Name",
"description": "The name for this time period.",
"type": "string",
"required": true
},
"time_period_description": {
"title": "Description",
"description": "A meaningful description for this time period.",
"type": "string"
},
"tod_start": {
"title": "Time of Day Start",
"description": "Time of Day Start",
"type": "any",
"required": true,
"default": "No Office Hours",
"choices": [
{
"value": "No Office Hours",
"title": "No Office Hours"
}
]
},
"tod_end": {
"title": "Time of Day End",
"description": "The end time for this period.",
"type": "any",
"required": true,
"default": "No Office Hours",
"choices": [
{
"value": "No Office Hours",
"title": "No Office Hours"
}
]
},
"tod_start_day": {
"title": "Start Day",
"description": "Optional start day for this period.",
"type": "string",
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
]
},
"tod_end_day": {
"title": "End Day",
"description": "Optional end day for this period.",
"type": "string",
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
]
},
"tod_start_month": {
"title": "Start Month",
"description": "Optional start month for this period.",
"type": "string",
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
]
},
"tod_end_month": {
"title": "End Month",
"description": "Optional end month for this period.",
"type": "string",
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
}
]
},
"tod_start_day_of_month": {
"title": "Start Day of Month",
"description": "Optional start day of month for this period.",
"type": "integer",
"default": "0"
},
"tod_end_day_of_month": {
"title": "End Day of Month",
"description": "Optional end day of month for this period.",
"type": "integer",
"default": "0"
}
}
}
},
"TimeSchedule": {
"title": "Time Schedule",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Time Schedule Name",
"description": "The name for this time schedule.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "A meaningful description for this time schedule.",
"type": "string"
},
"time_schedule_members": {
"title": "Time Periods",
"type": "array",
"items": {
"type": "object",
"properties": {
"timePeriodName": {
"title": "Time Period Name",
"description": "A time period that is part of this time schedule.",
"type": "string"
}
}
}
}
}
}
},
"RouteList": {
"title": "Route List",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Route List Name",
"description": "Route List Name",
"type": "string"
},
"description": {
"title": "Route List Description",
"description": "Route List Description",
"type": "string"
},
"callManagerGroup": {
"title": "Call Manager Group Name",
"type": "string",
"items": {
"type": "object",
"attr_props": [
{
"name": "member",
"title": "Member",
"description": "Member",
"type": "string"
},
{
"name": "memberOrder",
"title": "Member Selective Order",
"description": "Member Selective Order",
"type": "number"
}
]
}
},
"routeListEnabled": {
"title": "Route List Enabled",
"type": "boolean"
},
"runOnEveryNode": {
"title": "Run On Every Node",
"type": "boolean"
},
"members": {
"title": "Members",
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"routeGroupName": {
"title": "Route Group Name",
"type": "string"
},
"selectionOrder": {
"title": "Selection Order",
"type": "string"
},
"useCallingPartyExternalPhoneNumMask": {
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"callingPartyTransformMask": {
"title": "Calling Party Transform Mask",
"type": "string"
},
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"calledPartyDiscardDigits": {
"title": "Called Party Discard Digits",
"type": "string",
"default": "None",
"choices": [
{
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"calledPartyTransformMask": {
"title": "Called Party Transform Mask",
"type": "string"
},
"calledPartyPrefixDigits": {
"title": "Called Party Prefix Digits (Outgoing Calls)",
"type": "string"
}
}
}
}
}
}
},
"Transcoder": {
"title": "Transcoder",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"type": {
"title": "Transcoder Type",
"description": "Transcoder Type",
"type": "string",
"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"
}
]
},
"name": {
"title": "Transcoder Name",
"description": "Transcoder Name",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description",
"type": "string"
},
"devicePool": {
"title": "Device Pool",
"description": "Device Pool",
"type": "string"
},
"trp": {
"title": "Use Trusted Relay Point",
"description": "Use Trusted Relay Point",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
]
}
}
}
},
"ConfBridge": {
"title": "Conf Bridge",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"cbType": {
"title": "Conference Bridge Type",
"description": "Conference Bridge Type",
"type": "string",
"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"
}
]
},
"name": {
"title": "Conference Bridge Name",
"description": "Conference Bridge Name",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description",
"type": "string"
},
"devicePool": {
"title": "Device Pool",
"description": "Device Pool",
"type": "string"
},
"location": {
"title": "Location",
"description": "Location",
"type": "string"
},
"trp": {
"title": "Use Trusted Relay Point",
"description": "Use Trusted Relay Point",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Off",
"title": "Off"
},
{
"value": "On",
"title": "On"
}
]
}
}
}
},
"MediaResourceGroup": {
"title": "Media Resource Group",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Media Resource Group Name",
"description": "Media Resource Group Name",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description",
"type": "string"
},
"devicesArray": {
"title": "Devices for this Group",
"description": "Devices for this Group",
"type": "array",
"items": {
"type": "object",
"properties": {
"mResource": {
"title": "Media Resource",
"description": "Media Resource",
"type": "string"
}
}
}
},
"multicast": {
"title": "Use Multi-cast for MOH Audio",
"description": "Use Multi-cast for MOH Audio",
"type": "boolean",
"default": "false"
}
}
}
},
"MediaResourceGroupList": {
"title": "Media Resource Group List",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Media Resource Group List Name",
"description": "Media Resource Group List Name",
"type": "string"
},
"mrgArray": {
"title": "Media Resource Groups",
"description": "Media Resource Groups",
"type": "array",
"items": {
"type": "object",
"properties": {
"mrgs": {
"title": "Media Resource Group",
"description": "Media Resource Group",
"type": "string"
}
}
}
}
}
}
},
"RouteGroup": {
"title": "Route Group",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Route Group Name",
"description": "Route Group Name",
"type": "string"
},
"distalg": {
"title": "Distribution Algorithm",
"description": "Distribution Algorithm",
"type": "string",
"default": "Circular",
"choices": [
{
"value": "Top Down",
"title": "Top Down"
},
{
"value": "Circular",
"title": "Circular"
}
]
},
"rgArray": {
"title": "Route Group Devices",
"description": "Route Group Devices",
"type": "array",
"items": {
"type": "object",
"properties": {
"device": {
"title": "Device",
"type": "string"
}
}
}
}
}
}
},
"SIPTrunk": {
"title": "Sip Trunk",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"name": {
"type": "string",
"description": "SIP Trunk Name",
"title": "SIP Trunk Name"
},
"desc": {
"type": "string",
"description": "Description",
"title": "Description"
},
"devicePool": {
"items": {
"attr_props": [
{
"type": "string",
"description": "Member",
"name": "member",
"title": "Member"
},
{
"type": "number",
"description": "Member Selective Order",
"name": "memberOrder",
"title": "Member Selective Order"
}
],
"type": "object"
},
"type": "string",
"description": "Device Pool",
"title": "Device Pool"
},
"callClass": {
"description": "Call Classification",
"title": "Call Classification",
"default": "OffNet",
"choices": [
{
"value": "OnNet",
"title": "OnNet"
},
{
"value": "OffNet",
"title": "OffNet"
}
],
"type": "string"
},
"mrgl": {
"type": "string",
"description": "Media Resource Group List",
"title": "Media Resource Group List"
},
"location": {
"type": "string",
"description": "Location",
"title": "Location"
},
"pstnAccess": {
"default": "false",
"type": "boolean",
"title": "PSTN Access"
},
"runOnAllNodes": {
"default": false,
"type": "boolean",
"description": "Run On All Active Unified CM Nodes",
"title": "Run On All Active Unified CM Nodes"
},
"inboundCSS": {
"type": "string",
"description": "Inbound Call CSS",
"title": "Inbound Call CSS"
},
"prefixDn": {
"pattern": "^[0-9]+$",
"type": "string",
"title": "Inbound Prefix DN"
},
"incomingPrefix": {
"pattern": "^[0-9]+$",
"type": "string",
"title": "Incoming Number Prefix"
},
"sipArray": {
"items": {
"type": "object",
"properties": {
"destSRV": {
"type": "boolean",
"description": "Destination Address is an SRV",
"title": "Destination Address is an SRV"
},
"destination": {
"type": "string",
"description": "Destination Address",
"title": "Destination Address"
},
"destinationV6": {
"type": "string",
"description": "Destination Address IPv6",
"title": "Destination Address IPv6"
},
"port": {
"type": "string",
"description": "Destination Port",
"title": "Destination Port"
}
}
},
"type": "array",
"description": "SIP Information",
"title": "SIP Information"
},
"stsp": {
"default": "Non Secure SIP Trunk Profile",
"type": "string",
"description": "SIP Trunk Security Profile",
"title": "SIP Trunk Security Profile"
},
"sipProf": {
"default": "Standard SIP Profile",
"type": "string",
"description": "SIP Profile",
"title": "SIP Profile"
},
"sipNormScript": {
"type": "string",
"description": "SIP Normalization Script",
"title": "SIP Normalization Script"
},
"cdpnTransformationCssName": {
"type": "string",
"title": "Called Party Transformation CSS"
},
"cgpnTransformationCssName": {
"type": "string",
"title": "Calling Party Transformation CSS"
},
"redirectDivHeadDel-In": {
"default": "false",
"choices": [
{
"value": "true",
"title": "True"
},
{
"value": "false",
"title": "False"
}
],
"type": "boolean",
"title": "Redirecting Diversion Header Delivery - Inbound"
},
"redirectDivHeadDel-Out": {
"default": "false",
"choices": [
{
"value": "true",
"title": "True"
},
{
"value": "false",
"title": "False"
}
],
"type": "boolean",
"title": "Redirecting Diversion Header Delivery - Outbound"
},
"useDevicePoolCntdPnTransformationCss": {
"default": "false",
"type": "boolean",
"title": "Use Device Pool Connected Party Transformation CSS"
},
"rerouteCallingSearchSpaceName": {
"type": "string",
"title": "Rerouting Calling Search Space"
},
"referCallingSearchSpaceName": {
"type": "string",
"title": "Out-Of-Dialog Refer Calling Search Space"
},
"callingAndCalledPartyInfoFormat": {
"default": "Deliver URI and DN in connected party, if available",
"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"
}
],
"type": "string",
"title": "callingAndCalledPartyInfoFormat"
},
"dtmfSignalingMethod": {
"default": "No Preference",
"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"
}
],
"type": "string",
"title": "dtmfSignalingMethod"
}
}
}
},
"Partition": {
"title": "Partition",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "Partition Name",
"description": "Partition Name",
"type": "string"
},
"description": {
"title": "Partition Description",
"description": "Partition Description",
"type": "string"
},
"timeSchedule": {
"title": "Partition Time Schedule",
"description": "Partition Time Schedule",
"type": "string"
},
"useOrigDeviceTimeZone": {
"title": "Use Originating Device Time Zone",
"description": "Use Originating Device Time Zone",
"type": "boolean",
"default": true
}
}
}
},
"CSS": {
"title": "Css",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "CSS Name",
"description": "CSS Name",
"type": "string"
},
"description": {
"title": "CSS Description",
"description": "CSS Description",
"type": "string"
},
"usage": {
"title": "Partition Usage",
"type": "string",
"default": "General"
},
"members": {
"title": "Partitions",
"description": "The array of default partitions associated with this calling search space.",
"type": "array",
"minItems": 0,
"items": {
"type": "object",
"properties": {
"partition": {
"title": "Route Partition Names",
"description": "Route Partition Names",
"type": "string",
"required": true
},
"index": {
"title": "Partition Index",
"type": "string",
"pattern": "^[0-9]*"
}
}
}
}
}
}
},
"RoutePatterns": {
"title": "Route Patterns",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"dpLocal": {
"title": "Local Dialing",
"description": "Route pattern designation as local dialing built from Dial Plan Input Data",
"type": "boolean",
"default": "{{ fn.false }}"
},
"pattern": {
"title": "Route Pattern",
"description": "Route Pattern",
"type": "string"
},
"description": {
"title": "Route Pattern Description",
"description": "Route Pattern Description",
"type": "string"
},
"routePartition": {
"title": "Route Partition",
"description": "Route Partition",
"type": "string",
"default": "Originating Device"
},
"numPlan": {
"title": "Numbering Plan",
"type": "string"
},
"routeFilter": {
"title": "Route Filter",
"description": "Route Filter",
"type": "string"
},
"routeList": {
"title": "Route List",
"type": "string"
},
"gatewayName": {
"title": "Gateway Name",
"type": "string"
},
"routeOption": {
"title": "Route Option",
"type": "string",
"default": "Route this pattern",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"releaseClause": {
"title": "Release Clause",
"description": "If this is a blocking pattern, select the release clause when the call is blocked.",
"type": "string",
"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"
}
]
},
"callClassification": {
"title": "Call Classification",
"description": "OnNet or Offnet call",
"type": "string",
"default": "OffNet",
"choices": [
{
"value": "OffNet",
"title": "OffNet"
},
{
"value": "OnNet",
"title": "OnNet"
}
]
},
"allowDeviceOverride": {
"title": "Allow Device Override",
"type": "boolean"
},
"provideOutsideDialTone": {
"title": "Provide Outside Dial Tone",
"type": "boolean"
},
"allowOverlapSending": {
"title": "Allow Overlap Sending",
"type": "boolean"
},
"urgentPriority": {
"title": "Urgent Priority",
"type": "boolean"
},
"reqForcedAuthCode": {
"title": "Require Forced Authorization Code",
"type": "boolean"
},
"authLevel": {
"title": "Authorization Level",
"type": "string",
"default": "0"
},
"reqClientMatterCode": {
"title": "Require Client Matter Code",
"type": "boolean"
},
"useCallingPartyExternalPhoneNumMask": {
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Off",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"callingPartyTransformMask": {
"title": "Calling Party Transform Mask",
"type": "string"
},
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"calledPartyDiscardDigits": {
"title": "Called Party Discard Digits",
"type": "string",
"required": false,
"default": "None",
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"calledPartyTransformMask": {
"title": "Called Party Transform Mask",
"type": "string"
},
"calledPartyPrefixDigits": {
"title": "Called Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"cgLinePresBit": {
"title": "Calling Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"cgNamePresBit": {
"title": "Calling Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"title": "Connected Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"title": "Connected Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"patternPrecedence": {
"title": "MLPP Precedence",
"type": "string",
"default": "Default",
"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"
}
]
}
}
}
},
"TransPattern": {
"title": "Trans Pattern",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"dpLocal": {
"title": "Local Dialing",
"description": "Translation pattern designation as local dialing built from Dial Plan Input Data",
"type": "boolean",
"default": "{{ fn.false }}"
},
"pattern": {
"title": "Translation Pattern",
"description": "Translation Pattern",
"type": "string"
},
"description": {
"title": "Translation Pattern Description",
"description": "Translation Pattern Description",
"type": "string"
},
"partition": {
"title": "Partition",
"description": "Partition",
"type": "string"
},
"css": {
"title": "Css",
"type": "string"
},
"useOrigCss": {
"title": "Use Originator's Calling Search Space",
"type": "boolean"
},
"routeOption": {
"title": "Route Option",
"type": "string",
"default": "Route this pattern",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"releaseClause": {
"title": "Release Clause",
"description": "If this is a blocking pattern, select the release clause when the call is blocked.",
"type": "string",
"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"
}
]
},
"provideOutsideDialTone": {
"title": "Provide Outside Dial Tone",
"type": "boolean"
},
"urgentPriority": {
"title": "Urgent Priority",
"type": "boolean"
},
"noWaitInterdigitTimeoutSubseqHops": {
"title": "Do Not Wait For Interdigit Timeout On Subsequent Hops",
"type": "boolean"
},
"nextHopByCallingPtyNum": {
"title": "Route Next Hop By Calling Party Number",
"type": "boolean"
},
"useCallingPartyExternalPhoneNumMask": {
"title": "Use Calling Party's External Phone Number Mask",
"type": "boolean"
},
"callingPartyTransformMask": {
"title": "Calling Party Transform Mask",
"type": "string"
},
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"calledPartyDiscardDigits": {
"title": "Called Party Discard Digits",
"type": "string",
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"calledPartyTransformMask": {
"title": "Called Party Transform Mask",
"type": "string"
},
"calledPartyPrefixDigits": {
"title": "Called Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"cgLinePresBit": {
"title": "Calling Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"cgNamePresBit": {
"title": "Calling Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"title": "Connected Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"title": "Connected Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
}
}
}
},
"CTIRoutePoint": {
"title": "Cti Route Point",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"description": "Dial Plan Name",
"title": "Dial Plan Name"
},
"deviceName": {
"required": true,
"type": "string",
"description": "The name for this CTI route point.",
"title": "Device Name"
},
"description": {
"type": "string",
"description": "Meaningful description for this CTI route point.",
"title": "Description"
},
"devicePool": {
"required": true,
"type": "string",
"title": "Device Pool"
},
"css": {
"type": "string",
"title": "Calling Search Space"
},
"location": {
"type": "string",
"title": "Location"
},
"useTrustedRelayPoint": {
"title": "Use Trusted Relay Point",
"default": "Default",
"required": true,
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
],
"type": "string"
},
"cgPtyTransCss": {
"type": "string",
"title": "Calling Party Transformation CSS"
},
"geolocation": {
"type": "string",
"title": "Geolocation"
},
"useDevPoolCgPtyTransCss": {
"type": "boolean",
"title": "Use Device Pool Calling Party Transformation CSS"
},
"ctirpline": {
"type": "string",
"description": "CTI Route Point DN",
"title": "CTI Route Point DN"
},
"ctirplinept": {
"type": "string",
"description": "CTI Route Point Line Partition",
"title": "CTI Route Point Line Partition"
},
"ctirplinecss": {
"type": "string",
"description": "CTI Route Point Line CSS",
"title": "CTI Route Point Line CSS"
},
"ctirplinedesc": {
"type": "string",
"description": "CTI Route Point Line Description",
"title": "CTI Route Point Line Description"
},
"ctirplinevmprof": {
"type": "string",
"title": "CTI Route Point Line Voicemail Profile"
},
"ctirplinealerting": {
"type": "string",
"description": "CTI Route Point Line Alerting Name",
"title": "CTI Route Point Line Alerting Name"
},
"ctirplinecfwdallvoicemail": {
"default": "false",
"type": "boolean",
"title": "CTI Route Point Line Foward All to Voicemail"
},
"ctirplinedestination": {
"type": "string",
"title": "CTI Route Point Line Destination"
},
"ctirplinecfwdallcss": {
"type": "string",
"title": "CTI Route Point Line Call Forward All CSS"
},
"ctirplinedisplay": {
"type": "string",
"title": "CTI Route Point Line Display (Caller ID)"
},
"ctirplineexternalphonemask": {
"type": "string",
"title": "CTI Route Point Line External Phone Number Mask"
}
}
}
},
"CalledPartyTransformation": {
"title": "Called Party Transformation",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"pattern": {
"title": "Pattern",
"description": "The pattern for this called party transformation.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "A meaningful description for this called party transformation pattern.",
"type": "string"
},
"partition": {
"title": "Route Partition",
"description": "The route partition to which this calling party transformation",
"type": "string"
},
"discarddigits": {
"title": "Discard Digits",
"type": "string",
"choices": [
{
"value": "PreDot",
"title": "PreDot"
},
{
"value": "PreDot Trailing-#",
"title": "PreDot Trailing-#"
}
]
},
"transformmask": {
"title": "Called Party Transformation Mask",
"type": "string"
},
"prefixdigits": {
"title": "Called Party Prefix Digits",
"type": "string"
},
"numtype": {
"title": "Called Party Number Type",
"type": "string",
"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"
}
]
},
"numplan": {
"title": "Called Party Numbering Plan",
"type": "string",
"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"
}
]
}
}
}
},
"CallingPartyTransformation": {
"title": "Calling Party Transformation",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"pattern": {
"title": "Pattern",
"description": "The pattern for this calling party transformation.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "A meaningful description for this calling party transformation pattern.",
"type": "string"
},
"partition": {
"title": "Partition",
"description": "The route partition to which this calling party transformation belongs.",
"type": "string"
},
"usecallingpartyexternalphonenummask": {
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"discarddigits": {
"title": "Calling Party Discard Digits",
"type": "string",
"choices": [
{
"value": "PreDot",
"title": "PreDot"
}
]
},
"transformmask": {
"title": "Calling Party Transform Mask",
"type": "string"
},
"prefixdigits": {
"title": "Calling Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"cglineIdpres": {
"title": "Calling Line ID Presentation",
"type": "string",
"required": true,
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"cgptynumtype": {
"title": "Calling Party Number Type",
"type": "string",
"required": true,
"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"
}
]
},
"cgptynumplan": {
"title": "Calling Party Numbering Plan",
"type": "string",
"required": true,
"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"
}
]
}
}
}
},
"SIPRoutePattern": {
"title": "Sip Route Pattern",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"pattern": {
"title": "Pattern",
"description": "The SIP route pattern.",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"description": "A meaningful description for this SIP route pattern.",
"type": "string"
},
"usage": {
"title": "Usage",
"description": "The usage for this SIP route pattern.",
"type": "string",
"required": true,
"default": "Domain Routing",
"choices": [
{
"value": "Domain Routing",
"title": "Domain Routing"
}
]
},
"routePartitionName": {
"title": "Route Partition",
"description": "The route partition to which this pattern belongs.",
"type": "string",
"required": true
},
"routeOption": {
"title": "Route Option",
"type": "string",
"default": "Route this pattern",
"choices": [
{
"value": "Route this pattern",
"title": "Route this pattern"
},
{
"value": "Block this pattern",
"title": "Block this pattern"
}
]
},
"callingPartyTransformationMask": {
"title": "Calling Party Transformation Mask",
"type": "string"
},
"useCallingPartyExternalPhoneNumMask": {
"title": "Use Calling Party's External Phone Number Mask",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "On",
"title": "On"
},
{
"value": "Off",
"title": "Off"
}
]
},
"callingPartyPrefixDigits": {
"title": "Calling Party Prefix Digits (Outgoing Calls)",
"type": "string"
},
"cgLinePresBit": {
"title": "Calling Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"cgNamePresBit": {
"title": "Calling Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connLinePresBit": {
"title": "Connected Line Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"connNamePresBit": {
"title": "Connected Name Presentation Bit",
"type": "string",
"default": "Default",
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Allowed",
"title": "Allowed"
},
{
"value": "Restricted",
"title": "Restricted"
}
]
},
"sipTrunkName": {
"title": "Sip Trunk/Route List Name",
"type": "string",
"required": true
},
"dnOrPatternIpv6": {
"title": "Dn or Pattern IPv6",
"type": "string"
},
"routeOnUserPart": {
"title": "Route On User Part",
"type": "boolean"
},
"useCallerCss": {
"title": "Use Caller CSS",
"type": "boolean"
},
"domainRoutingCssName": {
"title": "Domain Routing Css Name",
"type": "string"
}
}
}
},
"AdvertisedPatterns": {
"title": "Advertised Patterns",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"pattern": {
"title": "Pattern",
"description": "Pattern",
"type": "string"
},
"patternType": {
"title": "Pattern Type",
"description": "Pattern Type",
"type": "string",
"default": "Enterprise Number",
"choices": [
{
"value": "Enterprise Number",
"title": "Enterprise Number"
},
{
"value": "+E.164 Number",
"title": "+E.164 Number"
}
]
},
"description": {
"title": "Pattern Description",
"description": "Pattern Description",
"type": "string"
},
"pstnRule": {
"title": "Hosted Route PSTN Rule",
"description": "Hosted Route PSTN Rule",
"type": "string",
"default": "No PSTN",
"choices": [
{
"value": "No PSTN",
"title": "No PSTN"
},
{
"value": "Specify",
"title": "Specify"
},
{
"value": "Use pattern",
"title": "Use pattern"
}
]
},
"pstnFailStrip": {
"title": "Pstn Fail Strip",
"description": "Pstn Fail Strip",
"type": "string",
"default": "0"
},
"pstnFailoverPrependDigits": {
"title": "PSTN Failover Prepend Digits",
"description": "PSTN Failover Prepend Digits",
"type": "string",
"default": "0"
}
}
}
},
"CallPark": {
"title": "Call Park",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"callParkNumRange": {
"title": "Call Park Number/Range",
"description": "Call Park Number/Range",
"type": "string",
"required": true
},
"description": {
"title": "Call Park Description",
"description": "Call Park Description",
"type": "string"
},
"partition": {
"title": "Partition",
"description": "Partition",
"type": "string"
},
"cucm": {
"title": "Cisco Unified Communications Manager",
"description": "Cisco Unified Communications Manager",
"type": "string",
"required": true
}
}
}
},
"PhysicalLocation": {
"title": "Physical Location",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "dial plan name",
"type": "string"
},
"plName": {
"title": "Physical Location Name",
"description": "Physical Location Name",
"type": "string"
},
"description": {
"title": "Description",
"description": "Description",
"type": "string"
}
}
}
},
"MTP": {
"title": "Mtp",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"description": "Dial Plan Name",
"type": "string"
},
"name": {
"title": "MTP Name",
"description": "MTP Name",
"type": "string"
},
"description": {
"title": "MTP Description",
"description": "MTP Description",
"type": "string"
},
"mtpDP": {
"title": "MTP Device Pool",
"description": "MTP Device Pool",
"type": "string"
},
"trust": {
"title": "Trusted Relay Point",
"description": "Trusted Relay Point",
"type": "boolean",
"default": "false",
"choices": [
{
"value": "true",
"title": "true"
},
{
"value": "false",
"title": "false"
}
]
}
}
}
},
"CsTenantDialplan": {
"title": "Cs Tenant Dialplan",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"Identity": {
"title": "Name",
"description": "The Identity parameter is a unique identifier that designates the name of the tenant dial plan to modify.",
"type": "string",
"required": true
},
"Description": {
"title": "Description",
"description": "The Description parameter describes the tenant dial plan - what it's for, what type of user it applies to or any other information that helps to identify the purpose of the tenant dial plan. Maximum characters is 1040.",
"type": "string"
},
"SimpleName": {
"title": "Simple Name",
"description": "The SimpleName parameter is a display name for the tenant dial plan. This name must be unique among all tenant dial plans. This string can be up to 49 characters long. Valid characters are alphabetic or numeric characters, hyphen (-), dot (.) and parentheses (()).",
"type": "string"
},
"NormalizationRules": {
"title": "Normalization Rules",
"description": "The NormalizationRules parameter is a list of normalization rules that are applied to this dial plan. The number of normalization rules cannot exceed 50 per TenantDialPlan.",
"type": "array",
"items": {
"type": "object",
"properties": {
"Description": {
"title": "Description",
"description": "A friendly description of the normalization rule. Maximum string length: 512 characters.",
"type": "string"
},
"Name": {
"title": "Name",
"description": "The name of the normalization rule",
"type": "string"
},
"Pattern": {
"title": "Pattern",
"description": "A regular expression that the dialed number must match in order for this rule to be applied. Default: ^(\\d{11})$ (The default represents any set of numbers up to 11 digits.)",
"type": "string"
},
"Translation": {
"title": "Translation",
"description": "The regular expression pattern that will be applied to the number to convert it to E.164 format. Default: +$1 (The default prefixes the number with a plus sign [+].)",
"type": "string"
},
"IsInternalExtension": {
"title": "Is Internal Extension",
"description": "If True, the result of applying this rule will be a number internal to the organization. If False, applying the rule results in an external number. Default: False",
"type": "boolean"
}
}
}
}
}
}
},
"CsOnlinePstnGateway": {
"title": "Cs Online Pstn Gateway",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"Identity": {
"required": true,
"type": "string",
"description": "The parameter is mandatory when modifying an existing SBC.",
"title": "Name"
},
"Description": {
"type": "string",
"title": "Description"
},
"BypassMode": {
"choices": [
{
"value": "None",
"title": "None"
},
{
"value": "Always",
"title": "Always"
},
{
"value": "OnlyForLocalUsers",
"title": "OnlyForLocalUsers"
}
],
"type": "string",
"description": "Possible values are \"None\", \"Always\" and \"OnlyForLocalUsers\". By setting \"Always\" mode you indicate that your network is fully routable. If a user usually in site \"Seattle\", travels to site \"Tallinn\" and tries to use SBC located in Seattle we will try to deliver the traffic to Seattle assuming that there is connection between Tallinn and Seattle offices. With \"OnlyForLocaUsers\" you indicate that there is no direct connection between sites. In example above, the traffic will not be send directly from Tallinn to Seattle.",
"title": "Bypass Mode"
},
"Enabled": {
"type": "boolean",
"description": "Used to enable this SBC for outbound calls. Can be used to temporarily remove the SBC from service while it is being updated or during maintenance. Note if the parameter is not set the SBC will be created as disabled (default value -Enabled $false).",
"title": "Enabled"
},
"FailoverResponseCodes": {
"type": "string",
"description": "Comma separated numbers between 400 and 599",
"title": "Failover Response Codes"
},
"FailoverTimeSeconds": {
"type": "integer",
"description": "When set to 10 (default value), outbound calls that are not answered by the gateway within 10 seconds are routed to the next available trunk; if there are no additional trunks, then the call is automatically dropped. In an organization with slow networks and slow gateway responses, that could potentially result in calls being dropped unnecessarily. The default value is 10.",
"title": "Failover Time Seconds"
},
"ForwardCallHistory": {
"type": "boolean",
"description": "Indicates whether call history information will be forwarded through the trunk. If enabled, the Office 365 PSTN Proxy sends two headers: History-info and Referred-By. The default value is False ($False).",
"title": "Forward Call History"
},
"ForwardPai": {
"type": "boolean",
"description": "Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. The PAI header provides a way to verify the identity of the caller. The default value is False ($False). Setting this parameter to $true will render the from header anonymous, in accordance of RFC5379 and RFC3325.",
"title": "Forward PAI"
},
"Fqdn": {
"type": "string",
"description": "Fully qualified domain name",
"title": "FQDN"
},
"GatewayLbrEnabledUserOverride": {
"type": "boolean",
"title": "Gateway LBR Enabled User Override"
},
"GatewaySiteId": {
"type": "string",
"description": "PSTN Gateway Site ID.",
"title": "Gateway Site ID"
},
"GatewaySiteLbrEnabled": {
"type": "boolean",
"description": "Used to enable this SBC to report assigned site location. Site location is used for Location Based Routing. When this parameter is turned on, the SBC will report the site name as defined by tenant administrator. On incoming call to a Teams user the value of the site assigned to the SBC is compared with the value of the site assigned to the user to make a routing decision. The parameter is mandatory for enabling Location Based Routing feature. The default value is False ($False).",
"title": "Gateway Site LBR Enabled"
},
"InboundPstnNumberTranslationRules": {
"items": {
"type": "string"
},
"type": "array",
"description": "Creates an ordered list of Teams translation rules, that apply to PSTN number on inbound direction.",
"title": "Inbound PSTN Number Translation Rules"
},
"InboundTeamsNumberTranslationRules": {
"items": {
"type": "string"
},
"type": "array",
"description": "This parameter assigns an ordered list of Teams translation rules, that apply to Teams numbers on inbound direction.",
"title": "Inbound Teams Number Translation Rules"
},
"MaxConcurrentSessions": {
"type": "integer",
"description": "Used by the alerting system. When any value is set, the alerting system will generate an alert to the tenant administrator when the number of concurrent session is 90% or higher than this value. If this parameter is not set, the alerts are not generated. However, the monitoring system will report the number of concurrent sessions every 24 hours.",
"title": "Max Concurrent Sessions"
},
"MediaBypass": {
"type": "boolean",
"description": "Parameter indicated of the SBC supports Media Bypass and the administrator wants to use it for this SBC.",
"title": "Media Bypass"
},
"MediaRelayRoutingLocationOverride": {
"type": "string",
"description": "This parameter is reserved for use with managed carriers. Allows selecting path for media manually. Direct Routing assigns a datacenter for media path based on the public IP of the SBC. We always select closest to the SBC datacenter. However, in some cases a public IP from for example a US range can be assigned to an SBC located in Europe. In this case we will be using not optimal media path. This parameter allows manually set the preferred region for media traffic. We only recommend setting this parameter if the call logs clearly indicate that automatic assignment of the datacenter for media path does not assign the closest to the SBC datacenter",
"title": "Media Relay Routing Location Override"
},
"OutboundPstnNumberTranslationRules": {
"items": {
"type": "string"
},
"type": "array",
"description": "Assigns an ordered list of Teams translation rules, that apply to PSTN number on outbound direction.",
"title": "Outbound PSTN Number Translation Rules"
},
"OutboundTeamsNumberTranslationRules": {
"items": {
"type": "string"
},
"type": "array",
"description": "Assigns an ordered list of Teams translation rules, that apply to Teams numbers on outbound direction.",
"title": "Outbound Teams Number Translation Rules"
},
"PidfLoSupported": {
"type": "boolean",
"description": "Enables PIDF-LO support on the PSTN Gateway. If turned on the .xml body payload is sent to the SBC with the location details of the user.",
"title": "PIDF-LO Supported"
},
"ProxySbc": {
"type": "string",
"title": "Proxy SBC"
},
"SendSipOptions": {
"type": "boolean",
"description": "Defines if an SBC will or will not send the SIP options. If disabled, the SBC will be excluded from Monitoring and Alerting system. We highly recommend that you enable SIP options. Default value is True.",
"title": "Send SIP Options"
},
"SipSignalingPort": {
"required": true,
"type": "integer",
"description": "Listening port used for communicating with Direct Routing services by using the Transport Layer Security (TLS) protocol. The value must be between 1 and 65535.",
"title": "SIP Signaling Port"
}
}
}
},
"CsOnlinePstnUsage": {
"title": "Cs Online Pstn Usage",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"Usage": {
"required": true,
"type": "string",
"description": "String value used for call authorization. Links an online voice policy to a route.",
"title": "Usage"
}
}
}
},
"CsOnlineVoiceRoute": {
"title": "Cs Online Voice Route",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"Identity": {
"title": "Name",
"description": "The unique identity of the online voice route. ",
"type": "string",
"required": true
},
"Description": {
"title": "Description",
"description": "A description of what this phone route is for.",
"type": "string"
},
"NumberPattern": {
"title": "Number Pattern",
"description": "A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. For example, the default number pattern, [0-9]{10}, specifies a 10-digit number containing any digits 0 through 9.",
"type": "string"
},
"OnlinePstnUsages": {
"title": "Online PSTN Usages",
"description": "A list of online PSTN usages (such as Local, Long Distance, etc.) that can be applied to this online voice route. The PSTN usage must be an existing usage.",
"type": "array",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlinePstnUsage/choices/?choice_title=Usage&field=Usage&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Usage",
"target_title": "Usage",
"target_model_type": "device/msteamsonline/CsOnlinePstnUsage",
"choices": []
}
},
"OnlinePstnGatewayList": {
"title": "Online PSTN Gateway List",
"description": "This parameter contains a list of online gateways associated with this online voice route. Each member of this list must be the service Identity of the online PSTN gateway. The service Identity is the fully qualified domain name (FQDN) of the pool or the IP address of the server. For example, redmondpool.litwareinc.com.",
"type": "array",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlinePstnGateway/choices/?choice_title=Identity&field=Identity&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Identity",
"target_title": "Identity",
"target_model_type": "device/msteamsonline/CsOnlinePstnGateway",
"choices": []
}
},
"Priority": {
"title": "Priority",
"description": "A number could resolve to multiple online voice routes. The priority determines the order in which the routes will be applied if more than one route is possible.",
"type": "integer"
}
}
}
},
"CsOnlineVoiceRoutingPolicy": {
"title": "Cs Online Voice Routing Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"Identity": {
"title": "Name",
"description": "Unique identifier assigned to the policy when it was created. Online voice routing policies can be assigned at the global scope or the per-user scope.",
"type": "string",
"required": true
},
"Description": {
"title": "Description",
"description": "Enables administrators to provide explanatory text to accompany an online voice routing policy. For example, the Description might include information about the users the policy should be assigned to.",
"type": "string"
},
"OnlinePstnUsages": {
"title": "Online PSTN Usages",
"description": "A list of online PSTN usages (such as Local or Long Distance) that can be applied to this online voice routing policy. The online PSTN usage must be an existing usage.",
"type": "array",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlinePstnUsage/choices/?choice_title=Usage&field=Usage&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Usage",
"target_title": "Usage",
"target_model_type": "device/msteamsonline/CsOnlinePstnUsage",
"choices": []
}
},
"RouteType": {
"title": "Route Type",
"description": "",
"type": "string"
}
}
}
},
"CsTeamsTranslationRule": {
"title": "Cs Teams Translation Rule",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"Identity": {
"required": true,
"type": "string",
"description": "Identifier of the rule. This parameter is required and later used to assign the rule to Inbound or Outbound Trunk Normalization policy.",
"title": "Name"
},
"Description": {
"type": "string",
"description": "A friendly description of the normalization rule.",
"title": "Description"
},
"Translation": {
"type": "string",
"description": "The regular expression pattern that will be applied to the number to convert it.",
"title": "Translation"
},
"Pattern": {
"type": "string",
"description": "A regular expression that caller or callee number must match in order for this rule to be applied.",
"title": "Pattern"
}
}
}
},
"CsTeamsCallingPolicy": {
"title": "Cs Teams Calling Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"AllowCallForwardingToPhone": {
"type": "boolean",
"title": "Allow Call Forwarding To Phone"
},
"AllowCallForwardingToUser": {
"type": "boolean",
"title": "Allow Call Forwarding To User"
},
"AllowCallGroups": {
"type": "boolean",
"title": "Allow Call Groups"
},
"AllowCalling": {
"readonly": true,
"type": "boolean",
"title": "Allow Calling"
},
"AllowCloudRecordingForCalls": {
"type": "boolean",
"title": "Allow Cloud Recording For Calls"
},
"AllowDelegation": {
"type": "boolean",
"title": "Allow Delegation"
},
"AllowPrivateCalling": {
"type": "boolean",
"title": "Allow Private Calling"
},
"AllowTranscriptionForCalling": {
"type": "boolean",
"title": "Allow Transcription For Calling"
},
"AllowUserControl": {
"readonly": true,
"type": "boolean",
"title": "Allow User Control"
},
"AllowVoicemail": {
"choices": [
{
"value": "AlwaysEnabled",
"title": "Always Enabled"
},
{
"value": "AlwaysDisabled",
"title": "Always Disabled"
},
{
"value": "UserOverride",
"title": "User Override"
}
],
"type": "string",
"title": "Allow Voicemail"
},
"AllowWebPSTNCalling": {
"type": "boolean",
"title": "Allow Web PSTN Calling"
},
"AutoAnswerEnabledType": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"title": "Auto Answer Enabled Type"
},
"BusyOnBusyEnabledType": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Unanswered",
"title": "Unanswered"
}
],
"type": "string",
"title": "Busy On Busy Enabled Type"
},
"Description": {
"type": "string",
"title": "Description"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"title": "Identity"
},
"LiveCaptionsEnabledTypeForCalling": {
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "DisabledUserOverride",
"title": "Disabled User Override"
}
],
"type": "string",
"title": "Live Captions Enabled Type For Calling"
},
"MusicOnHoldEnabledType": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "UserOverride",
"title": "User Override"
}
],
"type": "string",
"title": "Music On Hold Enabled Type"
},
"PreventTollBypass": {
"type": "boolean",
"title": "Prevent Toll Bypass"
},
"SafeTransferEnabled": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "UserOverride",
"title": "User Override"
}
],
"type": "string",
"title": "Safe Transfer Enabled"
},
"SpamFilteringEnabledType": {
"choices": [
{
"value": "Enabled",
"title": "Enabled"
},
{
"value": "Disabled",
"title": "Disabled"
}
],
"type": "string",
"title": "Spam Filtering Enabled Type"
}
}
}
},
"CsTeamsCallParkPolicy": {
"title": "Cs Teams Call Park Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"AllowCallPark": {
"type": "boolean",
"title": "Allow Call Park"
},
"Description": {
"type": "string",
"title": "Description"
},
"Identity": {
"required": true,
"type": "string",
"title": "Identity"
},
"ParkTimeoutSeconds": {
"type": "integer",
"title": "Park Timeout Seconds"
},
"PickupRangeEnd": {
"type": "integer",
"title": "Pickup Range End"
},
"PickupRangeStart": {
"type": "integer",
"title": "Pickup Range Start"
}
}
}
},
"CsTeamsEmergencyCallRoutingPolicy": {
"title": "Cs Teams Emergency Call Routing Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"AllowEnhancedEmergencyServices": {
"title": "Allow Enhanced Emergency Services",
"description": "Flag to enable Enhanced Emergency Services",
"type": "boolean"
},
"Description": {
"title": "Description",
"description": "Provide a description of the Teams Emergency Calling policy to identify purpose of setting it.",
"type": "string"
},
"EmergencyNumbers": {
"title": "Emergency Numbers",
"description": "One or more emergency number objects",
"type": "array",
"required": true,
"items": {
"type": "object",
"properties": {
"EmergencyDialString": {
"title": "Emergency Dial String",
"description": "Specifies the emergency phone number.",
"type": "string",
"required": true
},
"EmergencyDialMask": {
"title": "Emergency Dial Mask",
"description": "For each Teams emergency number, you can specify zero or more emergency dial masks. A dial mask is a number that you want to translate into the value of the emergency dial number value when it is dialed.",
"type": "string"
},
"OnlinePSTNUsage": {
"title": "Online PSTN Usage",
"description": "Specify the online public switched telephone network (PSTN) usage",
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlinePstnUsage/choices/?choice_title=Usage&field=Usage&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "Usage",
"target_title": "Usage",
"target_model_type": "device/msteamsonline/CsOnlinePstnUsage",
"choices": []
}
}
}
},
"Identity": {
"title": "Name",
"description": "The Identity parameter is a unique identifier that designates the name of the policy.",
"type": "string",
"required": true,
"readonly": true
}
}
}
},
"CsTeamsEmergencyCallingPolicy": {
"title": "Cs Teams Emergency Calling Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"title": "Dial Plan Name",
"type": "string",
"required": true
},
"Description": {
"title": "Description",
"description": "Provide a description of the Teams Emergency Calling policy to identify purpose of setting it.",
"type": "string"
},
"ExternalLocationLookupMode": {
"title": "External Location Lookup Mode",
"description": "Enable ExternalLocationLookupMode. This parameter is currently not supported.",
"type": "string",
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Enabled",
"title": "Enabled"
}
]
},
"Identity": {
"title": "Name",
"description": "The Identity parameter is a unique identifier that designates the name of the policy",
"type": "string",
"required": true,
"readonly": true
},
"NotificationDialOutNumber": {
"title": "Notification Dial Out Number",
"description": "This parameter represents PSTN number which can be dialed out if NotificationMode is set to either of the two Conference values",
"type": "string"
},
"NotificationGroup": {
"title": "Notification Group",
"description": "NotificationGroup is a email list of users and groups to be notified of an emergency call. Notification group is required if notification mode is \"NotificationOnly\".",
"type": "array",
"items": {
"type": "string",
"format": "uri",
"target": "/api/device/msteamsonline/CsOnlineUser/choices/?choice_title=UserPrincipalName&field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "UserPrincipalName",
"target_title": "UserPrincipalName",
"target_model_type": "device/msteamsonline/CsOnlineUser",
"choices": []
}
},
"NotificationMode": {
"title": "Notification Mode",
"description": "The type of conference experience for security desk notification. Either notification group or Notification dial number is required if notification mode is \"ConferenceMuted\" or \"ConferenceUnMuted\".",
"type": "string",
"choices": [
{
"value": "NotificationOnly",
"title": "Notification Only"
},
{
"value": "ConferenceMuted",
"title": "Conference Muted"
},
{
"value": "ConferenceUnMuted",
"title": "Conference Unmuted"
}
]
}
}
}
},
"CsOnlineVoicemailPolicy": {
"title": "Cs Online Voicemail Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"EnableEditingCallAnswerRulesSetting": {
"type": "boolean",
"title": "Enable Editing Call Answer Rules Setting"
},
"EnableTranscription": {
"type": "boolean",
"title": "Enable Transcription"
},
"EnableTranscriptionProfanityMasking": {
"type": "boolean",
"title": "Enable Transcription Profanity Masking"
},
"EnableTranscriptionTranslation": {
"type": "boolean",
"title": "Enable Transcription Translation"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"title": "Identity"
},
"MaximumRecordingLength": {
"type": "string",
"description": "A duration of voicemail maximum recording length. The length should be between 30 seconds to 10 minutes.",
"title": "Maximum Recording Length"
},
"PrimarySystemPromptLanguage": {
"type": "string",
"title": "Primary System Prompt Language"
},
"SecondarySystemPromptLanguage": {
"type": "string",
"title": "Secondary System Prompt Language"
},
"ShareData": {
"type": "string",
"title": "Share Data"
}
}
}
},
"CsCallingLineIdentity": {
"title": "Cs Calling Line Identity",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"BlockIncomingPstnCallerID": {
"type": "boolean",
"title": "Block Incoming PSTN Caller ID"
},
"CallingIDSubstitute": {
"choices": [
{
"value": "Anonymous",
"title": "Anonymous"
},
{
"value": "LineUri",
"title": "User's number"
},
{
"value": "Resource",
"title": "Resource account"
}
],
"type": "string",
"title": "Replace the caller ID with"
},
"Description": {
"type": "string",
"title": "Description"
},
"EnableUserOverride": {
"type": "boolean",
"title": "Enable User Override"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"title": "Identity"
},
"ServiceNumber": {
"type": "string",
"title": "Service Number"
},
"ResourceAccount": {
"target": "/api/device/msteamsonline/CsOnlineApplicationInstance/choices/?field=UserPrincipalName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Resource Account",
"target_attr": "UserPrincipalName",
"type": "string",
"target_model_type": "device/msteamsonline/CsOnlineApplicationInstance",
"choices": []
},
"ResourceAccountNumber": {
"readonly": true,
"type": "string",
"title": "Resource Account Number"
},
"CompanyName": {
"type": "string",
"title": "Calling Party Name"
}
}
}
},
"CsTeamsEnhancedEncryptionPolicy": {
"title": "Cs Teams Enhanced Encryption Policy",
"type": "array",
"items": {
"type": "object",
"properties": {
"dpName": {
"required": true,
"type": "string",
"title": "Dial Plan Name"
},
"Identity": {
"readonly": true,
"required": true,
"type": "string",
"title": "Identity"
},
"Description": {
"type": "string",
"title": "Description"
},
"CallingEndtoEndEncryptionEnabledType": {
"choices": [
{
"value": "DisabledUserOverride",
"title": "Not enabled, but users can enable"
},
{
"value": "Disabled",
"title": "Not enabled"
}
],
"type": "string",
"title": "End-to-end call encryption"
},
"MeetingEndToEndEncryption": {
"choices": [
{
"value": "DisabledUserOverride",
"title": "Not enabled, but users can enable"
},
{
"value": "Disabled",
"title": "Not enabled"
}
],
"type": "string",
"title": "End-to-end meeting encryption"
}
}
}
}
},
"schema_version": "0.2"
}
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "dpName",
"direction": "asc",
"current": "/api/relation/DP_REL/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=fulltree"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"remove",
"add",
"export",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/DP_REL",
"summary_attrs": [
{
"name": "dpName",
"title": "Dial Plan Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"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/DP_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"update",
"help",
"remove",
"add",
"export",
"export_bulkload_template",
"get"
],
"schema_version": "0.2",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/DP_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/DP_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/DP_REL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"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. |