[Index]
Dial Plan SIP Trunk
Model ref.: data/DP_SIPTrunk
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": { "mrgl": { "type": "string", "description": "Media Resource Group List", "title": "Media Resource Group List" }, "callClass": { "default": "OffNet", "choices": [ { "value": "OnNet", "title": "OnNet" }, { "value": "OffNet", "title": "OffNet" } ], "type": "string", "description": "Call Classification", "title": "Call Classification" }, "dpName": { "type": "string", "description": "Dial Plan Name", "title": "Dial Plan Name" }, "sipNormScript": { "type": "string", "description": "SIP Normalization Script", "title": "SIP Normalization Script" }, "name": { "type": "string", "description": "SIP Trunk Name", "title": "SIP Trunk Name" }, "redirectDivHeadDel-Out": { "default": "false", "title": "Redirecting Diversion Header Delivery - Outbound", "type": "boolean", "choices": [ { "value": "true", "title": "True" }, { "value": "false", "title": "False" } ] }, "stsp": { "default": "Non Secure SIP Trunk Profile", "type": "string", "description": "SIP Trunk Security Profile", "title": "SIP Trunk Security Profile" }, "redirectDivHeadDel-In": { "default": "false", "title": "Redirecting Diversion Header Delivery - Inbound", "type": "boolean", "choices": [ { "value": "true", "title": "True" }, { "value": "false", "title": "False" } ] }, "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" }, "devicePool": { "items": { "type": "object", "attr_props": [ { "title": "Member", "type": "string", "description": "Member", "name": "member" }, { "title": "Member Selective Order", "type": "number", "description": "Member Selective Order", "name": "memberOrder" } ] }, "type": "string", "description": "Device Pool", "title": "Device Pool" }, "cgpnTransformationCssName": { "type": "string", "title": "Calling Party Transformation CSS" }, "location": { "type": "string", "description": "Location", "title": "Location" }, "sipArray": { "items": { "type": "object", "properties": { "destinationV6": { "type": "string", "description": "Destination Address IPv6", "title": "Destination Address IPv6" }, "destination": { "type": "string", "description": "Destination Address", "title": "Destination Address" }, "destSRV": { "type": "boolean", "description": "Destination Address is an SRV", "title": "Destination Address is an SRV" }, "port": { "type": "string", "description": "Destination Port", "title": "Destination Port" } } }, "type": "array", "description": "SIP Information", "title": "SIP Information" }, "cdpnTransformationCssName": { "type": "string", "title": "Called Party Transformation CSS" }, "sipProf": { "default": "Standard SIP Profile", "type": "string", "description": "SIP Profile", "title": "SIP Profile" }, "dtmfSignalingMethod": { "default": "No Preference", "title": "dtmfSignalingMethod", "type": "string", "choices": [ { "value": "No Preference", "title": "No Preference" }, { "value": "Out of Band", "title": "Out of Band" }, { "value": "RFC 2833", "title": "RFC 2833" }, { "value": "OOB and RFC 2833", "title": "OOB and RFC 2833" } ] }, "callingAndCalledPartyInfoFormat": { "default": "Deliver URI and DN in connected party, if available", "title": "callingAndCalledPartyInfoFormat", "type": "string", "choices": [ { "value": "Deliver DN only in connected party", "title": "Deliver DN only in connected party" }, { "value": "Deliver URI only in connected party, if available", "title": "Deliver URI only in connected party, if available" }, { "value": "Deliver URI and DN in connected party, if available", "title": "Deliver URI and DN in connected party, if available" } ] }, "desc": { "type": "string", "description": "Description", "title": "Description" } }, "schema_version": "0.1" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/DP_SIPTrunk/add/ |
|
The GUI Add form of data/DP_SIPTrunk 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/data/DP_SIPTrunk/ | 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/data/DP_SIPTrunk/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/DP_SIPTrunk/[pkid1]", "/api/data/DP_SIPTrunk/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/DP_SIPTrunk/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/DP_SIPTrunk; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/DP_SIPTrunk/export/ |
|
{ "hrefs":["/api/data/DP_SIPTrunk/[pkid1]", "/api/data/DP_SIPTrunk/[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 data/DP_SIPTrunk and the JSON format can be used to import instances of data/DP_SIPTrunk.
GET http://[host-proxy]/api/data/DP_SIPTrunk/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/DP_SIPTrunk | POST | /api/data/DP_SIPTrunk/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/DP_SIPTrunk/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/DP_SIPTrunk/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/DP_SIPTrunk/ |
|
The data/DP_SIPTrunk schema and all instances as JSON. |
(The list will return 0 to 3 data/DP_SIPTrunk instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "dpName", "maximum_limit": 2000, "skip": 0, "current": "/api/data/DP_SIPTrunk/?skip=0&limit=3&order_by=dpName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 3 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.1", "references": { "device": [ { "pkid": "", "href": "" } ], "children": [], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [] }, "actions": [ { "add": { "support_async": false, "class": "add", "href": "/api/data/DP_SIPTrunk/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DP_SIPTrunk/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_SIPTrunk/export/?hierarchy=[hierarchy]", "method": "POST", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "export_bulkload_template": { "support_async": false, "class": "bulkload_template", "href": "/api/data/DP_SIPTrunk/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_SIPTrunk/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/DP_SIPTrunk/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/DP_SIPTrunk/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/DP_SIPTrunk/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DP_SIPTrunk/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/DP_SIPTrunk", "model_specific_actions": [ "add", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "remove", "tag", "update" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "SIP Trunk Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "resources": [ { "pkid": "5dcecc499d77dd0018b5efb6", "meta": { "tags": [], "cached": true, "title": "CS-P-Global-DP - SIP_TRK_IMP_{{ macro.DP_CustomerName }}", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcecc499d77dd0018b5efb6", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/" } ], "parent": [ { "pkid": "5dcd17c256b5de00189138f9", "href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/help", "method": "GET", "title": "Help" } } ], "model_type": "data/DP_SIPTrunk", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcecc499d77dd0018b5efb6" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "SIP Trunk Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "callClass": "OffNet", "dpName": "CS-P-Global-DP", "name": "SIP_TRK_IMP_{{ macro.DP_CustomerName }}", "stsp": "Non Secure SIP Trunk Profile", "runOnAllNodes": true, "pkid": "5dcecc499d77dd0018b5efb7", "devicePool": "Default", "location": "Hub_None", "sipArray": [ { "destination": "{{ macro.DP_Global_PrimarySIPAddr }}" }, { "destination": "{{ macro.DP_Global_SecondarySIPAddr }}", "port": "5060" } ], "sipProf": "Standard SIP Profile", "desc": "SIP Trunk IMP {{ macro.DP_CustomerName }}", "hierarchy_friendly_name": "CS-P (Provider)", "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "5dcecc384544b70019de0aa9", "meta": { "tags": [], "cached": true, "title": "GeoLogic-GYE-DP - SIP_TRK_{{ macro.SITENAME }}", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcecc384544b70019de0aa9", "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/" } ], "parent": [ { "pkid": "5dcd17c256b5de00189138f9", "href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/DP_SIPTrunk/5dcecc384544b70019de0aa9/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/DP_SIPTrunk", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcecc384544b70019de0aa9" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "SIP Trunk Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "mrgl": "MRGL_{{ macro.DP_CustomerName }}", "callClass": "OffNet", "dpName": "GeoLogic-GYE-DP", "name": "SIP_TRK_{{ macro.SITENAME }}", "stsp": "Non Secure SIP Trunk Profile", "runOnAllNodes": true, "pkid": "5dcecc384544b70019de0aaa", "devicePool": "DP_{{ macro.SITENAME }}", "location": "Hub_None", "sipArray": [ { "destination": "{{ macro.DP_Site_PrimarySIPAddr }}", "port": "{{ macro.DP_Site_PrimarySIPPort }}" }, { "destination": "{{ macro.DP_Site_SecondarySIPAddr }}", "port": "{{ macro.DP_Site_SecondarySIPPort }}" } ], "sipProf": "Standard SIP Profile", "desc": "{{ macro.SITENAME }} SIP Trunk", "hierarchy_friendly_name": "CS-P (Provider)", "hierarchy_path": "sys.hcs.CS-P" } }, { "pkid": "5dcecc3856b5de00207dafc2", "meta": { "tags": [], "cached": true, "title": "GeoLogic-UIO-DP - SIP_TRK_{{ macro.SITENAME }}", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.1", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5dcecc3856b5de00207dafc2", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/" } ], "parent": [ { "pkid": "5dcd17c256b5de00189138f9", "href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/+tag/", "class": "tag", "view": "/api/view/TagNameForm/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/DP_SIPTrunk/5dcecc3856b5de00207dafc2/help", "class": "help", "title": "Help" } } ], "model_type": "data/DP_SIPTrunk", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcecc3856b5de00207dafc2" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "SIP Trunk Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "mrgl": "MRGL_{{ macro.DP_CustomerName }}", "callClass": "OffNet", "dpName": "GeoLogic-UIO-DP", "name": "SIP_TRK_{{ macro.SITENAME }}", "stsp": "Non Secure SIP Trunk Profile", "runOnAllNodes": true, "pkid": "5dcecc3856b5de00207dafc3", "devicePool": "DP_{{ macro.SITENAME }}", "location": "Hub_None", "sipArray": [ { "destination": "{{ macro.DP_Site_PrimarySIPAddr }}", "port": "{{ macro.DP_Site_PrimarySIPPort }}" }, { "destination": "{{ macro.DP_Site_SecondarySIPAddr }}", "port": "{{ macro.DP_Site_SecondarySIPPort }}" } ], "sipProf": "Standard SIP Profile", "desc": "{{ macro.SITENAME }} SIP Trunk", "hierarchy_friendly_name": "CS-P (Provider)", "hierarchy_path": "sys.hcs.CS-P" } } ] }
(Show the first instance)
{ "pkid": "5dcecc499d77dd0018b5efb6", "meta": { "tags": [], "cached": false, "title": "CS-P-Global-DP - SIP_TRK_IMP_{{ macro.DP_CustomerName }}", "business_key": { "hierarchy": true, "unique": [ "dpName", "name" ] }, "schema_version": "0.1", "references": { "parent": [ { "pkid": "5dcd17c256b5de00189138f9", "href": "/api/data/HierarchyNode/5dcd17c256b5de00189138f9" } ], "self": [ { "pkid": "5dcecc499d77dd0018b5efb6", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "tag": { "title": "Tag", "support_async": true, "method": "PATCH", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/+tag/?hierarchy=[hierarchy]", "class": "tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/DP_SIPTrunk/5dcecc499d77dd0018b5efb6/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/DP_SIPTrunk", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcecc499d77dd0018b5efb6" ], "summary_attrs": [ { "name": "dpName", "title": "Dial Plan Name" }, { "name": "name", "title": "SIP Trunk Name" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "callClass": "OffNet", "dpName": "CS-P-Global-DP", "name": "SIP_TRK_IMP_{{ macro.DP_CustomerName }}", "stsp": "Non Secure SIP Trunk Profile", "runOnAllNodes": true, "pkid": "5dcecc499d77dd0018b5efb7", "devicePool": "Default", "location": "Hub_None", "sipArray": [ { "destination": "{{ macro.DP_Global_PrimarySIPAddr }}" }, { "destination": "{{ macro.DP_Global_SecondarySIPAddr }}", "port": "5060" } ], "sipProf": "Standard SIP Profile", "desc": "SIP Trunk IMP {{ macro.DP_CustomerName }}" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/DP_SIPTrunk. | GET | /api/data/DP_SIPTrunk/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/DP_SIPTrunk as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/DP_SIPTrunk/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/DP_SIPTrunk/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/DP_SIPTrunk/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/DP_SIPTrunk/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/DP_SIPTrunk; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/DP_SIPTrunk/[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 data/DP_SIPTrunk and the JSON format can be used to import instances of data/DP_SIPTrunk.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/DP_SIPTrunk/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/DP_SIPTrunk/[pkid]/ | hierarchy=[hierarchy] | The data/DP_SIPTrunk instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/DP_SIPTrunk/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/DP_SIPTrunk. |