[Index]
This relation wraps the device/cucm/SipRoutePattern element.
Model ref.: relation/HcsSipRoutePatternREL
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": { "connectedNamePresentationBit": { "title": "Connected Name Presentation Bit", "minItems": 0, "required": false, "choices": [ { "value": "Default", "title": "Default" }, { "value": "Allowed", "title": "Allowed" }, { "value": "Restricted", "title": "Restricted" } ], "default": "Default", "maxItems": 1, "type": "string" }, "description": { "title": "Description", "minItems": 0, "required": false, "maxItems": 1, "maxLength": 50, "type": "string" }, "callingPartyPrefixDigits": { "title": "Calling Party Prefix Digits", "minItems": 0, "pattern": "^[0-9*#+]{0,50}$", "required": false, "maxItems": 1, "maxLength": 50, "type": [ "string", "null" ] }, "callingLinePresentationBit": { "title": "Calling Line Presentation Bit", "minItems": 0, "required": false, "choices": [ { "value": "Default", "title": "Default" }, { "value": "Allowed", "title": "Allowed" }, { "value": "Restricted", "title": "Restricted" } ], "default": "Default", "maxItems": 1, "type": "string" }, "callingNamePresentationBit": { "title": "Calling Name Presentation Bit", "minItems": 0, "required": false, "choices": [ { "value": "Default", "title": "Default" }, { "value": "Allowed", "title": "Allowed" }, { "value": "Restricted", "title": "Restricted" } ], "default": "Default", "maxItems": 1, "type": "string" }, "pattern": { "minItems": 1, "required": true, "type": "string", "maxItems": 1, "title": "Pattern" }, "sipTrunkName": { "target": "/api/device/cucm/SipTrunk/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 1, "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/SipTrunk", "title": "Sip Trunk Name", "type": "string" }, "dnOrPatternIpv6": { "minItems": 0, "required": false, "type": "string", "maxItems": 1, "title": "Dn Or Pattern Ipv6" }, "callingPartyTransformationMask": { "title": "Calling Party Transformation Mask", "minItems": 0, "pattern": "^[0-9*#+X]{0,50}$", "required": false, "maxItems": 1, "maxLength": 50, "type": [ "string", "null" ] }, "connectedLinePresentationBit": { "title": "Connected Line Presentation Bit", "minItems": 0, "required": false, "choices": [ { "value": "Default", "title": "Default" }, { "value": "Allowed", "title": "Allowed" }, { "value": "Restricted", "title": "Restricted" } ], "default": "Default", "maxItems": 1, "type": "string" }, "useCallerCss": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Use Caller Css" }, "domainRoutingCssName": { "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 0, "required": false, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/Css", "title": "Domain Routing Css Name", "type": [ "string", "null" ] }, "usage": { "description": "For Intercom DN and Intercom Translation patterns the usage tag value needs to be specified explicitly as Device Intercom and Translation Intercom respectively. For all other patterns it is a Read-only tag.", "title": "Usage", "minItems": 1, "required": true, "choices": [ { "value": "CallPark", "title": "CallPark" }, { "value": "Conference", "title": "Conference" }, { "value": "Device", "title": "Device" }, { "value": "Translation", "title": "Translation" }, { "value": "Call Pick Up Group", "title": "Call Pick Up Group" }, { "value": "Route", "title": "Route" }, { "value": "Message Waiting", "title": "Message Waiting" }, { "value": "Hunt Pilot", "title": "Hunt Pilot" }, { "value": "Voice Mail Port", "title": "Voice Mail Port" }, { "value": "Domain Routing", "title": "Domain Routing" }, { "value": "IPAddress Routing", "title": "IPAddress Routing" }, { "value": "Device template", "title": "Device template" }, { "value": "Directed Call Park", "title": "Directed Call Park" }, { "value": "Device Intercom", "title": "Device Intercom" }, { "value": "Translation Intercom", "title": "Translation Intercom" }, { "value": "Translation Calling Party Number", "title": "Translation Calling Party Number" }, { "value": "Mobility Handoff", "title": "Mobility Handoff" }, { "value": "Mobility Enterprise Feature Access", "title": "Mobility Enterprise Feature Access" }, { "value": "Mobility IVR", "title": "Mobility IVR" }, { "value": "Device Intercom Template", "title": "Device Intercom Template" }, { "value": "Called Party Number Transformation", "title": "Called Party Number Transformation" }, { "value": "Call Control Discovery Learned Pattern", "title": "Call Control Discovery Learned Pattern" }, { "value": "Uri Routing", "title": "Uri Routing" }, { "value": "ILS Learned Enterprise Number", "title": "ILS Learned Enterprise Number" }, { "value": "ILS Learned E164 Number", "title": "ILS Learned E164 Number" }, { "value": "ILS Learned Enterprise Numeric Pattern", "title": "ILS Learned Enterprise Numeric Pattern" }, { "value": "ILS Learned E164 Numeric Pattern", "title": "ILS Learned E164 Numeric Pattern" }, { "value": "Alternate Number", "title": "Alternate Number" }, { "value": "ILS Learned URI", "title": "ILS Learned URI" }, { "value": "ILS Learned PSTN Failover Rule", "title": "ILS Learned PSTN Failover Rule" }, { "value": "ILS Imported E164 Number", "title": "ILS Imported E164 Number" }, { "value": "Centralized Conference Number", "title": "Centralized Conference Number" }, { "value": "Emergency Location ID Number", "title": "Emergency Location ID Number" } ], "maxItems": 1, "type": "string" }, "shadow": { "items": { "type": "object", "properties": { "name": { "is_password": false, "title": "Name", "required": true, "displayable": false, "readonly": false, "maxLength": 1024, "type": "string" } } }, "type": "array", "maxItems": 1, "title": "Shadow" }, "useCallingPartyPhoneMask": { "title": "Use Calling Party Phone Mask", "minItems": 1, "required": true, "choices": [ { "value": "Off", "title": "Off" }, { "value": "On", "title": "On" }, { "value": "Default", "title": "Default" } ], "default": "Default", "maxItems": 1, "type": "string" }, "routePartitionName": { "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "format": "uri", "minItems": 1, "required": true, "choices": [], "target_attr": "name", "maxItems": 1, "target_model_type": "device/cucm/RoutePartition", "title": "Route Partition Name", "type": [ "string", "null" ] }, "routeOnUserPart": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Route On User Part" }, "blockEnable": { "minItems": 0, "required": false, "type": "boolean", "maxItems": 1, "title": "Block Enable" } }, "schema_version": "2.3" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/relation/HcsSipRoutePatternREL/add/ |
|
The GUI Add form of relation/HcsSipRoutePatternREL 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/HcsSipRoutePatternREL/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk delete [pkid1],[pkid2]... | DELETE | /api/relation/HcsSipRoutePatternREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsSipRoutePatternREL/[pkid1]", "/api/relation/HcsSipRoutePatternREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsSipRoutePatternREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=relation/HcsSipRoutePatternREL |
|
{"hrefs": ["/api/relation/HcsSipRoutePatternREL/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=relation/HcsSipRoutePatternREL |
|
{"hrefs": ["/api/relation/HcsSipRoutePatternREL/[pkid1]", "/api/relation/HcsSipRoutePatternREL/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsSipRoutePatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsSipRoutePatternREL/export/ |
|
{ "hrefs":["/api/relation/HcsSipRoutePatternREL/[pkid1]", "/api/relation/HcsSipRoutePatternREL/[pkid2]",...]}} |
For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
The XLSX format can be used to bulk load instances of relation/HcsSipRoutePatternREL and the JSON format can be used to import instances of relation/HcsSipRoutePatternREL.
GET http://[host-proxy]/api/relation/HcsSipRoutePatternREL/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for relation/HcsSipRoutePatternREL | POST | /api/relation/HcsSipRoutePatternREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/relation/HcsSipRoutePatternREL/ |
|
The relation/HcsSipRoutePatternREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsSipRoutePatternREL instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "clone", "move", "list", "update", "remove", "add", "bulk_update", "export", "export_bulkload_template" ], "pagination": { "direction": "asc", "order_by": "pattern", "maximum_limit": 2000, "skip": 0, "current": "/api/relation/HcsSipRoutePatternREL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 0 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": {}, "schema_version": "2.3", "references": { "device": [ { "pkid": "", "href": "" } ], "self": [ { "pkid": null, "href": "/api/relation/HcsSipRoutePatternREL/None/" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/relation/HcsSipRoutePatternREL/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/relation/HcsSipRoutePatternREL/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=relation/HcsSipRoutePatternREL", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/relation/HcsSipRoutePatternREL/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/relation/HcsSipRoutePatternREL/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/relation/HcsSipRoutePatternREL/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/relation/HcsSipRoutePatternREL/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "relation/HcsSipRoutePatternREL", "model_specific_actions": [ "help", "get", "clone", "move", "list", "update", "remove", "add", "export", "export_bulkload_template" ], "summary_attrs": [ { "name": "pattern", "title": "Pattern" }, { "name": "description", "title": "Description" }, { "name": "routePartitionName", "title": "Route Partition Name" }, { "name": "dnOrPatternIpv6", "title": "Dn Or Pattern Ipv6" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "20.1.1", "tagged_versions": [] }, "resources": [] }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for relation/HcsSipRoutePatternREL. | GET | /api/relation/HcsSipRoutePatternREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsSipRoutePatternREL as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/relation/HcsSipRoutePatternREL/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/relation/HcsSipRoutePatternREL/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/relation/HcsSipRoutePatternREL/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/relation/HcsSipRoutePatternREL/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=relation/HcsSipRoutePatternREL | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsSipRoutePatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsSipRoutePatternREL/[pkid]/export/ |
|
The response is an attachment. Refer to the list below. |
For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:
Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx Content-Language:en Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
For export_format=json, the response is a time stamped zip file of data in JSON and a response format:
Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip Content-Language:en Content-Type:application/x-zip
The XLSX format can be used to bulk load instances of relation/HcsSipRoutePatternREL and the JSON format can be used to import instances of relation/HcsSipRoutePatternREL.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/relation/HcsSipRoutePatternREL/[pkid]/ | hierarchy=[hierarchy] | The relation/HcsSipRoutePatternREL instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/relation/HcsSipRoutePatternREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsSipRoutePatternREL. |