API Reference for relation/HcsDpSipRoutePatternREL

Model ref.: relation/HcsDpSipRoutePatternREL

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/relation/HcsDpSipRoutePatternREL/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$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"
               ]
          },
          "useCallerCss": {
               "title": "Use Caller Css",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": "boolean"
          },
          "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": {
               "title": "Pattern",
               "minItems": 1,
               "required": true,
               "maxItems": 1,
               "type": "string"
          },
          "sipTrunkName": {
               "title": "Sip Trunk Name",
               "minItems": 1,
               "format": "uri",
               "required": true,
               "target_attr": "name",
               "maxItems": 1,
               "type": "string",
               "target": "/api/device/cucm/SipTrunk/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "target_model_type": "device/cucm/SipTrunk",
               "choices": []
          },
          "dnOrPatternIpv6": {
               "title": "Dn Or Pattern Ipv6",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": "string"
          },
          "routeOnUserPart": {
               "title": "Route On User Part",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": "boolean"
          },
          "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"
          },
          "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"
          },
          "domainRoutingCssName": {
               "title": "Domain Routing Css Name",
               "minItems": 0,
               "format": "uri",
               "required": false,
               "target_attr": "name",
               "maxItems": 1,
               "type": [
                    "string",
                    "null"
               ],
               "target": "/api/device/cucm/Css/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "target_model_type": "device/cucm/Css",
               "choices": []
          },
          "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"
          },
          "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": {
               "title": "Route Partition Name",
               "minItems": 1,
               "format": "uri",
               "required": true,
               "target_attr": "name",
               "maxItems": 1,
               "type": [
                    "string",
                    "null"
               ],
               "target": "/api/device/cucm/RoutePartition/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
               "target_model_type": "device/cucm/RoutePartition",
               "choices": []
          },
          "callingPartyTransformationMask": {
               "title": "Calling Party Transformation Mask",
               "minItems": 0,
               "pattern": "^[0-9*#+X]{0,50}$",
               "required": false,
               "maxItems": 1,
               "maxLength": 50,
               "type": [
                    "string",
                    "null"
               ]
          },
          "blockEnable": {
               "title": "Block Enable",
               "minItems": 0,
               "required": false,
               "maxItems": 1,
               "type": "boolean"
          },
          "shadow": {
               "title": "Shadow",
               "type": "array",
               "items": {
                    "type": "object",
                    "properties": {
                         "name": {
                              "title": "Name",
                              "type": "string",
                              "maxLength": 1024,
                              "required": true,
                              "readonly": false,
                              "is_password": false,
                              "displayable": false
                         }
                    }
               },
               "maxItems": 1
          }
     },
     "schema_version": "2.1"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/relation/HcsDpSipRoutePatternREL/add/	hierarchy=[hierarchy] format=json	The GUI Add form of relation/HcsDpSipRoutePatternREL 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/HcsDpSipRoutePatternREL	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

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/HcsDpSipRoutePatternREL/	hierarchy=[hierarchy]	{"hrefs":["/api/relation/HcsDpSipRoutePatternREL/[pkid1]", "/api/relation/HcsDpSipRoutePatternREL/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/HcsDpSipRoutePatternREL
```
GET http://[host-proxy]/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsDpSipRoutePatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/relation/HcsDpSipRoutePatternREL/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/relation/HcsDpSipRoutePatternREL/[pkid1]", "/api/relation/HcsDpSipRoutePatternREL/[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/HcsDpSipRoutePatternREL and the JSON format can be used to import instances of relation/HcsDpSipRoutePatternREL.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/HcsDpSipRoutePatternREL:

 GET http://[host-proxy]/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for relation/HcsDpSipRoutePatternREL	POST	/api/relation/HcsDpSipRoutePatternREL/export_bulkload_template/	hierarchy=[hierarchy] modeltype=relation/HcsDpSipRoutePatternREL	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/relation/HcsDpSipRoutePatternREL/	hierarchy=[hierarchy] format=json schema=true	The relation/HcsDpSipRoutePatternREL schema and all instances as JSON.

(The list will return 0 to 3 relation/HcsDpSipRoutePatternREL instances)

GET http://[host]/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "pagination": {
          "skip": 0,
          "limit": 3,
          "maximum_limit": 2000,
          "total": 0,
          "total_limit": null,
          "order_by": "pattern",
          "direction": "asc",
          "current": "/api/relation/HcsDpSipRoutePatternREL/?skip=0&limit=3&order_by=pattern&direction=asc&traversal=down"
     },
     "operations": [
          "bulk_update",
          "help",
          "update",
          "add",
          "export",
          "get",
          "list",
          "export_bulkload_template",
          "remove",
          "configuration_template",
          "field_display_policy"
     ],
     "meta": {
          "model_type": "relation/HcsDpSipRoutePatternREL",
          "summary_attrs": [
               {
                    "name": "pattern",
                    "title": "Pattern"
               },
               {
                    "name": "description",
                    "title": "Description"
               },
               {
                    "name": "routePartitionName",
                    "title": "Route Partition Name"
               },
               {
                    "name": "dnOrPatternIpv6",
                    "title": "Dn Or Pattern Ipv6"
               },
               {
                    "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/HcsDpSipRoutePatternREL/None/",
                         "pkid": null
                    }
               ]
          },
          "model_specific_actions": [
               "help",
               "update",
               "add",
               "export",
               "get",
               "list",
               "export_bulkload_template",
               "remove"
          ],
          "schema_version": "2.1",
          "actions": [
               {
                    "add": {
                         "method": "GET",
                         "class": "add",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/add/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Add"
                    }
               },
               {
                    "remove": {
                         "method": "DELETE",
                         "class": "delete",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]",
                         "support_async": true,
                         "title": "Delete"
                    }
               },
               {
                    "export": {
                         "method": "POST",
                         "class": "export",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/export/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export",
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken],
                         "submit": "payload"
                    }
               },
               {
                    "export_bulkload_template": {
                         "method": "POST",
                         "class": "bulkload_template",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/export_bulkload_template/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Export Bulk Load Template"
                    }
               },
               {
                    "list": {
                         "method": "GET",
                         "class": "list",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "List"
                    }
               },
               {
                    "help": {
                         "method": "GET",
                         "class": "help",
                         "href": "/api/relation/HcsDpSipRoutePatternREL/help?hierarchy=[hierarchy]",
                         "support_async": false,
                         "title": "Help"
                    }
               }
          ]
     },
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for relation/HcsDpSipRoutePatternREL.	GET	/api/relation/HcsDpSipRoutePatternREL/help	hierarchy=[hierarchy]	On-line help of Model ref.: relation/HcsDpSipRoutePatternREL as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/relation/HcsDpSipRoutePatternREL/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/relation/HcsDpSipRoutePatternREL/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsDpSipRoutePatternREL; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/relation/HcsDpSipRoutePatternREL/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	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/HcsDpSipRoutePatternREL and the JSON format can be used to import instances of relation/HcsDpSipRoutePatternREL.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/relation/HcsDpSipRoutePatternREL/[pkid]	hierarchy=[hierarchy]	The relation/HcsDpSipRoutePatternREL instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/relation/HcsDpSipRoutePatternREL/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for relation/HcsDpSipRoutePatternREL.

API Reference for relation/HcsDpSipRoutePatternREL

GET http://[host-proxy]/api/relation/HcsDpSipRoutePatternREL/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Export

Export Bulk Load Template

List

GET http://[host]/api/relation/HcsDpSipRoutePatternREL/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Export

Get

Help