[Index]
Model ref.: device/cuc/PhoneSystem
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": { "DisplayName": { "description": " The unique text name (e.g., \"Unified Communications Manager Cluster - Seattle\") of the media switch to be 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" }, "PortCount": { "minItems": 0, "type": "integer", "description": "The total number of ports belonging to the switch.", "name": "PortCount", "title": "Port Count" }, "CcmVersion": { "minItems": 0, "type": "string", "description": " The product version of the Cisco Unified Communications Manager switch.", "name": "CcmVersion", "title": "Ccm Version" }, "RestrictDialScheduled": { "minItems": 0, "type": "boolean", "description": " Prohibit all outgoing calls and MWI requests on ports belonging to the phone system within the specified time period", "name": "RestrictDialScheduled", "title": "Restrict Dial Scheduled" }, "MwiPortMemory": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the switch requires that Cisco Unity Connection send MWI \"off\" requests to the same PBX port as the MWI \"on\" requests. ", "name": "MwiPortMemory", "title": "Mwi Port Memory" }, "RestrictDialUnconditional": { "minItems": 0, "type": "boolean", "description": " Prohibit all outgoing calls and MWI requests on ports belonging to the phone system", "name": "RestrictDialUnconditional", "title": "Restrict Dial Unconditional" }, "PhoneSystemAssociationURI": { "readonly": true, "type": "string", "description": "The URI to get the PhoneSystem Associations.", "name": "PhoneSystemAssociationURI", "title": "Phone System Association URI" }, "CcmCtiPassword": { "minItems": 0, "type": "string", "description": " The password (encrypted) for the CcmCtiUser. Unity Connection uses the CTI user/password pair to gain access to the phones for the Unity Connection \"Phone Apps\" features which, display and gather info (e.g., list of your voice messages) via the phone display. For example, the Visual Message Locator feature is one of the Phone Apps features.. ", "name": "CcmCtiPassword", "title": "Ccm Cti Password" }, "CcmAXLUser": { "minItems": 0, "type": "string", "description": " The user name used to connect to AXL Web service on a Cisco Call Manager cluster.", "name": "CcmAXLUser", "title": "Ccm AXL User" }, "EnablePhoneApplications": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether IP phone applications are enabled for this phone system.", "name": "EnablePhoneApplications", "title": "Enable Phone Applications" }, "RestrictDialEndTime": { "minItems": 0, "type": "integer", "description": " Time of day to end outgoing call prohibition. The time is stored as minutes past midnight, where 0 = midnight.", "name": "RestrictDialEndTime", "title": "Restrict Dial End Time" }, "RestrictDialStartTime": { "minItems": 0, "type": "integer", "description": " Time of day to start outgoing call prohibition. The time is stored as minutes past midnight, where 0 = midnight.", "name": "RestrictDialStartTime", "title": "Restrict Dial Start Time" }, "CcmAXLPassword": { "minItems": 0, "type": "string", "description": " The password (encrypted) for the CcmAXLUser used to connect to a AXL Web service on a Cisco Call Manager cluster.", "name": "CcmAXLPassword", "title": "Ccm AXL Password" }, "AXLServerURI": { "readonly": true, "type": "string", "description": "The URI to get the AXL servers.", "name": "AXLServerURI", "title": "AXL Server URI" }, "CallLoopDTMF": { "description": " The name of the 4th Column DTMF tone used for Reject Forward Notification and Supervised Call Loop Detection.", "title": "Call Loop DTMF", "minItems": 0, "choices": [ [ "A", "A" ], [ "B", "B" ], [ "C", "C" ] ], "type": "string", "name": "CallLoopDTMF" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a MediaSwitch object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "DefaultTRaPSwitch": { "minItems": 0, "type": "boolean", "description": " Use this as default TRaP switch for administrators?", "name": "DefaultTRaPSwitch", "title": "Default T Ra P Switch" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "readonly": true, "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "MwiAlwaysUpdate": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Cisco Unity Connection will always send a \"set MWI\" message to the switch whenever the mailbox contents change, even if the Cisco Unity Connection database record indicates the MWI is already in the correct state.", "name": "MwiAlwaysUpdate", "title": "Mwi Always Update" }, "CallLoopGuardTimeMs": { "minItems": 0, "type": "integer", "description": " The amount of time (in milliseconds) i.e. \"guard time\" used for Rejecting Forwarded Notifications and Supervised Transfer Call Loop Detection.", "name": "CallLoopGuardTimeMs", "title": "Call Loop Guard Time Ms" }, "MwiForceOff": { "minItems": 0, "type": "boolean", "description": " A flag that indicates whether all User MWI devices falling on this phone system should be unconditionally off.", "name": "MwiForceOff", "title": "Mwi Force Off" }, "CcmCtiUser": { "minItems": 0, "type": "string", "description": " The user name for a Call Manager user that is assigned CTI access to one or more CCM devices. Unity Connection uses the CTI user/password pair to gain access to the phones for the Unity Connection \"Phone Apps\" features which, display and gather info (e.g., list of your voice messages) via the phone display. For example, the Visual Message Locator feature is one of the Phone Apps features.. ", "name": "CcmCtiUser", "title": "Ccm Cti User" }, "CallLoopForwardNotificationDetect": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Reject Forwarded Notification is enabled.", "name": "CallLoopForwardNotificationDetect", "title": "Call Loop Forward Notification Detect" }, "CallLoopExtensionDetect": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether extension-based call-loop detection is enabled.", "name": "CallLoopExtensionDetect", "title": "Call Loop Extension Detect" }, "CallLoopSupervisedTransferDetect": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether Supervised Transfer Call Loop Detection is enabled.", "name": "CallLoopSupervisedTransferDetect", "title": "Call Loop Supervised Transfer Detect" } }, "schema_version": "14.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/device/cuc/PhoneSystem/add/ |
|
The GUI Add form of device/cuc/PhoneSystem 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/PhoneSystem | 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/PhoneSystem/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/PhoneSystem/[pkid1]", "/api/device/cuc/PhoneSystem/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/PhoneSystem/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/PhoneSystem/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/PhoneSystem/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/PhoneSystem/[pkid1]", "/api/v0/device/cuc/PhoneSystem/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/PhoneSystem/?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/PhoneSystem |
|
{"hrefs": ["/api/device/cuc/PhoneSystem/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/PhoneSystem |
|
{"hrefs": ["/api/device/cuc/PhoneSystem/[pkid1]", "/api/device/cuc/PhoneSystem/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/PhoneSystem; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/PhoneSystem/export/ |
|
{ "hrefs":["/api/device/cuc/PhoneSystem/[pkid1]", "/api/device/cuc/PhoneSystem/[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/PhoneSystem and the JSON format can be used to import instances of device/cuc/PhoneSystem.
GET http://[host-proxy]/api/device/cuc/PhoneSystem/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/PhoneSystem | POST | /api/device/cuc/PhoneSystem/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/PhoneSystem/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/PhoneSystem/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/PhoneSystem/ |
|
The device/cuc/PhoneSystem schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/PhoneSystem instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/PhoneSystem/?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/PhoneSystem/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PhoneSystem/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/PhoneSystem/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/PhoneSystem", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PhoneSystem/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/PhoneSystem/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/PhoneSystem/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/PhoneSystem/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/PhoneSystem/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PhoneSystem/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PhoneSystem/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PhoneSystem", "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": "5f3ae76bce894e001205a526", "meta": { "tags": [], "cached": true, "title": "PhoneSystem", "business_key": {}, "schema_version": "11.5", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae76bce894e001205a526", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae76bce894e001205a526/?model_type=device/cuc/PhoneSystem", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PhoneSystem", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae76bce894e001205a526" ], "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": { "DisplayName": "PhoneSystem", "PortCount": 3, "RestrictDialScheduled": false, "MwiPortMemory": false, "RestrictDialUnconditional": false, "hierarchy_friendly_name": "AB_Group (Customer)", "PhoneSystemAssociationURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/phonesystemassociations", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "EnablePhoneApplications": false, "RestrictDialEndTime": 0, "RestrictDialStartTime": 0, "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "AXLServerURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/axlservers", "CallLoopDTMF": "A", "ObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "DefaultTRaPSwitch": true, "URI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "MwiAlwaysUpdate": false, "CallLoopGuardTimeMs": 2500, "MwiForceOff": false, "CallLoopForwardNotificationDetect": false, "CallLoopExtensionDetect": true, "CallLoopSupervisedTransferDetect": false } } ] }
(Show the first instance)
{ "pkid": "5f3ae76bce894e001205a526", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "PhoneSystem", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3ae76bce894e001205a526", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/" } ], "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/PhoneSystem/5f3ae76bce894e001205a526/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae76bce894e001205a526/?hierarchy=[hierarchy]&model_type=device/cuc/PhoneSystem", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/PhoneSystem/5f3ae76bce894e001205a526/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/PhoneSystem", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae76bce894e001205a526" ], "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": { "MwiPortMemory": false, "CallLoopDTMF": "A", "DisplayName": "PhoneSystem", "ObjectId": "dfc0384d-501e-46b5-855f-2200470c5876", "PortCount": 3, "EnablePhoneApplications": false, "MwiForceOff": false, "DefaultTRaPSwitch": true, "URI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876", "RestrictDialScheduled": false, "CallLoopForwardNotificationDetect": false, "CallLoopGuardTimeMs": 2500, "RestrictDialUnconditional": false, "MwiAlwaysUpdate": false, "CallLoopExtensionDetect": true, "RestrictDialStartTime": 0, "PhoneSystemAssociationURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/phonesystemassociations", "CallLoopSupervisedTransferDetect": false, "RestrictDialEndTime": 0, "AXLServerURI": "/vmrest/phonesystems/dfc0384d-501e-46b5-855f-2200470c5876/axlservers" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/PhoneSystem. | GET | /api/device/cuc/PhoneSystem/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/PhoneSystem as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/PhoneSystem/[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/PhoneSystem/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/PhoneSystem/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/PhoneSystem/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/PhoneSystem | 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/PhoneSystem; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/PhoneSystem/[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/PhoneSystem and the JSON format can be used to import instances of device/cuc/PhoneSystem.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/PhoneSystem/[pkid] | hierarchy=[hierarchy] | The device/cuc/PhoneSystem instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/PhoneSystem/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/PhoneSystem. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/PhoneSystem/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |