[Index]
Model ref.: device/cuc/Port
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": { "TelephonyIntegrationMethodEnum": { "description": " The method used to integrate with the switch.", "title": "Telephony Integration Method", "minItems": 0, "choices": [ [ 3, "PIMG" ], [ 2, "SIP" ], [ 1, "Skinny" ] ], "readonly": true, "type": "integer", "name": "TelephonyIntegrationMethodEnum" }, "VmsServerName": { "minItems": 0, "type": "string", "description": " The name of the server.", "name": "VmsServerName", "title": "Vms Server Name" }, "SipSendPort": { "minItems": 0, "type": "integer", "description": "UDP port for outgoing SIP messages. UDP port for outgoing SIP messages.", "name": "SipSendPort", "title": "Sip Send Port" }, "MediaPortGroupDisplayName": { "minItems": 0, "type": "string", "description": "The name of the parent MediaPortGroup.", "name": "MediaPortGroupDisplayName", "title": "Media Port Group Display Name" }, "PortNumInGroup": { "minItems": 0, "type": "integer", "description": " The port number of this line as assigned by Cisco Unity Connection. ", "name": "PortNumInGroup", "title": "Port Num In Group" }, "CapNotification": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is capable of performing the function of notifying subscribers of messages.", "name": "CapNotification", "title": "Cap Notification" }, "DisplayName": { "minItems": 0, "type": "string", "description": "The name of media port. ", "name": "DisplayName", "title": "Display Name" }, "CapAnswer": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is capable of answering calls.", "name": "CapAnswer", "title": "Cap Answer" }, "NumberOfPorts": { "type": "integer", "description": "The URI to get the number of ports.", "name": "NumberOfPorts", "title": "Number Of Ports" }, "Extension": { "minItems": 0, "type": "string", "description": " The dialable number (extension) of this line/port.", "name": "Extension", "title": "Extension" }, "CapTrapConnection": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is capable of performing the function of enabling subscribers to use the phone as a recording and playback device in Cisco Unity Connection web applications and e-mail clients.", "name": "CapTrapConnection", "title": "Cap Trap Connection" }, "SkinnySecurityModeEnum": { "description": " The security mode used for Skinny protocol sessions.", "title": "Skinny State Machine", "minItems": 0, "choices": [ [ 1, "Authenticated" ], [ 2, "Encrypted" ], [ 0, "Insecure" ] ], "type": "integer", "name": "SkinnySecurityModeEnum" }, "CapMWI": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is capable of performing the function of turning MWIs on and off.", "name": "CapMWI", "title": "Cap MWI" }, "MediaSwitchDisplayName": { "minItems": 0, "type": "string", "description": "The name of the parent MediaSwitch.", "name": "MediaSwitchDisplayName", "title": "Media Switch Display Name" }, "CapDeliverAmis": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is capable of performing the function of delivering AMIS messages.", "name": "CapDeliverAmis", "title": "Cap Deliver Amis" }, "HuntOrder": { "minItems": 0, "type": "integer", "description": " The position of this line in the hunt group as configured on the switch, with the highest numbers representing the lines that are first (\"use me first\") in the hunt group. Ports can have the same HuntOrder, and in that case ports will be selected on a round-robin (or longest-idle) basis. \n", "name": "HuntOrder", "title": "Hunt Order" }, "MediaPortGroupMwiReqPortSpecific": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether MWI requests require a MediaPort. ", "name": "MediaPortGroupMwiReqPortSpecific", "title": "Media Port Group Mwi Req Port Specific" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a MediaPort object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "PortGroupURI": { "name": "PortGroupURI", "format": "uri", "minItems": 0, "title": "Port Group URI", "choices": [], "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "SkinnyDoMediaEncryption": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the audio stream between Cisco Unity Connection and the remote endpoint should be encrypted.", "name": "SkinnyDoMediaEncryption", "title": "Skinny Do Media Encryption" }, "PimgPortNumber": { "minItems": 0, "type": "string", "description": "The port number for PIMG.", "name": "PimgPortNumber", "title": "Pimg Port Number" }, "PhoneSystemURI": { "name": "PhoneSystemURI", "format": "uri", "minItems": 0, "title": "Phone System URI", "choices": [], "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "CapEnabled": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the media port is enabled during normal operation.", "name": "CapEnabled", "title": "Cap Enabled" }, "MediaPortGroupEnableMWI": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this port group can transmit message waiting indicator (MWI) on/off messages to the switch.", "name": "MediaPortGroupEnableMWI", "title": "Media Port Group Enable MWI" }, "VmsServerObjectId": { "target_attr": "ObjectId", "description": "The name of the VMSServer object to which this line belongs.", "format": "uri", "minItems": 0, "title": "VMS Server", "required": true, "choices": [], "target_title": "ServerName", "target": "/api/device/cuc/VmsServer/choices/?choice_title=ServerName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/VmsServer", "type": "string", "name": "VmsServerObjectId" }, "MediaPortGroupObjectId": { "target_attr": "ObjectId", "description": "The name of the MediaPortGroup object to which this port belongs.", "format": "uri", "minItems": 0, "title": "Media Port Group", "required": true, "choices": [], "target_title": "DisplayName", "target": "/api/device/cuc/PortGroup/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/PortGroup", "type": "string", "name": "MediaPortGroupObjectId" }, "MediaSwitchObjectId": { "target_title": "DisplayName", "description": "The name of the parent MediaSwitch.", "title": "Media Switch", "minItems": 0, "format": "uri", "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/PhoneSystem/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/PhoneSystem", "type": "string", "name": "MediaSwitchObjectId" }, "SkinnyDeviceName": { "minItems": 0, "type": "string", "description": "For a CCM SCCP integration, the name of the SCCP device.", "name": "SkinnyDeviceName", "title": "Skinny Device Name" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/Port/add/ |
|
The GUI Add form of device/cuc/Port 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/device/cuc/Port | 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/device/cuc/Port/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/Port/[pkid1]", "/api/device/cuc/Port/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/Port/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/Port/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/Port/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Port/[pkid1]", "/api/v0/device/cuc/Port/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Port/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cuc/Port |
|
{"hrefs": ["/api/device/cuc/Port/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Port |
|
{"hrefs": ["/api/device/cuc/Port/[pkid1]", "/api/device/cuc/Port/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Port; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Port/export/ |
|
{ "hrefs":["/api/device/cuc/Port/[pkid1]", "/api/device/cuc/Port/[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/cuc/Port and the JSON format can be used to import instances of device/cuc/Port.
GET http://[host-proxy]/api/device/cuc/Port/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Port | POST | /api/device/cuc/Port/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/cuc/Port/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/device/cuc/Port/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/Port/ |
|
The device/cuc/Port schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Port instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/Port/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 3 }, "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": [ { "add": { "support_async": false, "class": "add", "href": "/api/device/cuc/Port/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Port/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/Port/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/cuc/Port", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Port/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/cuc/Port/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/Port/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/Port/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/Port/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Port/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Port/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Port", "model_specific_actions": [ "add", "list", "update", "remove", "get", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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": "5f3aeb36ce894e001206bb55", "meta": { "tags": [], "cached": true, "title": "Cu1-Vm-PG-001", "business_key": {}, "schema_version": "11.5", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3aeb36ce894e001206bb55", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3aeb36ce894e001206bb55/?model_type=device/cuc/Port", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Port", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb36ce894e001206bb55" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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": { "NumberOfPorts": 1, "TelephonyIntegrationMethodEnum": 2, "ObjectId": "4a0228c1-3516-4ca3-9ff8-3125dd5ea751", "VmsServerName": "cucx", "CapTrapConnection": true, "CapEnabled": true, "CapAnswer": true, "MediaPortGroupDisplayName": "Cu1-Vm-PG", "URI": "/vmrest/ports/4a0228c1-3516-4ca3-9ff8-3125dd5ea751", "PortGroupURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "CapNotification": true, "VmsServerObjectId": "a44c7fa4-ad9b-4a33-aa54-9746961ea307", "MediaPortGroupObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "CapMWI": true, "MediaSwitchDisplayName": "PhoneSystem", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "DisplayName": "Cu1-Vm-PG-001", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3aeb38ce894e001206bb74", "meta": { "tags": [], "cached": true, "title": "Cu1-Vm-PG-002", "business_key": {}, "schema_version": "11.5", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3aeb38ce894e001206bb74", "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3aeb38ce894e001206bb74/?model_type=device/cuc/Port", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/Port/5f3aeb38ce894e001206bb74/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/Port", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb38ce894e001206bb74" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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": { "NumberOfPorts": 1, "TelephonyIntegrationMethodEnum": 2, "ObjectId": "c3f0f030-e6fa-4a13-8357-179e391c146e", "VmsServerName": "cucx", "CapTrapConnection": true, "CapEnabled": true, "CapAnswer": true, "MediaPortGroupDisplayName": "Cu1-Vm-PG", "URI": "/vmrest/ports/c3f0f030-e6fa-4a13-8357-179e391c146e", "PortGroupURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "CapNotification": true, "VmsServerObjectId": "a44c7fa4-ad9b-4a33-aa54-9746961ea307", "MediaPortGroupObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "CapMWI": true, "MediaSwitchDisplayName": "PhoneSystem", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "DisplayName": "Cu1-Vm-PG-002", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } }, { "pkid": "5f3aeb39ce894e001206bb93", "meta": { "tags": [], "cached": true, "title": "Cu1-Vm-PG-003", "business_key": {}, "schema_version": "11.5", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3aeb39ce894e001206bb93", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/5f3aeb39ce894e001206bb93/?model_type=device/cuc/Port", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/Port/5f3aeb39ce894e001206bb93/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/Port", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb39ce894e001206bb93" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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": { "NumberOfPorts": 1, "TelephonyIntegrationMethodEnum": 2, "ObjectId": "2ed932e2-f3a4-4c2e-8d75-a8d30fb37d33", "VmsServerName": "cucx", "CapTrapConnection": true, "CapEnabled": true, "CapAnswer": true, "MediaPortGroupDisplayName": "Cu1-Vm-PG", "URI": "/vmrest/ports/2ed932e2-f3a4-4c2e-8d75-a8d30fb37d33", "PortGroupURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "CapNotification": true, "VmsServerObjectId": "a44c7fa4-ad9b-4a33-aa54-9746961ea307", "MediaPortGroupObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "CapMWI": true, "MediaSwitchDisplayName": "PhoneSystem", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "DisplayName": "Cu1-Vm-PG-003", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group" } } ] }
(Show the first instance)
{ "pkid": "5f3aeb36ce894e001206bb55", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Cu1-Vm-PG-001", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3aeb36ce894e001206bb55", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/" } ], "foreign_key": [], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3aeb36ce894e001206bb55/?hierarchy=[hierarchy]&model_type=device/cuc/Port", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Port/5f3aeb36ce894e001206bb55/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Port", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb36ce894e001206bb55" ], "summary_attrs": [ { "name": "DisplayName", "title": "Display 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": { "NumberOfPorts": 1, "TelephonyIntegrationMethodEnum": 2, "ObjectId": "4a0228c1-3516-4ca3-9ff8-3125dd5ea751", "VmsServerName": "cucx", "CapTrapConnection": true, "CapEnabled": true, "MediaPortGroupDisplayName": "Cu1-Vm-PG", "URI": "/vmrest/ports/4a0228c1-3516-4ca3-9ff8-3125dd5ea751", "PortGroupURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "CapNotification": true, "VmsServerObjectId": "a44c7fa4-ad9b-4a33-aa54-9746961ea307", "MediaPortGroupObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "CapMWI": true, "MediaSwitchDisplayName": "PhoneSystem", "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "DisplayName": "Cu1-Vm-PG-001", "CapAnswer": true } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/Port. | GET | /api/device/cuc/Port/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Port as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/Port/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/device/cuc/Port/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Port/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Port/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Port | 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/cuc/Port; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Port/[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/cuc/Port and the JSON format can be used to import instances of device/cuc/Port.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/Port/[pkid] | hierarchy=[hierarchy] | The device/cuc/Port instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/Port/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Port. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/Port/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |