[Index]
HcsSipLocalGwDAT
Model ref.: data/HcsSipLocalGwDAT
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": {
"iosDevice": {
"is_password": false,
"description": "IOS Device the gateway runs on",
"format": "uri",
"title": "IOS Device",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsIOSDeviceDAT",
"type": "string",
"target": "/api/data/HcsIOSDeviceDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"dialPeerInfo": {
"is_password": false,
"description": "Dial peer info used for gateway configuration. If Run on Every Node is not enabled, then the Call Manager Group members are displayed in priority order. If Run on Every Node is enabled, then all CUCM nodes are displayed, but without priority",
"title": "Dial Peer Info",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"description": "The name of the SIP local gateway",
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"country": {
"is_password": false,
"description": "Country where the gateway is",
"format": "uri",
"title": "Country",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "country_name",
"readonly": false,
"maxLength": 256,
"target_model_type": "data/Countries",
"type": "string",
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"sipTrunkName": {
"is_password": false,
"description": "Sip Trunk destined to the gateway",
"title": "Sip Trunk",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"enableCommandBuilder": {
"is_password": false,
"description": "Whether or not to generate IOS commands for the gateway",
"title": "Enable Command Builder",
"default": "true",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"runOnEveryNode": {
"is_password": false,
"description": "Indicate whether call processing is distributed across all CUCM nodes",
"title": "Run On Every Node",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"overrideVTGWLimit": {
"default": "false",
"type": "boolean",
"description": "Override Voice Translation Limit if E164 associations exceed 80",
"title": "Override Voice Translation Limit - ** Warning may invalidate Command Builder Configuration **"
},
"gatewayAddressIpv4": {
"is_password": false,
"description": "IP address of the gateway",
"title": "Gateway Address",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"gatewayPort": {
"is_password": false,
"description": "Port of the gateway",
"title": "Gateway Port",
"required": false,
"displayable": false,
"readonly": false,
"type": "integer"
},
"cucmPublisher": {
"is_password": false,
"description": "Select CUCM from the customer's NDLs",
"format": "uri",
"title": "CUCM Publisher",
"required": true,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/CallManager",
"type": "string",
"target": "/api/data/CallManager/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"description": {
"is_password": false,
"description": "Description for the SIP local gateway",
"title": "Description",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
},
"schema_version": "2.6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsSipLocalGwDAT/add/ |
|
The GUI Add form of data/HcsSipLocalGwDAT 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/HcsSipLocalGwDAT/ | 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/HcsSipLocalGwDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsSipLocalGwDAT/[pkid1]", "/api/data/HcsSipLocalGwDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsSipLocalGwDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsSipLocalGwDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsSipLocalGwDAT/export/ |
|
{ "hrefs":["/api/data/HcsSipLocalGwDAT/[pkid1]", "/api/data/HcsSipLocalGwDAT/[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/HcsSipLocalGwDAT and the JSON format can be used to import instances of data/HcsSipLocalGwDAT.
GET http://[host-proxy]/api/data/HcsSipLocalGwDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsSipLocalGwDAT | POST | /api/data/HcsSipLocalGwDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsSipLocalGwDAT/ |
|
The data/HcsSipLocalGwDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsSipLocalGwDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsSipLocalGwDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.6",
"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/HcsSipLocalGwDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsSipLocalGwDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsSipLocalGwDAT/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/HcsSipLocalGwDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsSipLocalGwDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsSipLocalGwDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsSipLocalGwDAT",
"model_specific_actions": [
"add",
"list",
"get",
"update",
"remove",
"import",
"help",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "iosDevice",
"title": "IOS Device"
},
{
"name": "gatewayAddressIpv4",
"title": "Gateway Address"
},
{
"name": "enableCommandBuilder",
"title": "Enable Command Builder"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsSipLocalGwDAT. | GET | /api/data/HcsSipLocalGwDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsSipLocalGwDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsSipLocalGwDAT/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsSipLocalGwDAT/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsSipLocalGwDAT/[pkid]/import/ | 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 data/HcsSipLocalGwDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsSipLocalGwDAT/[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/HcsSipLocalGwDAT and the JSON format can be used to import instances of data/HcsSipLocalGwDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsSipLocalGwDAT/[pkid]/ | hierarchy=[hierarchy] | The data/HcsSipLocalGwDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsSipLocalGwDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsSipLocalGwDAT. |