[Index]
Model ref.: device/cuc/PortGroup
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": { "MwiOnCode": { "minItems": 0, "type": "string", "description": " The access code that Cisco Unity Connection uses to activate (light) a message waiting indicator (MWI).", "name": "MwiOnCode", "title": "Mwi On Code" }, "NoiseFreeEnable": { "minItems": 0, "type": "boolean", "description": " Enable NoiseFree noise cancellation.", "name": "NoiseFreeEnable", "title": "Noise Free Enable" }, "SipAuthenticateAsUser": { "minItems": 0, "type": "string", "description": " The user name used for SIP authentication.", "name": "SipAuthenticateAsUser", "title": "Sip Authenticate As User" }, "DisplayName": { "description": " The unique text name of this MediaPortGroup. Used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.", "title": "Display Name", "minItems": 0, "required": true, "type": "string", "name": "DisplayName" }, "MwiOffCode": { "minItems": 0, "type": "string", "description": " The access code that Cisco Unity Connection uses to deactivate (extinguish) a message waiting indicator (MWI).", "name": "MwiOffCode", "title": "Mwi Off Code" }, "PortCount": { "description": "The total number of MediaPorts in the MediaPortGroup.", "title": "Port Count", "minItems": 0, "readonly": true, "type": "integer", "name": "PortCount" }, "MwiReqPortSpecific": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether MWI requests require a MediaPort. ", "name": "MwiReqPortSpecific", "title": "Mwi Req Port Specific" }, "PortGroupCodecURI": { "type": "string", "description": "The URI to codec Information", "name": "PortGroupCodecURI", "title": "Port Group Codec URI" }, "MediaSipSecurityProfileObjectId": { "target_title": "DisplayName", "description": "The name of the Sip security profile used by this port group.", "title": "Media SIP Security Profile", "minItems": 0, "format": "uri", "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/SipSecurityProfile/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/SipSecurityProfile", "type": "string", "name": "MediaSipSecurityProfileObjectId" }, "SipPreferredMedia": { "description": " Indicates SIP media preference when sending an SDP offer.", "title": "Sip Preferred Media", "minItems": 0, "choices": [ [ 0, "IPmodeV4" ], [ 1, "IPmodeV6" ], [ 2, "IPmodeV4_V6" ] ], "type": "integer", "name": "SipPreferredMedia" }, "PhoneSystemURI": { "name": "PhoneSystemURI", "format": "uri", "minItems": 0, "title": "Phone System URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "SipAuthenticatePassword": { "minItems": 0, "type": "string", "description": " The password to use during SIP authentication.", "name": "SipAuthenticatePassword", "title": "Sip Authenticate Password" }, "TelephonyIntegrationMethodEnum": { "description": " The method used by lines in this group to integrate with the switch.", "title": "Telephony Integration Method", "minItems": 0, "required": true, "choices": [ [ 3, "PIMG" ], [ 2, "SIP" ], [ 1, "Skinny" ] ], "readonly": true, "type": "integer", "name": "TelephonyIntegrationMethodEnum" }, "MediaRemoteServiceEnum": { "description": " The type of IP service.", "title": "Media Remote Services", "minItems": 0, "choices": [ [ 105, "ASRMediaServer" ], [ 100, "CCM" ], [ 103, "CCMAXL" ], [ 101, "CCMTFTP" ], [ 104, "PIMG" ], [ 102, "SIPPROXY" ], [ 106, "TTSMediaServer" ] ], "type": "integer", "name": "MediaRemoteServiceEnum" }, "PreferredCallControl": { "description": " Indicates call control signaling preference.", "title": "Preferred Call Control", "minItems": 0, "choices": [ [ 0, "IPmodeV4" ], [ 1, "IPmodeV6" ], [ 2, "IPmodeV4_V6" ] ], "type": "integer", "name": "PreferredCallControl" }, "ResetStatusEnum": { "description": "Shows whether the port group needs to be reset in order to cause configuration changes to take effect", "title": "Reset Status", "minItems": 0, "choices": [ [ 0, "Reset Not Required" ], [ 100, "Reset Required" ], [ 101, "Reset In Progress" ] ], "readonly": true, "type": "integer", "name": "ResetStatusEnum" }, "SkinnyDevicePrefix": { "description": " The prefix Cisco Unity Connection uses to generate Skinny device name for ports belonging to this group.", "title": "Skinny Device Prefix", "minItems": 0, "pattern": "^.{1,46}-VI$", "type": "string", "name": "SkinnyDevicePrefix" }, "RecordingDTMFClipMs": { "minItems": 0, "type": "integer", "description": " Number of milliseconds to remove from the end of a recording when the recording is terminated with a digit press.", "name": "RecordingDTMFClipMs", "title": "Recording DTMF Clip Ms" }, "OutgoingGuardTimeMs": { "minItems": 0, "type": "integer", "description": " The amount of time (in milliseconds) a port in this group must be on-hook before the Cisco Unity Connection will allow an outgoing call on that port. ", "name": "OutgoingGuardTimeMs", "title": "Outgoing Guard Time Ms" }, "TlsPort": { "minItems": 0, "type": "integer", "description": " The IP port at which the service is found. Cisco Unity Connection must negotiate a TLS session when using this port.", "name": "TlsPort", "title": "Tls Port" }, "EnableAGC": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection should apply software-based gain control when recording messages.", "name": "EnableAGC", "title": "Enable AGC" }, "HostOrIPAddressV6": { "description": " Server DNS name or IPv6 address for remote service. ", "title": "Host Or IP Address V6", "minItems": 0, "readonly": true, "type": "string", "name": "HostOrIPAddressV6" }, "MwiMaxConcurrentRequests": { "minItems": 0, "type": "integer", "description": " The maximum number of MWI requests that can be in progress at any instant.", "name": "MwiMaxConcurrentRequests", "title": "Mwi Max Concurrent Requests" }, "MwiRetryIntervalOnSuccessMs": { "minItems": 0, "type": "integer", "description": " The minimum time interval (in milliseconds) between repeated transmissions of MWI on/off, see MWIRetryIntervalCountOnSuccess.", "name": "MwiRetryIntervalOnSuccessMs", "title": "Mwi Retry Interval On Success Ms" }, "MediaServerName": { "minItems": 0, "type": "string", "description": " The preferred name of the media server, if applicable.", "name": "MediaServerName", "title": "Media Server Name" }, "SipEnableNextGenSecurity": { "minItems": 0, "type": "boolean", "description": " A flag which indicates next generation Security is enable or not in sip", "name": "SipEnableNextGenSecurity", "title": "Sip Enable Next Gen Security" }, "MediaPortGroupTemplateObjectId": { "target_attr": "ObjectId", "description": "The name of the template from which the MediaPortGroup object was created.", "format": "uri", "minItems": 0, "title": "Media Port Group Template", "required": true, "choices": [], "target_title": "TemplateDescriptionDefault", "readonly": true, "target": "/api/device/cuc/PortGroupTemplate/choices/?choice_title=TemplateDescriptionDefault&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/PortGroupTemplate", "type": "string", "name": "MediaPortGroupTemplateObjectId" }, "MediaSwitchDisplayName": { "description": "The name of the parent MediaSwitch.", "title": "Media Switch Display Name", "minItems": 0, "readonly": true, "type": "string", "name": "MediaSwitchDisplayName" }, "RecordingToneExtraClipMs": { "minItems": 0, "type": "integer", "description": " Additional number of milliseconds to remove from the end of a recording when the recording is terminated by a tone.", "name": "RecordingToneExtraClipMs", "title": "Recording Tone Extra Clip Ms" }, "WaitForCallInfoMs": { "minItems": 0, "type": "integer", "description": " Number of milliseconds to wait for call information (CallerID, CalledID, etc.) to arrive after answering the call.", "name": "WaitForCallInfoMs", "title": "Wait For Call Info Ms" }, "DelayBeforeOpeningMs": { "minItems": 0, "type": "integer", "description": " The delay (in milliseconds) after a call is connected before playing the opening greeting.", "name": "DelayBeforeOpeningMs", "title": "Delay Before Opening Ms" }, "MwiMinRequestIntervalMs": { "minItems": 0, "type": "integer", "description": " The minimum amount of time (in milliseconds) between sending MWI on/off requests to the switch.", "name": "MwiMinRequestIntervalMs", "title": "Mwi Min Request Interval Ms" }, "PortURI": { "type": "string", "description": "The URI to ports Information", "name": "PortURI", "title": "Port URI" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a MediaPortGroup object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "SipTransportProtocolEnum": { "description": " The transport protocol Cisco Unity Connection should use for the SIP integration.", "title": "SIP Transport Protocol", "minItems": 0, "choices": [ [ 11, "TCP" ], [ 10, "UDP" ] ], "type": "integer", "name": "SipTransportProtocolEnum" }, "OutgoingPostDialDelayMs": { "minItems": 0, "type": "integer", "description": " The delay (in milliseconds) after dialing an outgoing call.", "name": "OutgoingPostDialDelayMs", "title": "Outgoing Post Dial Delay Ms" }, "PortGroupServerURI": { "type": "string", "description": "The URI to change the server address.", "name": "PortGroupServerURI", "title": "Port Group Server URI" }, "SipRPIDDisplayName": { "minItems": 0, "type": "string", "description": " SIP Remote-Party-ID header display name", "name": "SipRPIDDisplayName", "title": "Sip RPID Display Name" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "PortGroupURI": { "name": "PortGroupURI", "format": "uri", "minItems": 0, "title": "Port Group URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "SipDoDtmfKPML": { "minItems": 0, "type": "boolean", "description": " Send/receive DTMF out-of-band as SIP events (KPML)", "name": "SipDoDtmfKPML", "title": "Sip Do Dtmf KPML" }, "SipTLSModeEnum": { "description": " Specifies cipher to use for TLS", "title": "SIP TLS Mode", "minItems": 0, "choices": [ [ 10, "Authenticated" ], [ 11, "Encrypted" ] ], "type": "integer", "name": "SipTLSModeEnum" }, "MwiRetryCountOnSuccess": { "minItems": 0, "type": "integer", "description": " The number of times Cisco Unity Connection should repeat activating/deactivating an MWI upon success.", "name": "MwiRetryCountOnSuccess", "title": "Mwi Retry Count On Success" }, "HostOrIPAddress": { "description": " The DNS name or IP address of the computer hosting the remote service .", "title": "Host Or IP Address", "minItems": 0, "required": true, "readonly": true, "type": "string", "name": "HostOrIPAddress" }, "SkinnyStateMachineEnum": { "description": " A flag indicating whether this MediaPortGroup is integrated with Cisco Unified Communications Manager or Cisco CallManager Express. This is used to switch on a special state engine in the Skinny TSP for Cisco CallManager Express.", "title": "Skinny State Machine", "minItems": 0, "choices": [ [ 10, "CCM" ], [ 20, "CCME" ] ], "type": "integer", "name": "SkinnyStateMachineEnum" }, "VideoProfile": { "minItems": 0, "type": "integer", "name": "VideoProfile", "title": "Video Profile" }, "SipRegisterWithProxyServer": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection should register with a SIP proxy server.", "name": "SipRegisterWithProxyServer", "title": "Sip Register With Proxy Server" }, "SipDoAuthenticate": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection should authenticate with the remote endpoint.", "name": "SipDoAuthenticate", "title": "Sip Do Authenticate" }, "DtmfDialInterDigitDelayMs": { "minItems": 0, "type": "integer", "description": " The amount of time (in milliseconds) between DTMF digits when sending DTMF to the PBX.", "name": "DtmfDialInterDigitDelayMs", "title": "Dtmf Dial Inter Digit Delay Ms" }, "CcmDoAutoFailback": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection should automatically re-register (i.e. failback) with a higher-precedence CCM server if one becomes available. This is pertinent if a Cisco Unity Connection Skinny device is currently registered to a CCM server that is not the primary server.", "name": "CcmDoAutoFailback", "title": "Ccm Do Auto Failback" }, "MediaSwitchObjectId": { "target_attr": "ObjectId", "description": "The name of the MediaSwitch object to which this MediaPortGroup belongs. The MediaSwitch represents the PBX/switch at the other end of the phone lines.", "format": "uri", "minItems": 0, "title": "Media Switch", "required": true, "choices": [], "target_title": "DisplayName", "readonly": true, "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" }, "MediaCertificateObjectId": { "target_title": "DisplayName", "description": "The name of the Sip certificate object used by this port group.", "title": "Media Certificate", "minItems": 0, "format": "uri", "choices": [], "target_attr": "ObjectId", "target": "/api/device/cuc/SipCertificate/choices/?choice_title=DisplayName&field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_model_type": "device/cuc/SipCertificate", "type": "string", "name": "MediaCertificateObjectId" }, "OutgoingPreDialDelayMs": { "minItems": 0, "type": "integer", "description": " The delay (in milliseconds) before dialing.", "name": "OutgoingPreDialDelayMs", "title": "Outgoing Pre Dial Delay Ms" }, "EnableMWI": { "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": "EnableMWI", "title": "Enable MWI" }, "SipContactLineName": { "minItems": 0, "type": "string", "description": " The dialable (extension) number of the lines in this group, i.e., pilot number.", "name": "SipContactLineName", "title": "Sip Contact Line Name" }, "MediaPortGroupObjectId": { "target_title": "DisplayName", "description": "The name of the MediaPortGroup object to which this row corresponds.", "title": "Media Port Group", "minItems": 0, "format": "uri", "choices": [], "target_attr": "ObjectId", "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" }, "SipDoDtmfRfc2833": { "minItems": 0, "type": "boolean", "description": " Send/receive DTMF in RTP stream (RFC 2833)", "name": "SipDoDtmfRfc2833", "title": "Sip Do Dtmf Rfc2833" }, "SipDoSRTP": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the audio stream between Cisco Unity Connection and the remote endpoint should be encrypted.", "name": "SipDoSRTP", "title": "Sip Do SRTP" }, "Port": { "description": " The IP port at which the service is found.", "title": "Port", "minItems": 0, "readonly": true, "type": "integer", "name": "Port" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/PortGroup/add/ |
|
The GUI Add form of device/cuc/PortGroup 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/PortGroup | 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/PortGroup/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/PortGroup/[pkid1]", "/api/device/cuc/PortGroup/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/PortGroup/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/PortGroup/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/PortGroup/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PortGroup/[pkid1]", "/api/v0/device/cuc/PortGroup/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PortGroup/?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/PortGroup |
|
{"hrefs": ["/api/device/cuc/PortGroup/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PortGroup |
|
{"hrefs": ["/api/device/cuc/PortGroup/[pkid1]", "/api/device/cuc/PortGroup/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/PortGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/PortGroup/export/ |
|
{ "hrefs":["/api/device/cuc/PortGroup/[pkid1]", "/api/device/cuc/PortGroup/[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/PortGroup and the JSON format can be used to import instances of device/cuc/PortGroup.
GET http://[host-proxy]/api/device/cuc/PortGroup/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/PortGroup | POST | /api/device/cuc/PortGroup/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/PortGroup/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/PortGroup/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/PortGroup/ |
|
The device/cuc/PortGroup schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PortGroup instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/PortGroup/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 1 }, "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/PortGroup/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PortGroup/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/PortGroup/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/PortGroup", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PortGroup/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/PortGroup/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/PortGroup/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/PortGroup/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/PortGroup/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PortGroup/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PortGroup/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PortGroup", "model_specific_actions": [ "add", "list", "update", "get", "remove", "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": "5f3aeb35ce894e001206bb2b", "meta": { "tags": [], "cached": true, "title": "Cu1-Vm-PG", "business_key": {}, "schema_version": "11.5", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3aeb35ce894e001206bb2b", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3aeb35ce894e001206bb2b/?model_type=device/cuc/PortGroup", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PortGroup", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb35ce894e001206bb2b" ], "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": { "NoiseFreeEnable": true, "DisplayName": "Cu1-Vm-PG", "PortCount": 3, "PortGroupCodecURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac/portgroupcodecs", "MediaSipSecurityProfileObjectId": "ed55970d-a8e8-48a9-9ddc-2e578bba8868", "SipPreferredMedia": 0, "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "TelephonyIntegrationMethodEnum": 2, "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "PreferredCallControl": 0, "ResetStatusEnum": 0, "RecordingDTMFClipMs": 170, "OutgoingGuardTimeMs": 0, "EnableAGC": true, "MwiMaxConcurrentRequests": 0, "MwiRetryIntervalOnSuccessMs": 5, "SipEnableNextGenSecurity": false, "MediaPortGroupTemplateObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1", "MediaSwitchDisplayName": "PhoneSystem", "RecordingToneExtraClipMs": 250, "WaitForCallInfoMs": 0, "DelayBeforeOpeningMs": 0, "MwiMinRequestIntervalMs": 0, "PortURI": "/vmrest/ports/", "ObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "SipTransportProtocolEnum": 11, "OutgoingPostDialDelayMs": 50, "PortGroupServerURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac/portgroupservers", "URI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "SipDoDtmfKPML": true, "SipTLSModeEnum": 11, "MwiRetryCountOnSuccess": 0, "HostOrIPAddress": "192.168.100.15", "VideoProfile": 360, "SipRegisterWithProxyServer": false, "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "SipDoAuthenticate": false, "DtmfDialInterDigitDelayMs": 300, "CcmDoAutoFailback": true, "OutgoingPreDialDelayMs": 0, "EnableMWI": true, "SipDoDtmfRfc2833": true, "SipDoSRTP": true, "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876" } } ] }
(Show the first instance)
{ "pkid": "5f3aeb35ce894e001206bb2b", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Cu1-Vm-PG", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3aeb35ce894e001206bb2b", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/" } ], "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/PortGroup/5f3aeb35ce894e001206bb2b/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3aeb35ce894e001206bb2b/?hierarchy=[hierarchy]&model_type=device/cuc/PortGroup", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PortGroup/5f3aeb35ce894e001206bb2b/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PortGroup", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3aeb35ce894e001206bb2b" ], "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": { "NoiseFreeEnable": true, "DisplayName": "Cu1-Vm-PG", "PortCount": 3, "PortGroupCodecURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac/portgroupcodecs", "MediaSipSecurityProfileObjectId": "ed55970d-a8e8-48a9-9ddc-2e578bba8868", "SipPreferredMedia": 0, "PhoneSystemURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "TelephonyIntegrationMethodEnum": 2, "PreferredCallControl": 0, "ResetStatusEnum": 0, "RecordingDTMFClipMs": 170, "OutgoingGuardTimeMs": 0, "EnableAGC": true, "MwiMaxConcurrentRequests": 0, "MwiRetryIntervalOnSuccessMs": 5, "SipEnableNextGenSecurity": false, "MediaPortGroupTemplateObjectId": "04e0e286-56ed-4f27-a325-756a49dd98e1", "MediaSwitchDisplayName": "PhoneSystem", "RecordingToneExtraClipMs": 250, "WaitForCallInfoMs": 0, "MwiMinRequestIntervalMs": 0, "PortURI": "/vmrest/ports/", "ObjectId": "a3618947-df80-4a29-a7d4-3b83ec1071ac", "SipTransportProtocolEnum": 11, "OutgoingPostDialDelayMs": 50, "DelayBeforeOpeningMs": 0, "PortGroupServerURI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac/portgroupservers", "URI": "/vmrest/portgroups/a3618947-df80-4a29-a7d4-3b83ec1071ac", "SipDoDtmfKPML": true, "SipTLSModeEnum": 11, "MwiRetryCountOnSuccess": 0, "HostOrIPAddress": "192.168.100.15", "VideoProfile": 360, "SipRegisterWithProxyServer": false, "SipDoAuthenticate": false, "DtmfDialInterDigitDelayMs": 300, "CcmDoAutoFailback": true, "OutgoingPreDialDelayMs": 0, "EnableMWI": true, "SipDoDtmfRfc2833": true, "SipDoSRTP": true, "MediaSwitchObjectId": "dfc0384d-501e-46b5-855f-2200470c5876" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/PortGroup. | GET | /api/device/cuc/PortGroup/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/PortGroup as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/PortGroup/[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/PortGroup/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/PortGroup/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PortGroup/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/PortGroup | 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/PortGroup; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/PortGroup/[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/PortGroup and the JSON format can be used to import instances of device/cuc/PortGroup.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/PortGroup/[pkid] | hierarchy=[hierarchy] | The device/cuc/PortGroup instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/PortGroup/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/PortGroup. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/PortGroup/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |