[Index]
Model ref.: device/cuc/TemplateMenuEntry
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": {
"Locked": {
"minItems": 0,
"title": "Locked",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection ignores additional input after callers press this key.\n\nValues:\n0: Additional input accepted\n1: Additional input ignored; Cisco Unity Connection performs the action assigned to the key. \n",
"name": "Locked"
},
"TransferType": {
"minItems": 0,
"title": "Transfer Type",
"type": "integer",
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"name": "TransferType"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a MenuEntry object.",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"TransferNumber": {
"minItems": 0,
"title": "Transfer Number",
"type": "string",
"description": " The phone number associated with the alternate contact",
"name": "TransferNumber"
},
"TransferRings": {
"minItems": 0,
"title": "Transfer Rings",
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings"
},
"CallhandlerURI": {
"minItems": 0,
"title": "Callhandler URI",
"type": "string",
"name": "CallhandlerURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"CallHandlerObjectId": {
"target": "/api/device/cuc/CallhandlerTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "CallHandlerObjectId",
"target_attr": "ObjectId",
"title": "Call Handler Object Id",
"type": [
"string"
],
"description": " The unique identifier of the CallHandler object to which this menu entry belongs. - template parameter [1]",
"target_model_type": "device/cuc/CallhandlerTemplate",
"choices": []
},
"TouchtoneKey": {
"description": " The character on the touch-tone keypad that this menu entry corresponds to (*, #, 0,1...9). - template parameter [2]",
"title": "Touchtone Key",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TouchtoneKey"
},
"TargetConversation": {
"minItems": 0,
"title": "Target Conversation",
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "TargetConversation"
},
"Action": {
"minItems": 0,
"title": "Action",
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "Action"
},
"DisplayName": {
"minItems": 0,
"title": "Display Name",
"type": "string",
"description": " The display name associated with the alternate contact number.",
"name": "DisplayName"
},
"TargetHandlerObjectId": {
"minItems": 0,
"title": "Target Handler Object Id",
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "TargetHandlerObjectId"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/TemplateMenuEntry/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/TemplateMenuEntry/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TemplateMenuEntry/[pkid1]", "/api/v0/device/cuc/TemplateMenuEntry/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/TemplateMenuEntry/?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/TemplateMenuEntry |
|
{"hrefs": ["/api/device/cuc/TemplateMenuEntry/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/TemplateMenuEntry |
|
{"hrefs": ["/api/device/cuc/TemplateMenuEntry/[pkid1]", "/api/device/cuc/TemplateMenuEntry/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/TemplateMenuEntry; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/TemplateMenuEntry/export/ |
|
{ "hrefs":["/api/device/cuc/TemplateMenuEntry/[pkid1]", "/api/device/cuc/TemplateMenuEntry/[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/TemplateMenuEntry and the JSON format can be used to import instances of device/cuc/TemplateMenuEntry.
GET http://[host-proxy]/api/device/cuc/TemplateMenuEntry/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/TemplateMenuEntry | POST | /api/device/cuc/TemplateMenuEntry/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/TemplateMenuEntry/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/TemplateMenuEntry/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/TemplateMenuEntry/ |
|
The device/cuc/TemplateMenuEntry schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/TemplateMenuEntry instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 24,
"total_limit": null,
"order_by": "DisplayName",
"direction": "asc",
"current": "/api/device/cuc/TemplateMenuEntry/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/TemplateMenuEntry",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/TemplateMenuEntry/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/TemplateMenuEntry",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/TemplateMenuEntry/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/TemplateMenuEntry/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/TemplateMenuEntry/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/TemplateMenuEntry/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/TemplateMenuEntry/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/TemplateMenuEntry/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/TemplateMenuEntry/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"Locked": true,
"ObjectId": "6dd3cf4e-20fa-4dbf-bbc7-6b87ded39d27",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templatemenuentries/*",
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"TouchtoneKey": "*",
"TargetConversation": "SubSignIn",
"Action": 2,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/TemplateMenuEntry",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/",
"pkid": "5ae89ef8affa931cce38ca6c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ef8affa931cce38ca6c"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae89ef8affa931cce38ca6c/?model_type=device/cuc/TemplateMenuEntry",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae89ef8affa931cce38ca6c"
},
{
"data": {
"Locked": true,
"ObjectId": "126b2570-b51c-48a4-8bba-7d29e12b3434",
"hierarchy": "5ae89ea2affa931cce38a523",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templatemenuentries/%23",
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"TouchtoneKey": "#",
"Action": 5,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/TemplateMenuEntry",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/",
"pkid": "5ae89ef8affa931cce38ca74"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ef8affa931cce38ca74"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae89ef8affa931cce38ca74/?model_type=device/cuc/TemplateMenuEntry",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca74/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae89ef8affa931cce38ca74"
},
{
"data": {
"Locked": false,
"ObjectId": "be6cafc5-530b-43ab-9e44-110ff2470229",
"hierarchy": "5ae89ea2affa931cce38a523",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templatemenuentries/0",
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"TouchtoneKey": "0",
"Action": 0,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/TemplateMenuEntry",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/",
"pkid": "5ae89ef8affa931cce38ca85"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ef8affa931cce38ca85"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae89ef8affa931cce38ca85/?model_type=device/cuc/TemplateMenuEntry",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca85/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae89ef8affa931cce38ca85"
}
]
}
(Show the first instance)
{
"data": {
"Locked": true,
"ObjectId": "6dd3cf4e-20fa-4dbf-bbc7-6b87ded39d27",
"CallhandlerURI": "/vmrest/handlers/callhandlers/21ffff6b-9911-4329-bc76-aa2d00ec126e",
"URI": "/vmrest/callhandlertemplates/21ffff6b-9911-4329-bc76-aa2d00ec126e/templatemenuentries/*",
"CallHandlerObjectId": "21ffff6b-9911-4329-bc76-aa2d00ec126e",
"TouchtoneKey": "*",
"TargetConversation": "SubSignIn",
"Action": 2
},
"meta": {
"model_type": "device/cuc/TemplateMenuEntry",
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/",
"pkid": "5ae89ef8affa931cce38ca6c"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89ef8affa931cce38ca6c"
],
"schema_version": "11.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae89ef8affa931cce38ca6c/?hierarchy=[hierarchy]&model_type=device/cuc/TemplateMenuEntry",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/TemplateMenuEntry/5ae89ef8affa931cce38ca6c/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae89ef8affa931cce38ca6c"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/TemplateMenuEntry. | GET | /api/device/cuc/TemplateMenuEntry/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/TemplateMenuEntry as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/TemplateMenuEntry/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/TemplateMenuEntry/[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/TemplateMenuEntry/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/TemplateMenuEntry/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/TemplateMenuEntry | 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/TemplateMenuEntry; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/TemplateMenuEntry/[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/TemplateMenuEntry and the JSON format can be used to import instances of device/cuc/TemplateMenuEntry.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/TemplateMenuEntry/[pkid] | hierarchy=[hierarchy] | The device/cuc/TemplateMenuEntry instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/TemplateMenuEntry/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/TemplateMenuEntry. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/TemplateMenuEntry/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |