[Index]
Model ref.: device/cucm/GatewayEndpointType
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": {
"GatewayEndpointNameFormat": {
"type": "string",
"description": "The format for the name of CUCM Gateway Endpoint Type",
"title": "Gateway Endpoint Name Format"
},
"GatewayEndpointNameExample": {
"type": "string",
"description": "An example of the name of the CUCM Gateway Endpoint Type",
"title": "Gateway Endpoint Name Example"
},
"GatewayEndpointType": {
"type": "string",
"description": "The CUCM Gateway Endpoint Type name",
"title": "Gateway Endpoint Type Name"
},
"ProtocolTemplates": {
"items": {
"type": "object",
"properties": {
"Protocol": {
"title": "Protocol",
"type": "string",
"description": "One of the protocols available for this CUCM gateway endpoint type",
"name": "Protocol"
},
"PBT": {
"items": {
"type": "string"
},
"title": "Available Phone Button Templates",
"type": "array",
"description": "Available phone button templates for this CUCM gateway endpoint type & protocol",
"name": "PBT"
},
"VendorConfig": {
"title": "Vendor Config",
"type": [
"string"
],
"description": "JSON string - Available vendor config for this CUCM gateway endpoint type & protocol",
"name": "VendorConfig"
},
"SecurityProfile": {
"items": {
"type": "string"
},
"title": "Available Phone Security Profiles",
"type": "array",
"description": "Available phone security profiles for this CUCM gateway endpoint type & protocol",
"name": "SecurityProfile"
}
}
},
"type": "array",
"description": "Available options for this CUCM gateway endpoint type",
"title": "Protocol and Templates"
},
"GatewayEndpointNamePrefix": {
"type": "string",
"description": "The prefix for the name of the CUCM Gateway Endpoint Type",
"title": "Gateway Endpoint Name Prefix"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/GatewayEndpointType/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/GatewayEndpointType/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/GatewayEndpointType/[pkid1]", "/api/v0/device/cucm/GatewayEndpointType/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/GatewayEndpointType/?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/GatewayEndpointType |
|
{"hrefs": ["/api/device/cucm/GatewayEndpointType/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/GatewayEndpointType |
|
{"hrefs": ["/api/device/cucm/GatewayEndpointType/[pkid1]", "/api/device/cucm/GatewayEndpointType/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/GatewayEndpointType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/GatewayEndpointType/export/ |
|
{ "hrefs":["/api/device/cucm/GatewayEndpointType/[pkid1]", "/api/device/cucm/GatewayEndpointType/[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/GatewayEndpointType and the JSON format can be used to import instances of device/cucm/GatewayEndpointType.
GET http://[host-proxy]/api/device/cucm/GatewayEndpointType/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/GatewayEndpointType | POST | /api/device/cucm/GatewayEndpointType/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/GatewayEndpointType/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/GatewayEndpointType/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/GatewayEndpointType/ |
|
The device/cucm/GatewayEndpointType schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/GatewayEndpointType instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"export_bulkload_template",
"move",
"list",
"transform",
"export",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "GatewayEndpointType",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/GatewayEndpointType/?skip=0&limit=3&order_by=GatewayEndpointType&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 34
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cucm/GatewayEndpointType/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cucm/GatewayEndpointType",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/GatewayEndpointType/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/device/cucm/GatewayEndpointType/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/GatewayEndpointType/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/GatewayEndpointType/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/GatewayEndpointType/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/GatewayEndpointType/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/GatewayEndpointType/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/GatewayEndpointType",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "GatewayEndpointType",
"title": "Gateway Endpoint Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "63054d1ec46e74b4687bf2d3",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054c77c46e74b4687bd11b",
"href": "/api/v0/data/CallManager/63054c77c46e74b4687bd11b"
}
],
"self": [
{
"pkid": "63054d1ec46e74b4687bf2d3",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/"
}
],
"parent": [
{
"pkid": "63054bfdc46e74b4687bb868",
"href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63054d1ec46e74b4687bf2d3/?model_type=device/cucm/GatewayEndpointType",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/GatewayEndpointType",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054d1ec46e74b4687bf2d3"
],
"summary_attrs": [
{
"name": "GatewayEndpointType",
"title": "Gateway Endpoint Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"GatewayEndpointNameFormat": "([aA][nN])[0-9a-fA-F]{13}",
"hierarchy": "63054bfdc46e74b4687bb868",
"GatewayEndpointNamePrefix": "AN[mac]",
"GatewayEndpointType": "Analog Phone",
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"ProtocolTemplates": [
{
"Protocol": "SCCP",
"PBT": [
"Standard Analog"
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"stcappRegCap\": {\"default\": \"0\", \"type\": [\"string\"], \"choices\": [{\"value\": \"0\", \"title\": \"Gateway Controlled\"}, {\"value\": \"1\", \"title\": \"Modem Relay\"}, {\"value\": \"2\", \"title\": \"Modem Passthrough\"}, {\"value\": \"3\", \"title\": \"Modem Relay and Passthrough\"}, {\"value\": \"4\", \"title\": \"None\"}], \"name\": \"stcappRegCap\", \"description\": \"This controls configuration pushed to the gateway to register latent capabilities with CUCM. <p>\\n The default option of Gateway Controlled allows manual configuration of the options on the gateway, with this setting, commands issued through IOS will not be disturbed. <p>\\n The option of Modem Relay will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-relay.</b><p>\\n The option of Modem Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-passthrough.</b><p>\\n The option of Modem Relay and Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' both </b><p>\\n The option of None will push configuration to the gateway: <b> no stcapp register capability 'voice-port' </b><p>\\n See the IOS documentation for these settings for more information.\\n \", \"title\": \"Latent Capability Registration Setting\"}}}",
"SecurityProfile": [
"Analog Phone - Standard SCCP Non-Secure Profile"
]
}
],
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "63054ff7c46e74b4687cc61f",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054ce5c46e74b4687be61f",
"href": "/api/v0/data/CallManager/63054ce5c46e74b4687be61f"
}
],
"self": [
{
"pkid": "63054ff7c46e74b4687cc61f",
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63054ff7c46e74b4687cc61f/?model_type=device/cucm/GatewayEndpointType",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/GatewayEndpointType/63054ff7c46e74b4687cc61f/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/GatewayEndpointType",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63054ff7c46e74b4687cc61f"
],
"summary_attrs": [
{
"name": "GatewayEndpointType",
"title": "Gateway Endpoint Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"GatewayEndpointNameFormat": "([aA][nN])[0-9a-fA-F]{13}",
"hierarchy": "63054c4fc46e74b4687bc91b",
"GatewayEndpointNamePrefix": "AN[mac]",
"GatewayEndpointType": "Analog Phone",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"ProtocolTemplates": [
{
"Protocol": "SCCP",
"PBT": [
"Standard Analog"
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"stcappRegCap\": {\"default\": \"0\", \"type\": [\"string\"], \"choices\": [{\"value\": \"0\", \"title\": \"Gateway Controlled\"}, {\"value\": \"1\", \"title\": \"Modem Relay\"}, {\"value\": \"2\", \"title\": \"Modem Passthrough\"}, {\"value\": \"3\", \"title\": \"Modem Relay and Passthrough\"}, {\"value\": \"4\", \"title\": \"None\"}], \"name\": \"stcappRegCap\", \"description\": \"This controls configuration pushed to the gateway to register latent capabilities with CUCM. <p>\\n The default option of Gateway Controlled allows manual configuration of the options on the gateway, with this setting, commands issued through IOS will not be disturbed. <p>\\n The option of Modem Relay will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-relay.</b><p>\\n The option of Modem Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-passthrough.</b><p>\\n The option of Modem Relay and Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' both </b><p>\\n The option of None will push configuration to the gateway: <b> no stcapp register capability 'voice-port' </b><p>\\n See the IOS documentation for these settings for more information.\\n \", \"title\": \"Latent Capability Registration Setting\"}}}",
"SecurityProfile": [
"Analog Phone - Standard SCCP Non-Secure Profile"
]
}
],
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "63055079c46e74b4687ce2f8",
"meta": {
"tags": [],
"cached": true,
"title": "Analog Phone",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054d97c46e74b4687c0528",
"href": "/api/v0/data/CallManager/63054d97c46e74b4687c0528"
}
],
"self": [
{
"pkid": "63055079c46e74b4687ce2f8",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/63055079c46e74b4687ce2f8/?model_type=device/cucm/GatewayEndpointType",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/GatewayEndpointType/63055079c46e74b4687ce2f8/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/GatewayEndpointType",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"63055079c46e74b4687ce2f8"
],
"summary_attrs": [
{
"name": "GatewayEndpointType",
"title": "Gateway Endpoint Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"GatewayEndpointNameFormat": "([aA][nN])[0-9a-fA-F]{13}",
"hierarchy": "63054c4fc46e74b4687bc91b",
"GatewayEndpointNamePrefix": "AN[mac]",
"GatewayEndpointType": "Analog Phone",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"ProtocolTemplates": [
{
"Protocol": "SCCP",
"PBT": [
"Standard Analog"
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"stcappRegCap\": {\"default\": \"0\", \"type\": [\"string\"], \"choices\": [{\"value\": \"0\", \"title\": \"Gateway Controlled\"}, {\"value\": \"1\", \"title\": \"Modem Relay\"}, {\"value\": \"2\", \"title\": \"Modem Passthrough\"}, {\"value\": \"3\", \"title\": \"Modem Relay and Passthrough\"}, {\"value\": \"4\", \"title\": \"None\"}], \"name\": \"stcappRegCap\", \"description\": \"This controls configuration pushed to the gateway to register latent capabilities with CUCM. <p>\\n The default option of Gateway Controlled allows manual configuration of the options on the gateway, with this setting, commands issued through IOS will not be disturbed. <p>\\n The option of Modem Relay will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-relay.</b><p>\\n The option of Modem Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-passthrough.</b><p>\\n The option of Modem Relay and Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' both </b><p>\\n The option of None will push configuration to the gateway: <b> no stcapp register capability 'voice-port' </b><p>\\n See the IOS documentation for these settings for more information.\\n \", \"title\": \"Latent Capability Registration Setting\"}}}",
"SecurityProfile": [
"Analog Phone - Standard SCCP Non-Secure Profile"
]
}
],
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "63054d1ec46e74b4687bf2d3",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Analog Phone",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "63054bfdc46e74b4687bb868",
"href": "/api/data/HierarchyNode/63054bfdc46e74b4687bb868"
}
],
"self": [
{
"pkid": "63054d1ec46e74b4687bf2d3",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054c77c46e74b4687bd11b",
"href": "/api/v0/data/CallManager/63054c77c46e74b4687bd11b"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/63054d1ec46e74b4687bf2d3/?hierarchy=[hierarchy]&model_type=device/cucm/GatewayEndpointType",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/GatewayEndpointType/63054d1ec46e74b4687bf2d3/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/GatewayEndpointType",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054d1ec46e74b4687bf2d3"
],
"summary_attrs": [
{
"name": "GatewayEndpointType",
"title": "Gateway Endpoint Type Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"GatewayEndpointNameFormat": "([aA][nN])[0-9a-fA-F]{13}",
"GatewayEndpointType": "Analog Phone",
"ProtocolTemplates": [
{
"PBT": [
"Standard Analog"
],
"VendorConfig": "{\"type\": \"object\", \"properties\": {\"stcappRegCap\": {\"default\": \"0\", \"type\": [\"string\"], \"choices\": [{\"value\": \"0\", \"title\": \"Gateway Controlled\"}, {\"value\": \"1\", \"title\": \"Modem Relay\"}, {\"value\": \"2\", \"title\": \"Modem Passthrough\"}, {\"value\": \"3\", \"title\": \"Modem Relay and Passthrough\"}, {\"value\": \"4\", \"title\": \"None\"}], \"name\": \"stcappRegCap\", \"description\": \"This controls configuration pushed to the gateway to register latent capabilities with CUCM. <p>\\n The default option of Gateway Controlled allows manual configuration of the options on the gateway, with this setting, commands issued through IOS will not be disturbed. <p>\\n The option of Modem Relay will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-relay.</b><p>\\n The option of Modem Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' modem-passthrough.</b><p>\\n The option of Modem Relay and Passthrough will push configuration to the gateway: <b>stcapp register capability 'voice-port' both </b><p>\\n The option of None will push configuration to the gateway: <b> no stcapp register capability 'voice-port' </b><p>\\n See the IOS documentation for these settings for more information.\\n \", \"title\": \"Latent Capability Registration Setting\"}}}",
"Protocol": "SCCP",
"SecurityProfile": [
"Analog Phone - Standard SCCP Non-Secure Profile"
]
}
],
"GatewayEndpointNamePrefix": "AN[mac]"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/GatewayEndpointType. | GET | /api/device/cucm/GatewayEndpointType/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/GatewayEndpointType as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cucm/GatewayEndpointType/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/GatewayEndpointType/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/GatewayEndpointType | 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/GatewayEndpointType; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/GatewayEndpointType/[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/GatewayEndpointType and the JSON format can be used to import instances of device/cucm/GatewayEndpointType.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/GatewayEndpointType/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/GatewayEndpointType instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/GatewayEndpointType/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/GatewayEndpointType. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/GatewayEndpointType/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |