[Index]
Model ref.: device/cuc/DirectoryHandler
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": {
"ExitTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "ExitTargetConversation",
"title": "Exit Target Conversation"
},
"VoiceName": {
"minItems": 0,
"type": "string",
"description": " The name of the WAV file containing the recorded audio (voice name, greeting, etc.) for the parent object.",
"name": "VoiceName",
"title": "Voice Name"
},
"SearchScope": {
"minItems": 0,
"type": "integer",
"description": " The scope of the directory that Cisco Unity Connection will search.",
"name": "SearchScope",
"title": "Search Scope"
},
"PartitionURI": {
"name": "PartitionURI",
"format": "uri",
"minItems": 0,
"title": "Partition URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"NoSelectionTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "NoSelectionTargetConversation",
"title": "No Selection Target Conversation"
},
"ScopeObjectSearchSpaceURI": {
"name": "ScopeObjectSearchSpaceURI",
"format": "uri",
"minItems": 0,
"title": "Scope Object Search Space URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ExitTargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "ExitTargetHandlerObjectId",
"title": "Exit Target Handler Object Id"
},
"NoInputTargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "NoInputTargetHandlerObjectId",
"title": "No Input Target Handler Object Id"
},
"ZeroTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "ZeroTargetConversation",
"title": "Zero Target Conversation"
},
"SearchScopeObjectId": {
"minItems": 0,
"type": "string",
"description": "The three possible object references are coalesced into this column for backwards compatibility.",
"name": "SearchScopeObjectId",
"title": "Search Scope Object Id"
},
"NoSelectionTargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "NoSelectionTargetHandlerObjectId",
"title": "No Selection Target Handler Object Id"
},
"ExitAction": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "ExitAction",
"title": "Exit Action"
},
"UseStarToExit": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating the key on the phone to use for \"exit the directory.\" This controls whether the directory handler uses star (\"*\") to exit (like the rest of the conversation) or pound/hash (\"#\") to exit.",
"name": "UseStarToExit",
"title": "Use Star To Exit"
},
"ScopeObjectSearchSpaceObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the SearchSpace which can act as filter for the DirectoryHandler.",
"name": "ScopeObjectSearchSpaceObjectId",
"title": "Scope Object Search Space Object Id"
},
"NoSelectionConversationURI": {
"type": "string",
"description": "The URI to fetch the conversations for the no selectioncall action.",
"name": "NoSelectionConversationURI",
"title": "No Selection Conversation URI"
},
"PartitionObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Partition to which the Call Handler, Directory Handler, or InterviewHandler is assigned.",
"name": "PartitionObjectId",
"title": "Partition Object Id"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a DirectoryHandler object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"NoInputConversationURI": {
"type": "string",
"description": "The URI to fetch the conversations for the no input call action.",
"name": "NoInputConversationURI",
"title": "No Input Conversation URI"
},
"UseCallLanguage": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will use the language assigned to the call.",
"name": "UseCallLanguage",
"title": "Use Call Language"
},
"NoSelectionAction": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "NoSelectionAction",
"title": "No Selection Action"
},
"SayDepartment": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating if the user's department is voiced when a match is voiced.",
"name": "SayDepartment",
"title": "Say Department"
},
"VoiceNameURI": {
"name": "VoiceNameURI",
"format": "uri",
"minItems": 0,
"title": "Voice Name URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"ScopeObjectLocationObjectId": {
"description": " The unique identifier of the location which acts as the filter for the directory handler.",
"title": "Scope Object Location Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ScopeObjectLocationObjectId"
},
"Tries": {
"minItems": 0,
"type": "integer",
"description": " The number of times Cisco Unity Connection will reprompt the caller for input, e.g. dial name. ",
"name": "Tries",
"title": "Tries"
},
"LocationObjectId": {
"description": " The unique identifier of the Location object to which this handler belongs.",
"title": "Location Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "LocationObjectId"
},
"ExitConversationURI": {
"type": "string",
"description": "The URI to fetch the conversations for the exit call action.",
"name": "ExitConversationURI",
"title": "Exit Conversation URI"
},
"UseDefaultLanguage": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether the language for this directory handler is derived from the directory handler object attribute or the default language from the location to which the directory handler belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.",
"name": "UseDefaultLanguage",
"title": "Use Default Language"
},
"ScopeObjectDistributionListObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the distribution list which acts as the filter for the directory handler.",
"name": "ScopeObjectDistributionListObjectId",
"title": "Scope Object Distribution List Object Id"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"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.\"",
"name": "DisplayName",
"title": "Display Name"
},
"MaxMatches": {
"minItems": 0,
"type": "integer",
"description": " The number of matches, that if exceeded, will result in Cisco Unity Connection prompting the caller to dial more letters.",
"name": "MaxMatches",
"title": "Max Matches"
},
"NoInputAction": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "NoInputAction",
"title": "No Input Action"
},
"SayCity": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating if the user's city is voiced when a match is voiced.",
"name": "SayCity",
"title": "Say City"
},
"NoInputTargetConversation": {
"minItems": 0,
"type": "string",
"description": " The name of the conversation to which the caller is routed.",
"name": "NoInputTargetConversation",
"title": "No Input Target Conversation"
},
"StartDialDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in seconds) that Cisco Unity Connection waits for the caller to start dialing. \n\nTime to wait for caller to start dialing in seconds. This is controlled on the SA's Caller Input 'timeout if no input in seconds' setting.",
"name": "StartDialDelay",
"title": "Start Dial Delay"
},
"Language": {
"minItems": 0,
"type": "integer",
"description": " The Windows Locale ID (LCID) which identifies the language that Cisco Unity Connection plays the handler system prompts.",
"name": "Language",
"title": "Language"
},
"CreationTime": {
"description": " The date and time the handler is created.",
"title": "Creation Time",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "CreationTime"
},
"ZeroExitConversationURI": {
"type": "string",
"description": "The URI to fetch the active conversations for the zero exit call action.",
"name": "ZeroExitConversationURI",
"title": "Zero Exit Conversation URI"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PlayAllNames": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays the names of subscribers in the directory for caller selection, rather than requiring the caller to search by spelled name. \n\n",
"name": "PlayAllNames",
"title": "Play All Names"
},
"ZeroTargetHandlerObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the specific object to send along to the target conversation.",
"name": "ZeroTargetHandlerObjectId",
"title": "Zero Target Handler Object Id"
},
"ScopeObjectDistributionListURI": {
"name": "ScopeObjectDistributionListURI",
"format": "uri",
"minItems": 0,
"title": "Scope Object Distribution List URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TenantObjectId": {
"minItems": 0,
"type": "string",
"description": " Unique ObjectId of the tbl_Tenant",
"name": "TenantObjectId",
"title": "Tenant Object Id"
},
"ScopeObjectCosObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the COS which acts as the filter for the directory handler.",
"name": "ScopeObjectCosObjectId",
"title": "Scope Object Cos Object Id"
},
"UseCustomGreeting": {
"minItems": 0,
"type": "boolean",
"description": " Indicates whether to use the directory handler's custom greeting or the system prompt.",
"name": "UseCustomGreeting",
"title": "Use Custom Greeting"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this handler can be deleted via an administrative application such as Cisco Unity Connection Administration. It is used to prevent deletion of factory defaults.",
"name": "Undeletable",
"title": "Undeletable"
},
"AutoRoute": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will automatically route a call to the extension assigned to the subscriber on a unique match without prompting the caller to verify the match; or to present a list of matches, even if only one, and prompt the user to verify the match. ",
"name": "AutoRoute",
"title": "Auto Route"
},
"VoiceFileURI": {
"name": "VoiceFileURI",
"format": "uri",
"minItems": 0,
"title": "Voice File URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"SayExtension": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection provides a menu of subscriber names including extensions, or just subscriber names.",
"name": "SayExtension",
"title": "Say Extension"
},
"MenuStyle": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating how Cisco Unity Connection presents directory matches to callers - either in \"menu choice\" or \"extension list\" format.\n",
"name": "MenuStyle",
"title": "Menu Style"
},
"EndDialDelay": {
"minItems": 0,
"type": "integer",
"description": " The amount of time (in seconds) that Cisco Unity Connection waits after caller input before performing the action indicated by the input.",
"name": "EndDialDelay",
"title": "End Dial Delay"
},
"ScopeObjectLocationURI": {
"name": "ScopeObjectLocationURI",
"format": "uri",
"minItems": 0,
"title": "Scope Object Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DtmfAccessId": {
"minItems": 0,
"type": "string",
"description": " The dialable number.",
"name": "DtmfAccessId",
"title": "Dtmf Access Id"
},
"VoiceEnabled": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the directory handler will use voice based addressing rather than touchtones.",
"name": "VoiceEnabled",
"title": "Voice Enabled"
},
"SpeechConfidenceThreshold": {
"minItems": 0,
"type": "integer",
"description": " When the engine matches a spoken phrase, it associates a confidence level with that conclusion. This parameter determines what confidence level should be considered a successful match. A higher value means the engine is will report fewer successful matches, but it will be more confident in the matches that it reports.",
"name": "SpeechConfidenceThreshold",
"title": "Speech Confidence Threshold"
},
"ZeroAction": {
"minItems": 0,
"type": "integer",
"description": " The type of call action to take, e.g., hang-up, goto another object, etc.",
"name": "ZeroAction",
"title": "Zero Action"
},
"ScopeObjectCosURI": {
"name": "ScopeObjectCosURI",
"format": "uri",
"minItems": 0,
"title": "Scope Object Cos URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"DirectoryHandlerStreamFileURI": {
"type": "string",
"description": "The URI to fetch the directory handler stream files.",
"name": "DirectoryHandlerStreamFileURI",
"title": "Directory Handler Stream File URI"
},
"SearchByFirstName": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether a directory handler searches for subscribers by using first name first, or last name first.",
"name": "SearchByFirstName",
"title": "Search By First Name"
},
"LocationURI": {
"name": "LocationURI",
"format": "uri",
"minItems": 0,
"title": "Location URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/device/cuc/DirectoryHandler/add/ |
|
The GUI Add form of device/cuc/DirectoryHandler 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/DirectoryHandler | 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/DirectoryHandler/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/DirectoryHandler/[pkid1]", "/api/device/cuc/DirectoryHandler/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/DirectoryHandler/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/DirectoryHandler/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/DirectoryHandler/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/DirectoryHandler/[pkid1]", "/api/v0/device/cuc/DirectoryHandler/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/DirectoryHandler/?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/DirectoryHandler |
|
{"hrefs": ["/api/device/cuc/DirectoryHandler/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/DirectoryHandler |
|
{"hrefs": ["/api/device/cuc/DirectoryHandler/[pkid1]", "/api/device/cuc/DirectoryHandler/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/DirectoryHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/DirectoryHandler/export/ |
|
{ "hrefs":["/api/device/cuc/DirectoryHandler/[pkid1]", "/api/device/cuc/DirectoryHandler/[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/DirectoryHandler and the JSON format can be used to import instances of device/cuc/DirectoryHandler.
GET http://[host-proxy]/api/device/cuc/DirectoryHandler/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/DirectoryHandler | POST | /api/device/cuc/DirectoryHandler/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/DirectoryHandler/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/DirectoryHandler/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/DirectoryHandler/ |
|
The device/cuc/DirectoryHandler schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/DirectoryHandler instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/DirectoryHandler/?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/DirectoryHandler/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DirectoryHandler/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/DirectoryHandler/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/DirectoryHandler",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DirectoryHandler/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/DirectoryHandler/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/DirectoryHandler/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/DirectoryHandler/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/DirectoryHandler/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DirectoryHandler/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DirectoryHandler/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DirectoryHandler",
"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": "5f3ae6d5ce894e0012058e71",
"meta": {
"tags": [],
"cached": true,
"title": "System Directory Handler",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6d5ce894e0012058e71",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6d5ce894e0012058e71/?model_type=device/cuc/DirectoryHandler",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DirectoryHandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6d5ce894e0012058e71"
],
"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": {
"ExitTargetConversation": "PHTransfer",
"VoiceName": "cc6eb264-3302-4f8f-945a-ec03e039fb25.wav",
"SearchScope": 0,
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"NoSelectionTargetConversation": "PHTransfer",
"CreationTime": "2018-02-15T15:05:48Z",
"ExitTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"NoInputTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"ZeroTargetConversation": "PHTransfer",
"SearchScopeObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"NoSelectionTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"ExitAction": 2,
"hierarchy_friendly_name": "AB_Group (Customer)",
"UseStarToExit": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"NoSelectionConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlernoselection%20is%201)",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"Language": 1033,
"NoInputConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlernoinput%20is%201)",
"UseCallLanguage": true,
"NoSelectionAction": 2,
"SpeechConfidenceThreshold": 10,
"VoiceNameURI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8/voicename",
"ScopeObjectLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Tries": 1,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ExitConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlerexit%20is%201)",
"UseDefaultLanguage": true,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"DisplayName": "System Directory Handler",
"MaxMatches": 8,
"NoInputAction": 2,
"SayCity": false,
"NoInputTargetConversation": "PHTransfer",
"StartDialDelay": 5,
"ObjectId": "b8eabf62-4e2a-458b-a047-5c173f5d7ca8",
"ZeroExitConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlerzeroexit%20is%201)",
"URI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8",
"PlayAllNames": false,
"ZeroTargetHandlerObjectId": "665e0113-d95d-4ced-be91-c4df9e43f984",
"UseCustomGreeting": false,
"ZeroAction": 2,
"Undeletable": true,
"AutoRoute": false,
"VoiceFileURI": "/vmrest/voicefiles/cc6eb264-3302-4f8f-945a-ec03e039fb25.wav",
"SayExtension": true,
"MenuStyle": true,
"EndDialDelay": 4,
"ScopeObjectLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DtmfAccessId": "555",
"VoiceEnabled": false,
"SayDepartment": false,
"DirectoryHandlerStreamFileURI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8/directoryhandlerstreamfiles",
"SearchByFirstName": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6d5ce894e0012058e71",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "System Directory Handler",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6d5ce894e0012058e71",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/"
}
],
"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/DirectoryHandler/5f3ae6d5ce894e0012058e71/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6d5ce894e0012058e71/?hierarchy=[hierarchy]&model_type=device/cuc/DirectoryHandler",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DirectoryHandler/5f3ae6d5ce894e0012058e71/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DirectoryHandler",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6d5ce894e0012058e71"
],
"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": {
"ExitTargetConversation": "PHTransfer",
"VoiceName": "cc6eb264-3302-4f8f-945a-ec03e039fb25.wav",
"SearchScope": 0,
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"NoSelectionTargetConversation": "PHTransfer",
"CreationTime": "2018-02-15T15:05:48Z",
"ExitTargetHandlerObjectId": "8ead92f5-f9ed-412a-a371-e7915e42be95",
"NoInputTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"ZeroTargetConversation": "PHTransfer",
"SearchScopeObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"NoSelectionTargetHandlerObjectId": "4861754a-7855-4044-b899-f08e4cba66f1",
"ExitAction": 2,
"UseStarToExit": true,
"NoSelectionConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlernoselection%20is%201)",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"ObjectId": "b8eabf62-4e2a-458b-a047-5c173f5d7ca8",
"NoInputConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlernoinput%20is%201)",
"UseCallLanguage": true,
"NoSelectionAction": 2,
"SayDepartment": false,
"VoiceNameURI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8/voicename",
"ScopeObjectLocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"Tries": 1,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ExitConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlerexit%20is%201)",
"UseDefaultLanguage": true,
"DisplayName": "System Directory Handler",
"MaxMatches": 8,
"NoInputAction": 2,
"SayCity": false,
"NoInputTargetConversation": "PHTransfer",
"StartDialDelay": 5,
"Language": 1033,
"ZeroExitConversationURI": "/vmrest/conversations?query=(cnvdirectoryhandlerzeroexit%20is%201)",
"URI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8",
"PlayAllNames": false,
"ZeroTargetHandlerObjectId": "665e0113-d95d-4ced-be91-c4df9e43f984",
"UseCustomGreeting": false,
"ZeroAction": 2,
"Undeletable": true,
"AutoRoute": false,
"VoiceFileURI": "/vmrest/voicefiles/cc6eb264-3302-4f8f-945a-ec03e039fb25.wav",
"SayExtension": true,
"MenuStyle": true,
"EndDialDelay": 4,
"ScopeObjectLocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DtmfAccessId": "555",
"VoiceEnabled": false,
"SpeechConfidenceThreshold": 10,
"DirectoryHandlerStreamFileURI": "/vmrest/handlers/directoryhandlers/b8eabf62-4e2a-458b-a047-5c173f5d7ca8/directoryhandlerstreamfiles",
"SearchByFirstName": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/DirectoryHandler. | GET | /api/device/cuc/DirectoryHandler/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/DirectoryHandler as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/DirectoryHandler/[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/DirectoryHandler/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/DirectoryHandler/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/DirectoryHandler/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/DirectoryHandler | 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/DirectoryHandler; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/DirectoryHandler/[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/DirectoryHandler and the JSON format can be used to import instances of device/cuc/DirectoryHandler.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/DirectoryHandler/[pkid] | hierarchy=[hierarchy] | The device/cuc/DirectoryHandler instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/DirectoryHandler/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/DirectoryHandler. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/DirectoryHandler/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |