[Index]
Model ref.: device/cuc/AlternateExtensionAdvanced
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": {
"SkipPasswordForKnownDevice": {
"minItems": 0,
"title": "Skip Password For Known Device",
"type": "boolean",
"description": " A flag indicating whether the subscriber will be asked for his/her PIN.",
"name": "SkipPasswordForKnownDevice"
},
"RepeatMenu": {
"minItems": 0,
"title": "Repeat Menu",
"type": "integer",
"description": " The number of times to repeat a menu in TUI.",
"name": "RepeatMenu"
},
"CommandDigitTimeout": {
"description": " The amount of time (in milliseconds) between digits on a multiple digit menu command entry (i.e. different than the inter digit timeout that is used for strings of digits such as extensions and transfer strings).",
"title": "Command Digit Timeout",
"minItems": 0,
"maximum": 5000,
"minimum": 250,
"type": "integer",
"name": "CommandDigitTimeout"
},
"UserURI": {
"name": "UserURI",
"title": "User URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SkipReverseTime": {
"description": " Indicates the amount of time (in milliseconds) to jump backward when skipping in reverse in a voice or TTS message using either DTMF or voice commands while reviewing messages.",
"title": "Skip Reverse Time",
"minItems": 0,
"maximum": 60000,
"minimum": 1000,
"type": "integer",
"name": "SkipReverseTime"
},
"MessageVolume": {
"minItems": 0,
"title": "Message Volume",
"type": "integer",
"description": " The audio volume expressed as a percentage that Cisco Unity Connection uses to play\nback message.\n",
"name": "MessageVolume"
},
"NameConfirmation": {
"minItems": 0,
"title": "Name Confirmation",
"type": "boolean",
"description": " Indicates whether the voice name of the subscriber or distribution list added to an address list when a subscriber addresses a message to other subscribers is played. The default value for this is off (no voice name played) since the voice name was just played as part of the list of matches . To most users this sounds redundant when on, but some users prefer it.",
"name": "NameConfirmation"
},
"ConfirmDeleteMessage": {
"minItems": 0,
"title": "Confirm Delete Message",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will request confirmation from a subscriber before proceeding with a deletion of a single new or saved message. ",
"name": "ConfirmDeleteMessage"
},
"SubscriberObjectId": {
"description": "The unique identifier of the subscriber who is the owner of the device to which these device custom conversation setting values apply.",
"title": "Subscriber Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "SubscriberObjectId"
},
"SpeechSensitivity": {
"minItems": 0,
"title": "Speech Sensitivity",
"type": "integer",
"description": " A variable level of sound sensitivity that enables the speech engine to filter out background noise and not mistake it for speech. A higher value means higher sensitivity.\n",
"name": "SpeechSensitivity"
},
"SaveMessageOnHangup": {
"minItems": 0,
"title": "Save Message On Hangup",
"type": "boolean",
"description": " A flag indicating when hanging up while listening to a new message, whether the message is marked new again or is marked read.",
"name": "SaveMessageOnHangup"
},
"PromptSpeed": {
"minItems": 0,
"title": "Prompt Speed",
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back prompts to the subscriber.\n",
"name": "PromptSpeed"
},
"AddressMode": {
"minItems": 0,
"title": "Address Mode",
"type": "integer",
"description": " The default method the subscriber will use to address messages to other subscribers. This can be addressing by ID, addressing by first name then last name, or by last name and then first name.\n",
"name": "AddressMode"
},
"ContinuousAddMode": {
"minItems": 0,
"title": "Continuous Add Mode",
"type": "boolean",
"description": " A flag indicating whether when addressing, after entering one recipient name, whether the subscriber is asked to enter another name or assume the subscriber is finished adding names and is ready to move on to recording the message or applying message options.",
"name": "ContinuousAddMode"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DeviceCustomConvSetting object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"JumpToMessagesOnLogin": {
"minItems": 0,
"title": "Jump To Messages On Login",
"type": "boolean",
"description": " A flag indicating whether the subscriber conversation jumps directly to the first message in the message stack after subscriber sign-in.\n",
"name": "JumpToMessagesOnLogin"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"readonly": true,
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PromptVolume": {
"minItems": 0,
"title": "Prompt Volume",
"type": "integer",
"description": " The volume level for playback of system prompts.",
"name": "PromptVolume"
},
"MessageSpeed": {
"minItems": 0,
"title": "Message Speed",
"type": "integer",
"description": " The audio speed Cisco Unity Connection uses to play back messages to the subscriber.\n",
"name": "MessageSpeed"
},
"ConfirmationConfidenceThreshold": {
"minItems": 0,
"title": "Confirmation Confidence Threshold",
"type": "integer",
"description": " Voice Recognition Confirmation Confidence Threshold",
"name": "ConfirmationConfidenceThreshold"
},
"InterDigitDelay": {
"description": " The amount of time to wait (in milliseconds) for input between touch tones when collecting digits in TUI.\n",
"title": "Inter Digit Delay",
"minItems": 0,
"maximum": 10000,
"minimum": 1000,
"type": "integer",
"name": "InterDigitDelay"
},
"DeviceDtmfAccessIdObjectId": {
"description": " The device to which this DeviceCustomConvSetting object belongs. The unique identifier of the DtmfAccessId object to which these setting apply.",
"title": "Device Dtmf Access Id Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DeviceDtmfAccessIdObjectId"
},
"SkipForwardTime": {
"description": " Indicates the amount of time (in milliseconds) to jump forward when skipping ahead in a voice or TTS message using either DTMF or voice commands while reviewing messages.",
"title": "Skip Forward Time",
"minItems": 0,
"maximum": 60000,
"minimum": 1000,
"type": "integer",
"name": "SkipForwardTime"
},
"SendMessageOnHangup": {
"minItems": 0,
"title": "Send Message On Hangup",
"type": "integer",
"description": " Indicates when hanging up while addressing a message that has a recording and at least one recipient, whether the message is discarded, saved or the message is sent.",
"name": "SendMessageOnHangup"
},
"UseVui": {
"minItems": 0,
"title": "Use Vui",
"type": "boolean",
"description": " A flag indicating whether the speech recognition conversation is the default conversation for the subscriber.",
"name": "UseVui"
},
"FirstDigitTimeout": {
"description": " The amount of time to wait (in milliseconds) for first digit when collecting touch tones.\n",
"title": "First Digit Timeout",
"minItems": 0,
"maximum": 10000,
"minimum": 500,
"type": "integer",
"name": "FirstDigitTimeout"
},
"SpeechIncompleteTimeout": {
"description": " Specifies the required length of silence (in milliseconds) from when the speech prior to\nthe silence matches an active grammar, but where it is possible to speak further and still\nmatch the grammar. By contrast, the SpeechCompleteTimeout property is used when the speech prior to the silence matches an active grammar and no further words can be spoken.\n",
"title": "Speech Incomplete Timeout",
"minItems": 0,
"maximum": 60000,
"minimum": 300,
"type": "integer",
"name": "SpeechIncompleteTimeout"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/AlternateExtensionAdvanced/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/AlternateExtensionAdvanced/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/AlternateExtensionAdvanced/[pkid1]", "/api/v0/device/cuc/AlternateExtensionAdvanced/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/AlternateExtensionAdvanced/?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/AlternateExtensionAdvanced |
|
{"hrefs": ["/api/device/cuc/AlternateExtensionAdvanced/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/AlternateExtensionAdvanced |
|
{"hrefs": ["/api/device/cuc/AlternateExtensionAdvanced/[pkid1]", "/api/device/cuc/AlternateExtensionAdvanced/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/AlternateExtensionAdvanced; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/AlternateExtensionAdvanced/export/ |
|
{ "hrefs":["/api/device/cuc/AlternateExtensionAdvanced/[pkid1]", "/api/device/cuc/AlternateExtensionAdvanced/[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/AlternateExtensionAdvanced and the JSON format can be used to import instances of device/cuc/AlternateExtensionAdvanced.
GET http://[host-proxy]/api/device/cuc/AlternateExtensionAdvanced/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/AlternateExtensionAdvanced | POST | /api/device/cuc/AlternateExtensionAdvanced/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/AlternateExtensionAdvanced/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/AlternateExtensionAdvanced/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/AlternateExtensionAdvanced/ |
|
The device/cuc/AlternateExtensionAdvanced schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/AlternateExtensionAdvanced instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "ObjectId",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/AlternateExtensionAdvanced/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 14
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "14.0",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/AlternateExtensionAdvanced/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/AlternateExtensionAdvanced",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/AlternateExtensionAdvanced/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/AlternateExtensionAdvanced/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/AlternateExtensionAdvanced/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/AlternateExtensionAdvanced/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/AlternateExtensionAdvanced/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/AlternateExtensionAdvanced/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/AlternateExtensionAdvanced/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/AlternateExtensionAdvanced",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"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": "6305ba56c46e74b468883942",
"meta": {
"tags": [],
"cached": true,
"title": "0477341c-e7ff-43b3-ac88-a4248602a8df",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054d4bc46e74b4687bf9f2",
"href": "/api/v0/data/UnityConnection/63054d4bc46e74b4687bf9f2"
}
],
"self": [
{
"pkid": "6305ba56c46e74b468883942",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6305ba56c46e74b468883942/?model_type=device/cuc/AlternateExtensionAdvanced",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/AlternateExtensionAdvanced",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305ba56c46e74b468883942"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"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": {
"ObjectId": "0477341c-e7ff-43b3-ac88-a4248602a8df",
"DeviceDtmfAccessIdObjectId": "f57132c1-7c1f-47e7-971d-60ddf72c43f8",
"hierarchy": "63054c4fc46e74b4687bc91b",
"SubscriberObjectId": "8d40fa5d-af1e-4a15-8410-b0ec55fb5bf2",
"URI": "/vmrest/alternateextensionadvanceds/0477341c-e7ff-43b3-ac88-a4248602a8df",
"UserURI": "/vmrest/users/8d40fa5d-af1e-4a15-8410-b0ec55fb5bf2",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6305ba55c46e74b46888391b",
"meta": {
"tags": [],
"cached": true,
"title": "09858c19-6e96-4c95-92c1-7d92a7b14d25",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "63054d4bc46e74b4687bf9f2",
"href": "/api/v0/data/UnityConnection/63054d4bc46e74b4687bf9f2"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "6305ba55c46e74b46888391b",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/"
}
],
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6305ba55c46e74b46888391b/?model_type=device/cuc/AlternateExtensionAdvanced",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba55c46e74b46888391b/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/AlternateExtensionAdvanced",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305ba55c46e74b46888391b"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"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": {
"DeviceDtmfAccessIdObjectId": "bbfaa3f8-025e-4eaa-bd82-c1279150ac50",
"ObjectId": "09858c19-6e96-4c95-92c1-7d92a7b14d25",
"SubscriberObjectId": "11c272a5-1202-4966-be1a-c2ff081560ab",
"URI": "/vmrest/alternateextensionadvanceds/09858c19-6e96-4c95-92c1-7d92a7b14d25",
"UserURI": "/vmrest/users/11c272a5-1202-4966-be1a-c2ff081560ab",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "630579b2c46e74b468822e33",
"meta": {
"tags": [],
"cached": true,
"title": "631a910e-e612-4096-a356-e6a3247c04d2",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "630579aec46e74b468822d8f",
"href": "/api/v0/data/UnityConnection/630579aec46e74b468822d8f"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "630579b2c46e74b468822e33",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/"
}
],
"parent": [
{
"pkid": "6305775dc46e74b46881c66a",
"href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/630579b2c46e74b468822e33/?model_type=device/cuc/AlternateExtensionAdvanced",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/AlternateExtensionAdvanced/630579b2c46e74b468822e33/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/AlternateExtensionAdvanced",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"6305775dc46e74b46881c66a",
"630579b2c46e74b468822e33"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"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": {
"DeviceDtmfAccessIdObjectId": "e01b7ae0-bb02-4ff3-a15c-30824d11b750",
"ObjectId": "631a910e-e612-4096-a356-e6a3247c04d2",
"SubscriberObjectId": "231e8513-a58a-4fce-818d-164a6bbcac9d",
"URI": "/vmrest/alternateextensionadvanceds/631a910e-e612-4096-a356-e6a3247c04d2",
"UserURI": "/vmrest/users/231e8513-a58a-4fce-818d-164a6bbcac9d",
"hierarchy_friendly_name": "Overton (Customer)",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton"
}
}
]
}
(Show the first instance)
{
"pkid": "6305ba56c46e74b468883942",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "0477341c-e7ff-43b3-ac88-a4248602a8df",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "63054c4fc46e74b4687bc91b",
"href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b"
}
],
"self": [
{
"pkid": "6305ba56c46e74b468883942",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "63054d4bc46e74b4687bf9f2",
"href": "/api/v0/data/UnityConnection/63054d4bc46e74b4687bf9f2"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6305ba56c46e74b468883942/?hierarchy=[hierarchy]&model_type=device/cuc/AlternateExtensionAdvanced",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/AlternateExtensionAdvanced/6305ba56c46e74b468883942/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/AlternateExtensionAdvanced",
"path": [
"6t0ggef2c0deab00hb595101",
"6305086243fcc416f18ea4ac",
"63054bfdc46e74b4687bb868",
"63054c3bc46e74b4687bc61b",
"63054c4fc46e74b4687bc91b",
"6305ba56c46e74b468883942"
],
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"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": {
"UserURI": "/vmrest/users/8d40fa5d-af1e-4a15-8410-b0ec55fb5bf2",
"SubscriberObjectId": "8d40fa5d-af1e-4a15-8410-b0ec55fb5bf2",
"ObjectId": "0477341c-e7ff-43b3-ac88-a4248602a8df",
"DeviceDtmfAccessIdObjectId": "f57132c1-7c1f-47e7-971d-60ddf72c43f8",
"URI": "/vmrest/alternateextensionadvanceds/0477341c-e7ff-43b3-ac88-a4248602a8df"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/AlternateExtensionAdvanced. | GET | /api/device/cuc/AlternateExtensionAdvanced/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/AlternateExtensionAdvanced as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/AlternateExtensionAdvanced/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/AlternateExtensionAdvanced/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/AlternateExtensionAdvanced/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/AlternateExtensionAdvanced | 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/AlternateExtensionAdvanced; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/AlternateExtensionAdvanced/[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/AlternateExtensionAdvanced and the JSON format can be used to import instances of device/cuc/AlternateExtensionAdvanced.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/AlternateExtensionAdvanced/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/AlternateExtensionAdvanced instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/AlternateExtensionAdvanced/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/AlternateExtensionAdvanced. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/AlternateExtensionAdvanced/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |