[Index]
Model ref.: device/cuc/CallhandlerPrimaryTemplate
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": {
"VoiceName": {
"minItems": 0,
"title": "Voice Name",
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName"
},
"DisplayName": {
"description": " The text name of the handler to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, the display name for the default opening greeting call handler is \"Opening Greeting.\"",
"title": "Display Name",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "DisplayName"
},
"EnablePrependDigits": {
"minItems": 0,
"title": "Enable Prepend Digits",
"type": "boolean",
"description": " A flag to indicate weather or not to prepend digits when dialing a extension number to transfer too.\n\n",
"name": "EnablePrependDigits"
},
"ScheduleSetURI": {
"name": "ScheduleSetURI",
"title": "Schedule Set URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CallHandler object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"UseCallLanguage": {
"minItems": 0,
"title": "Use Call Language",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.",
"name": "UseCallLanguage"
},
"ScheduleSetObjectId": {
"description": " The unique identifier of the schedule set Cisco Unity Connection will use for making standard versus off hours decisions within this call handler.",
"title": "Schedule Set Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ScheduleSetObjectId"
},
"OneKeyDelay": {
"minItems": 0,
"title": "One Key Delay",
"type": "integer",
"description": " The amount of time (in milliseconds) that Cisco Unity Connection waits for additional input after callers press a single key that is not locked. If there is no input within this time, Cisco Unity Connection performs the action assigned to the single key.",
"name": "OneKeyDelay"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"title": "Voice Name URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UserTemplateGreetingsURI": {
"name": "UserTemplateGreetingsURI",
"title": "User Template Greetings URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageAction": {
"minItems": 0,
"title": "After Message Action",
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "AfterMessageAction"
},
"MaxMsgLen": {
"minItems": 0,
"title": "Max Msg Len",
"type": "integer",
"description": " The maximum recording length (in seconds) for messages left by unidentified callers.",
"name": "MaxMsgLen"
},
"UseDefaultLanguage": {
"minItems": 0,
"title": "Use Default Language",
"type": "boolean",
"description": "A flag indicating whether the language for this call handler template is derived from the call handler template object attribute or the default language from the location to which the call handler template belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.",
"name": "UseDefaultLanguage"
},
"MenuEntriesURI": {
"title": "Menu Entries URI",
"type": "string",
"description": "The URI to change Menu Entries.",
"name": "MenuEntriesURI"
},
"PrependDigits": {
"minItems": 0,
"title": "Prepend Digits",
"type": "string",
"description": " Touch-Tone digits to prepended to extension when dialing transfer number ( #, 0,1...9,*).",
"name": "PrependDigits"
},
"Language": {
"minItems": 0,
"title": "Language",
"type": "integer",
"description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.",
"name": "Language"
},
"TransferOptionsURI": {
"title": "Transfer Options URI",
"type": "string",
"description": "The URI to get transfer rules.",
"name": "TransferOptionsURI"
},
"SendUrgentMsg": {
"minItems": 0,
"title": "Send Urgent Msg",
"type": "integer",
"description": " A flag indicating whether an unidentified caller can mark a message as \"urgent.\"",
"name": "SendUrgentMsg"
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"EditMsg": {
"minItems": 0,
"title": "Edit Msg",
"type": "boolean",
"description": " A flag that determines whether the caller can edit messages.",
"name": "EditMsg"
},
"PlayAfterMessage": {
"minItems": 0,
"title": "Play After Message",
"type": "integer",
"description": " Indicates whether the Sent Message Prompt Recording referenced by Post Greeting",
"name": "PlayAfterMessage"
},
"AfterMessageTargetHandlerObjectId": {
"minItems": 0,
"title": "After Message Target Handler Object Id",
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "AfterMessageTargetHandlerObjectId"
},
"PlayAfterMessageRecordingObjectId": {
"minItems": 0,
"title": "Play After Message Recording Object Id",
"type": "string",
"description": " A Link To a PostGreetingRecording that is used as After Message Recording",
"name": "PlayAfterMessageRecordingObjectId"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"title": "Voice File URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"AfterMessageTargetConversation": {
"minItems": 0,
"title": "After Message Target Conversation",
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "AfterMessageTargetConversation"
},
"SendPrivateMsg": {
"minItems": 0,
"title": "Send Private Msg",
"type": "integer",
"description": " Determines if an outside caller can mark their message as private.",
"name": "SendPrivateMsg"
},
"SendSecureMsg": {
"minItems": 0,
"title": "Send Secure Msg",
"type": "boolean",
"description": " A flag indicating whether an unidentified caller can mark a message as \"secure.\"",
"name": "SendSecureMsg"
},
"PostGreetingRecordingObjectId": {
"minItems": 0,
"title": "Post Greeting Recording Object Id",
"type": "string",
"description": " A link to a PostGreetingRecording",
"name": "PostGreetingRecordingObjectId"
},
"PlayPostGreetingRecording": {
"minItems": 0,
"title": "Play Post Greeting Recording",
"type": "integer",
"description": " Indicates whether the recording referenced by PostGreetingRecordingObjectId should be played.",
"name": "PlayPostGreetingRecording"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/CallhandlerPrimaryTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/CallhandlerPrimaryTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/CallhandlerPrimaryTemplate/[pkid1]", "/api/v0/device/cuc/CallhandlerPrimaryTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/CallhandlerPrimaryTemplate/?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/CallhandlerPrimaryTemplate |
|
{"hrefs": ["/api/device/cuc/CallhandlerPrimaryTemplate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/CallhandlerPrimaryTemplate |
|
{"hrefs": ["/api/device/cuc/CallhandlerPrimaryTemplate/[pkid1]", "/api/device/cuc/CallhandlerPrimaryTemplate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/CallhandlerPrimaryTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/CallhandlerPrimaryTemplate/export/ |
|
{ "hrefs":["/api/device/cuc/CallhandlerPrimaryTemplate/[pkid1]", "/api/device/cuc/CallhandlerPrimaryTemplate/[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/CallhandlerPrimaryTemplate and the JSON format can be used to import instances of device/cuc/CallhandlerPrimaryTemplate.
GET http://[host-proxy]/api/device/cuc/CallhandlerPrimaryTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/CallhandlerPrimaryTemplate | POST | /api/device/cuc/CallhandlerPrimaryTemplate/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/CallhandlerPrimaryTemplate/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/CallhandlerPrimaryTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/CallhandlerPrimaryTemplate/ |
|
The device/cuc/CallhandlerPrimaryTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/CallhandlerPrimaryTemplate instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/CallhandlerPrimaryTemplate/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 4
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "12.5",
"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/CallhandlerPrimaryTemplate/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/CallhandlerPrimaryTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/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/CallhandlerPrimaryTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CallhandlerPrimaryTemplate",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8a7919ce894e001671f2eb",
"meta": {
"tags": [],
"cached": true,
"title": "Primary",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a7908ce894e001671eeef",
"href": "/api/v0/data/UnityConnection/5e8a7908ce894e001671eeef"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7919ce894e001671f2eb",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7919ce894e001671f2eb/?model_type=device/cuc/CallhandlerPrimaryTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CallhandlerPrimaryTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7919ce894e001671f2eb"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"DisplayName": "Primary",
"EnablePrependDigits": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"ObjectId": "799ab31b-6143-4a71-91f3-ef95899cf93f",
"UseCallLanguage": true,
"ScheduleSetObjectId": "a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"OneKeyDelay": 1500,
"ScheduleSetURI": "/vmrest/schedulesets/a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"UserTemplateGreetingsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/usertemplategreetings",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"UseDefaultLanguage": true,
"MenuEntriesURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/menuentries",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Language": 1033,
"TransferOptionsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/transferoptions",
"SendUrgentMsg": 0,
"URI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f",
"EditMsg": true,
"PlayAfterMessage": 1,
"AfterMessageTargetHandlerObjectId": "894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe",
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0
}
},
{
"pkid": "5e8a7955ce894e00167200d3",
"meta": {
"tags": [],
"cached": true,
"title": "Primary",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a793ace894e001671faed",
"href": "/api/v0/data/UnityConnection/5e8a793ace894e001671faed"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7955ce894e00167200d3",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7955ce894e00167200d3/?model_type=device/cuc/CallhandlerPrimaryTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7955ce894e00167200d3/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/CallhandlerPrimaryTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7955ce894e00167200d3"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"DisplayName": "Primary",
"EnablePrependDigits": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"ObjectId": "799ab31b-6143-4a71-91f3-ef95899cf93f",
"UseCallLanguage": true,
"ScheduleSetObjectId": "a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"OneKeyDelay": 1500,
"ScheduleSetURI": "/vmrest/schedulesets/a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"UserTemplateGreetingsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/usertemplategreetings",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"UseDefaultLanguage": true,
"MenuEntriesURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/menuentries",
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"Language": 1033,
"TransferOptionsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/transferoptions",
"SendUrgentMsg": 0,
"URI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f",
"EditMsg": true,
"PlayAfterMessage": 1,
"AfterMessageTargetHandlerObjectId": "894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe",
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0
}
},
{
"pkid": "5e8a9ccfce894e001675ce36",
"meta": {
"tags": [],
"cached": true,
"title": "Primary",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a9c75ce894e001675bc99",
"href": "/api/v0/data/UnityConnection/5e8a9c75ce894e001675bc99"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a9ccfce894e001675ce36",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/"
}
],
"parent": [
{
"pkid": "5e8a99e5ce894e0016756f2c",
"href": "/api/data/HierarchyNode/5e8a99e5ce894e0016756f2c"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a9ccfce894e001675ce36/?model_type=device/cuc/CallhandlerPrimaryTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a9ccfce894e001675ce36/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CallhandlerPrimaryTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a99e5ce894e0016756f2c",
"5e8a9ccfce894e001675ce36"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"DisplayName": "Primary",
"EnablePrependDigits": false,
"hierarchy_friendly_name": "Overton (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton",
"ObjectId": "11cdaac7-c408-4a94-93ae-a467fa514b43",
"UseCallLanguage": true,
"ScheduleSetObjectId": "49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"OneKeyDelay": 1500,
"ScheduleSetURI": "/vmrest/schedulesets/49e68dc5-9c26-48dc-9f82-6544d85f3c68",
"UserTemplateGreetingsURI": "/vmrest/callhandlerprimarytemplates/11cdaac7-c408-4a94-93ae-a467fa514b43/usertemplategreetings",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"UseDefaultLanguage": true,
"MenuEntriesURI": "/vmrest/callhandlerprimarytemplates/11cdaac7-c408-4a94-93ae-a467fa514b43/menuentries",
"summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton",
"Language": 1033,
"TransferOptionsURI": "/vmrest/callhandlerprimarytemplates/11cdaac7-c408-4a94-93ae-a467fa514b43/transferoptions",
"SendUrgentMsg": 0,
"URI": "/vmrest/callhandlerprimarytemplates/11cdaac7-c408-4a94-93ae-a467fa514b43",
"EditMsg": true,
"PlayAfterMessage": 1,
"AfterMessageTargetHandlerObjectId": "f3b4a8ed-1b10-432c-8fe2-244ec03bce49",
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0
}
}
]
}
(Show the first instance)
{
"pkid": "5e8a7919ce894e001671f2eb",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Primary",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"self": [
{
"pkid": "5e8a7919ce894e001671f2eb",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "5e8a7908ce894e001671eeef",
"href": "/api/v0/data/UnityConnection/5e8a7908ce894e001671eeef"
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7919ce894e001671f2eb/?hierarchy=[hierarchy]&model_type=device/cuc/CallhandlerPrimaryTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CallhandlerPrimaryTemplate/5e8a7919ce894e001671f2eb/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CallhandlerPrimaryTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7919ce894e001671f2eb"
],
"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": "20.1.1",
"tagged_versions": []
},
"data": {
"DisplayName": "Primary",
"EnablePrependDigits": false,
"ObjectId": "799ab31b-6143-4a71-91f3-ef95899cf93f",
"UseCallLanguage": true,
"ScheduleSetObjectId": "a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"OneKeyDelay": 1500,
"ScheduleSetURI": "/vmrest/schedulesets/a1472022-3e1a-43bc-8ccd-81acb4d1c2d3",
"UserTemplateGreetingsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/usertemplategreetings",
"AfterMessageAction": 2,
"MaxMsgLen": 300,
"EditMsg": true,
"MenuEntriesURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/menuentries",
"Language": 1033,
"TransferOptionsURI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f/transferoptions",
"SendUrgentMsg": 0,
"URI": "/vmrest/callhandlerprimarytemplates/799ab31b-6143-4a71-91f3-ef95899cf93f",
"UseDefaultLanguage": true,
"PlayAfterMessage": 1,
"AfterMessageTargetHandlerObjectId": "894f2840-9f2b-4ba5-84d3-51fcfdc5e7fe",
"AfterMessageTargetConversation": "PHTransfer",
"SendPrivateMsg": 0,
"SendSecureMsg": false,
"PlayPostGreetingRecording": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/CallhandlerPrimaryTemplate. | GET | /api/device/cuc/CallhandlerPrimaryTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/CallhandlerPrimaryTemplate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/CallhandlerPrimaryTemplate/[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/CallhandlerPrimaryTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/CallhandlerPrimaryTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/CallhandlerPrimaryTemplate | 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/CallhandlerPrimaryTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/CallhandlerPrimaryTemplate/[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/CallhandlerPrimaryTemplate and the JSON format can be used to import instances of device/cuc/CallhandlerPrimaryTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/CallhandlerPrimaryTemplate/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/CallhandlerPrimaryTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/CallhandlerPrimaryTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/CallhandlerPrimaryTemplate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/CallhandlerPrimaryTemplate/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |