[Index]
Model ref.: device/cucm/GatewayType
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": {
"GatewayNameExample": {
"type": "string",
"description": "An example of the name of the CUCM Gateway Type",
"title": "Gateway Name Example"
},
"GatewayNamePrefix": {
"type": "string",
"description": "The prefix for the name of the CUCM Gateway Type",
"title": "Gateway Name Prefix"
},
"GatewayNameFormat": {
"type": "string",
"description": "The format for the name of CUCM Gateway Type",
"title": "Gateway Name Format"
},
"ProtocolTemplates": {
"items": {
"type": "object",
"properties": {
"Layout": {
"items": {
"type": "object",
"properties": {
"AllowedUnits": {
"items": {
"type": "object",
"properties": {
"AllowedSubunits": {
"items": {
"type": "object",
"properties": {
"AllowedEndpoints": {
"items": {
"type": "object",
"properties": {
"EndpointName": {
"type": "string",
"name": "EndpointName",
"title": "Endpoint Name"
},
"StartPort": {
"type": "integer",
"name": "StartPort",
"title": "Starting Port"
}
}
},
"type": "array",
"name": "AllowedEndpoints",
"title": "Allowed Endpoints"
},
"SubunitName": {
"type": "string",
"name": "SubunitName",
"title": "Subunit Name"
},
"NumAllowedPorts": {
"type": "integer",
"name": "NumAllowedPorts",
"title": "Number of Allowed Ports"
}
}
},
"type": "array",
"name": "AllowedSubunits",
"title": "Allowed Subunits"
},
"NumAllowedSubunits": {
"type": "integer",
"name": "NumAllowedSubunits",
"title": "Number of Allowed Subunits"
},
"UnitName": {
"type": "string",
"name": "UnitName",
"title": "Unit Name"
}
}
},
"type": "array",
"name": "AllowedUnits",
"title": "Allowed Units"
},
"UnitPosition": {
"type": "integer",
"description": "Position of unit on this CUCM gateway type & protocol",
"name": "UnitPosition",
"title": "Unit Position"
}
}
},
"type": "array",
"name": "Layout",
"title": "Gateway Layout"
},
"VendorConfig": {
"type": [
"string"
],
"description": "JSON string - Available vendor config for this CUCM gateway type & protocol",
"name": "VendorConfig",
"title": "Vendor Config"
},
"Protocol": {
"type": "string",
"description": "One of the protocols available for this CUCM gateway type",
"name": "Protocol",
"title": "Protocol"
}
}
},
"type": "array",
"description": "Available options for this CUCM gateway type",
"title": "Protocol and Templates"
},
"GatewayType": {
"type": "string",
"description": "The CUCM Gateway Type name",
"title": "Gateway Type Name"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/GatewayType/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/GatewayType/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/GatewayType/[pkid1]", "/api/v0/device/cucm/GatewayType/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/GatewayType/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/GatewayType |
|
{"hrefs": ["/api/device/cucm/GatewayType/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/GatewayType |
|
{"hrefs": ["/api/device/cucm/GatewayType/[pkid1]", "/api/device/cucm/GatewayType/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/GatewayType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/GatewayType/export/ |
|
{ "hrefs":["/api/device/cucm/GatewayType/[pkid1]", "/api/device/cucm/GatewayType/[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 device/cucm/GatewayType and the JSON format can be used to import instances of device/cucm/GatewayType.
GET http://[host-proxy]/api/device/cucm/GatewayType/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/GatewayType | POST | /api/device/cucm/GatewayType/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/device/cucm/GatewayType/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/GatewayType/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/GatewayType/ |
|
The device/cucm/GatewayType schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/GatewayType instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 110,
"total_limit": null,
"order_by": "GatewayType",
"direction": "asc",
"current": "/api/device/cucm/GatewayType/?skip=0&limit=3&order_by=GatewayType&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"configuration_template",
"list",
"export",
"bulk_update_form",
"transform",
"export_bulkload_template",
"move"
],
"meta": {
"model_type": "device/cucm/GatewayType",
"summary_attrs": [
{
"name": "GatewayType",
"title": "Gateway Type Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"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": []
},
"model_specific_actions": [
"field_display_policy",
"help",
"configuration_template",
"list",
"export",
"get",
"bulk_update_form",
"clone",
"export_bulkload_template",
"move"
],
"schema_version": "14.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cucm/GatewayType/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/GatewayType",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cucm/GatewayType/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/device/cucm/GatewayType/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cucm/GatewayType/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cucm/GatewayType/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cucm/GatewayType/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/GatewayType/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/GatewayType/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"GatewayNameExample": "",
"ProtocolTemplates": [
{
"Protocol": "MGCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXO Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-1FXO",
"NumAllowedPorts": 1
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP BRI Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXS Port",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID",
"NumAllowedPorts": 4
},
{
"AllowedEndpoints": [
{
"EndpointName": "Pilot",
"StartPort": 0
}
],
"SubunitName": "VIC_NONE",
"NumAllowedPorts": 0
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
},
{
"Protocol": "SCCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "ISDN BRI Phone",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI-NT/TE-SCCP",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Analog Phone",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID-SCCP",
"NumAllowedPorts": 4
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
}
],
"GatewayType": "C881V",
"GatewayNameFormat": "^.+$",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/GatewayType",
"summary_attrs": [
{
"name": "GatewayType",
"title": "Gateway Type Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "C881V",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/",
"pkid": "5ae8a029affa931cce390b66"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a029affa931cce390b66"
],
"schema_version": "10.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a029affa931cce390b66/?model_type=device/cucm/GatewayType",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a029affa931cce390b66"
},
{
"data": {
"GatewayNameExample": "",
"GatewayNameFormat": "^.+$",
"ProtocolTemplates": [
{
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "ISDN BRI Phone",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI-NT/TE-SCCP",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Analog Phone",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID-SCCP",
"NumAllowedPorts": 4
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"default\": \"4ESS\", \"type\": [\"null\", \"string\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"default\": \"Graceful\", \"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"default\": 10, \"minimum\": 1, \"type\": [\"integer\", \"null\"], \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"type\": [\"null\", \"string\"], \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"default\": \"Enable\", \"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"default\": \"NoChange\", \"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Protocol": "SCCP"
},
{
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXO Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-1FXO",
"NumAllowedPorts": 1
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP BRI Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXS Port",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID",
"NumAllowedPorts": 4
},
{
"AllowedEndpoints": [
{
"EndpointName": "Pilot",
"StartPort": 0
}
],
"SubunitName": "VIC_NONE",
"NumAllowedPorts": 0
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"default\": \"4ESS\", \"type\": [\"null\", \"string\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"default\": \"Graceful\", \"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"default\": 10, \"minimum\": 1, \"type\": [\"integer\", \"null\"], \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"type\": [\"null\", \"string\"], \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"default\": \"Enable\", \"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"default\": \"NoChange\", \"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Protocol": "MGCP"
}
],
"GatewayType": "C881V",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/GatewayType",
"summary_attrs": [
{
"name": "GatewayType",
"title": "Gateway Type Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "C881V",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5ae89edaaffa931cce38c13d",
"pkid": "5ae89edaaffa931cce38c13d"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/",
"pkid": "5ae8a03eaffa931cce390ede"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a03eaffa931cce390ede"
],
"schema_version": "11.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a03eaffa931cce390ede/?model_type=device/cucm/GatewayType",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/GatewayType/5ae8a03eaffa931cce390ede/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a03eaffa931cce390ede"
},
{
"data": {
"GatewayNameExample": "",
"ProtocolTemplates": [
{
"Protocol": "MGCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP BRI Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXS Port",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID",
"NumAllowedPorts": 4
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
},
{
"Protocol": "SCCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "ISDN BRI Phone",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI-NT/TE-SCCP",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Analog Phone",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID-SCCP",
"NumAllowedPorts": 4
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
}
],
"GatewayType": "C887VA-V",
"GatewayNameFormat": "^.+$",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cucm/GatewayType",
"summary_attrs": [
{
"name": "GatewayType",
"title": "Gateway Type Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "C887VA-V",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/",
"pkid": "5ae8a05aaffa931cce391279"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a05aaffa931cce391279"
],
"schema_version": "10.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a05aaffa931cce391279/?model_type=device/cucm/GatewayType",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/GatewayType/5ae8a05aaffa931cce391279/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a05aaffa931cce391279"
}
]
}
(Show the first instance)
{
"data": {
"GatewayNameExample": "",
"ProtocolTemplates": [
{
"Protocol": "MGCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXO Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-1FXO",
"NumAllowedPorts": 1
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP BRI Port",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Cisco MGCP FXS Port",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID",
"NumAllowedPorts": 4
},
{
"AllowedEndpoints": [
{
"EndpointName": "Pilot",
"StartPort": 0
}
],
"SubunitName": "VIC_NONE",
"NumAllowedPorts": 0
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
},
{
"Protocol": "SCCP",
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"globalISDNSwitchType\": {\"type\": [\"string\", \"null\"], \"choices\": [{\"value\": \"4ESS\", \"title\": \"4ESS\"}, {\"value\": \"5E8\", \"title\": \"5E8\"}, {\"value\": \"5E8 TELEOS\", \"title\": \"5E8 TELEOS\"}, {\"value\": \"5E8 INTECOME\", \"title\": \"5E8 INTECOME\"}, {\"value\": \"5E9\", \"title\": \"5E9\"}, {\"value\": \"DMS-100\", \"title\": \"DMS-100\"}, {\"value\": \"DMS-250\", \"title\": \"DMS-250\"}, {\"value\": \"NI2\", \"title\": \"NI2\"}, {\"value\": \"5E8 CUSTOM\", \"title\": \"5E8 CUSTOM\"}, {\"value\": \"ETSI SC\", \"title\": \"ETSI SC\"}, {\"value\": \"EURO\", \"title\": \"EURO\"}, {\"value\": \"AUSTRALIAN\", \"title\": \"AUSTRALIAN\"}, {\"value\": \"QSIG\", \"title\": \"primary-qsig\"}], \"default\": \"4ESS\", \"name\": \"globalISDNSwitchType\", \"description\": \"Global ISDN Switch Type that all IOS routers have. T1 Switch types supported are DMS-100, DMS-250, NI2, 4ESS, 5E8/5E9 and ETSI/SC.\\nE1 Switch Types supported are \\nEURO and AUSTRALIAN\\n\", \"title\": \"Global ISDN Switch Type\"}, \"switchBack\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Immediate\", \"title\": \"Immediate\"}, {\"value\": \"Delayed\", \"title\": \"Delayed\"}, {\"value\": \"Graceful\", \"title\": \"Graceful\"}, {\"value\": \"Scheduled\", \"title\": \"Scheduled\"}, {\"value\": \"Never\", \"title\": \"Never\"}], \"default\": \"Graceful\", \"name\": \"switchBack\", \"description\": \"Timing mechanism to use to switch back to a primary CallManager.\", \"title\": \"Switchback Timing\"}, \"switchBackDelay\": {\"type\": [\"null\", \"integer\"], \"default\": 10, \"minimum\": 1, \"maximum\": 1440, \"name\": \"switchBackDelay\", \"description\": \"This is the delay in minutes when using delayed switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback uptime-delay (min)\"}, \"switchBackSchedule\": {\"type\": [\"string\", \"null\"], \"default\": \"12:00\", \"pattern\": \"(([0-1][0-9])|(2[0-3])):[0-5][0-9]\", \"name\": \"switchBackSchedule\", \"description\": \"This is the schedule in hours and minutes when using scheduled switchback. Required only if SwitchBack Timing is Delayed\", \"title\": \"Switchback schedule (hh:mm)\"}, \"ModemPassthrough\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"Disable\", \"title\": \"Disable\"}, {\"value\": \"Enable\", \"title\": \"Enable\"}], \"default\": \"Enable\", \"name\": \"ModemPassthrough\", \"description\": \"Use this parameter to enable and disable the modem passthrough\", \"title\": \"Modem Passthrough\"}, \"DtmfRelay\": {\"type\": [\"string\"], \"choices\": [{\"value\": \"OutOfBand\", \"title\": \"Out of Band\"}, {\"value\": \"Cisco\", \"title\": \"Cisco\"}, {\"value\": \"NSE\", \"title\": \"NSE\"}, {\"value\": \"NTE-CA\", \"title\": \"NTE-CA\"}, {\"value\": \"NTE-GW\", \"title\": \"NTE-GW\"}, {\"value\": \"NoChange\", \"title\": \"Current GW Config\"}], \"default\": \"NoChange\", \"name\": \"DtmfRelay\", \"description\": \"This is to select dtmf relay type to be used on the gateway\", \"title\": \"Type Of DTMF Relay\"}}}",
"Layout": [
{
"AllowedUnits": [
{
"AllowedSubunits": [
{
"AllowedEndpoints": [
{
"EndpointName": "ISDN BRI Phone",
"StartPort": 0
}
],
"SubunitName": "VIC2-2BRI-NT/TE-SCCP",
"NumAllowedPorts": 2
},
{
"AllowedEndpoints": [
{
"EndpointName": "Analog Phone",
"StartPort": 0
}
],
"SubunitName": "VIC3-4FXS/DID-SCCP",
"NumAllowedPorts": 4
}
],
"NumAllowedSubunits": 4,
"UnitName": "NM-4VWIC-MBRD"
}
],
"UnitPosition": 0
}
]
}
],
"GatewayType": "C881V",
"GatewayNameFormat": "^.+$"
},
"meta": {
"model_type": "device/cucm/GatewayType",
"summary_attrs": [
{
"name": "GatewayType",
"title": "Gateway Type Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "C881V",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/CallManager/5ae89eccaffa931cce38bd4d",
"pkid": "5ae89eccaffa931cce38bd4d"
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/",
"pkid": "5ae8a029affa931cce390b66"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a029affa931cce390b66"
],
"schema_version": "10.5",
"actions": [
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a029affa931cce390b66/?hierarchy=[hierarchy]&model_type=device/cucm/GatewayType",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/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/device/cucm/GatewayType/5ae8a029affa931cce390b66/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cucm/GatewayType/5ae8a029affa931cce390b66/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8a029affa931cce390b66"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/GatewayType. | GET | /api/device/cucm/GatewayType/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/GatewayType as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/GatewayType/purge/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/GatewayType/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/GatewayType/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/GatewayType | 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 device/cucm/GatewayType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/GatewayType/[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 device/cucm/GatewayType and the JSON format can be used to import instances of device/cucm/GatewayType.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/GatewayType/[pkid] | hierarchy=[hierarchy] | The device/cucm/GatewayType instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/GatewayType/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/GatewayType. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/GatewayType/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |