[Index]
ASSOCIATE SIP LOCAL GATEWAY TO SITE Associating a SIP Local gateway to a site hierarchy node will trigger registered IOS Builder events and will trigger registered dial plan schema group custom workflows. Only SIP Local gateways that share a common CUCM cluster as specified in the site NDL and have the same country as the site can be associated with a site hierarchy node. SHARED GATEWAY CAVEATS Sites with the same area code(s) In this scenario there are two possibilities: 1) All sites share the same TDM trunks to the provider -- this is supported with the default IOS Command Builder templates 2) Each site has its own TDM trunk to the provider -- this is not supported with the default IOS Command Builder templates Sites with different area codes In this scenario, it is unlikely the sites will be sharing the same TDM trunks. However even if they do share the same TDM trunks, it is not currently supported without having to manually modify the default IOS Command Builder templates. If the admin does deploy a shared LBO gateway to two or more sites with different area codes using the default IOS Command Builder templates, calls from one of these sites to a number that is in the same area code as another site sharing the same trunk will be treated as a local/subscriber call. A site with its own trunk is also not supported without modifying the default IOS Command Builder templates.
Model ref.: relation/HcsAssociateSipLocalGwToSiteREL
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": {
"sipLocalGwName": {
"is_password": false,
"description": "SIP Local gateway to bind to the current site. The selected SIP Local gateway must be associated with the same CUCM cluster that is referenced in the site NDL and must be targeted for the same country as the site country.",
"format": "uri",
"required": false,
"displayable": false,
"target_attr": "name",
"readonly": false,
"target": "/api/data/HcsSipLocalGwDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"maxLength": 1024,
"title": "SIP Local Gateway",
"type": "string",
"target_model_type": "data/HcsSipLocalGwDAT",
"choices": []
},
"infoMsg": {
"is_password": false,
"description": "This is a purely informative message string used to provide feedback in the CUCDM GUI when associating a SIP Local gateway to a site. When adding an instance through either the bulk loader or REST API, the value for this field does not need to be provided.",
"title": "Info Message",
"default": "{{ fn.localize data.HcsLocalizedStringDat.value | key:lbo_associatetositenotice }}",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"shadow": {
"title": "Shadow",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"maxItems": 1
}
},
"schema_version": "2.4"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/add/ |
|
The GUI Add form of relation/HcsAssociateSipLocalGwToSiteREL 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/HcsAssociateSipLocalGwToSiteREL | 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/HcsAssociateSipLocalGwToSiteREL/ | hierarchy=[hierarchy] | {"hrefs":["/api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid1]", "/api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid2]", ...]} |
GET http://[host-proxy]/api/relation/HcsAssociateSipLocalGwToSiteREL/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/HcsAssociateSipLocalGwToSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/relation/HcsAssociateSipLocalGwToSiteREL/export/ |
|
{ "hrefs":["/api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid1]", "/api/relation/HcsAssociateSipLocalGwToSiteREL/[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/HcsAssociateSipLocalGwToSiteREL and the JSON format can be used to import instances of relation/HcsAssociateSipLocalGwToSiteREL.
GET http://[host-proxy]/api/relation/HcsAssociateSipLocalGwToSiteREL/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/HcsAssociateSipLocalGwToSiteREL | POST | /api/relation/HcsAssociateSipLocalGwToSiteREL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/ |
|
The relation/HcsAssociateSipLocalGwToSiteREL schema and all instances as JSON. |
(The list will return 0 to 3 relation/HcsAssociateSipLocalGwToSiteREL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 1,
"total_limit": null,
"order_by": "sipLocalGwName",
"direction": "asc",
"current": "/api/relation/HcsAssociateSipLocalGwToSiteREL/?skip=0&limit=3&order_by=sipLocalGwName&direction=asc&traversal=down"
},
"operations": [
"get",
"configuration_template",
"update",
"export_bulkload_template",
"list",
"bulk_update",
"field_display_policy",
"remove",
"help",
"add",
"export"
],
"meta": {
"model_type": "relation/HcsAssociateSipLocalGwToSiteREL",
"summary_attrs": [
{
"name": "sipLocalGwName",
"title": "SIP Local Gateway"
},
{
"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/HcsAssociateSipLocalGwToSiteREL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"get",
"export",
"update",
"list",
"export_bulkload_template",
"help",
"add",
"remove"
],
"schema_version": "2.4",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/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/HcsAssociateSipLocalGwToSiteREL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"sipLocalGwName": "SKIGW0011223344",
"pkid": "651e6bbb111e6332e60ba7ab",
"hierarchy_friendly_name": "AAA-Boston (Site)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston"
},
"meta": {
"model_type": "relation/HcsAssociateSipLocalGwToSiteREL",
"summary_attrs": [
{
"name": "sipLocalGwName",
"title": "SIP Local Gateway"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {
"hierarchy": true,
"unique": [
"sipLocalGwName"
]
},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5a86743967ea6f2039933bc1",
"href": "/api/data/HierarchyNode/5a86743967ea6f2039933bc1"
}
],
"foreign_key": [
{
"pkid": "651e6bb51d6a7fef274a1281",
"path": "sipLocalGwName",
"model_type": "data/HcsSipLocalGwDAT"
}
],
"self": [
{
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/",
"pkid": "651e6bba111e6332e60ba7a9"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"5a866fd11360b6206c488deb",
"5a86702067ea6f203993285d",
"5a8673030085ec1f7f30e906",
"5a86743967ea6f2039933bc1",
"651e6bba111e6332e60ba7a9"
],
"schema_version": "2.1",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/help",
"support_async": false,
"title": "Help"
}
},
{
"Regenerate_IOS_Commands": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/+Regenerate_IOS_Commands/",
"support_async": true,
"title": "Regenerate Ios Commands"
}
}
],
"summary": "false"
},
"pkid": "651e6bba111e6332e60ba7a9"
}
]
}
(Show the first instance)
{
"data": {
"sipLocalGwName": "SKIGW0011223344",
"shadow": []
},
"meta": {
"model_type": "relation/HcsAssociateSipLocalGwToSiteREL",
"summary_attrs": [
{
"name": "sipLocalGwName",
"title": "SIP Local Gateway"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "SKIGW0011223344",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"children": [],
"parent": [
{
"pkid": "5a86743967ea6f2039933bc1",
"href": "/api/data/HierarchyNode/5a86743967ea6f2039933bc1"
}
],
"self": [
{
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/",
"pkid": "651e6bba111e6332e60ba7a9"
}
]
},
"schema_version": "2.4",
"actions": [
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"Regenerate_IOS_Commands": {
"method": "POST",
"class": "custom",
"href": "/api/relation/HcsAssociateSipLocalGwToSiteREL/651e6bba111e6332e60ba7a9/+Regenerate_IOS_Commands/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Regenerate Ios Commands"
}
}
]
},
"pkid": "651e6bba111e6332e60ba7a9"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for relation/HcsAssociateSipLocalGwToSiteREL. | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/help | hierarchy=[hierarchy] | On-line help of Model ref.: relation/HcsAssociateSipLocalGwToSiteREL as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of relation/HcsAssociateSipLocalGwToSiteREL; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/[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/HcsAssociateSipLocalGwToSiteREL and the JSON format can be used to import instances of relation/HcsAssociateSipLocalGwToSiteREL.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid] | hierarchy=[hierarchy] | The relation/HcsAssociateSipLocalGwToSiteREL instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for relation/HcsAssociateSipLocalGwToSiteREL. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Regenerate Ios Commands | POST | /api/relation/HcsAssociateSipLocalGwToSiteREL/[pkid]/+Regenerate_IOS_Commands | hierarchy=[hierarchy] | If payload required: |