[Index]
Model ref.: device/cuc/Conversation
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": { "CnvRoutingRuleDirectCall": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination in a call routing rule for a direct call.", "name": "CnvRoutingRuleDirectCall", "title": "Cnv Routing Rule Direct Call" }, "RequiresCallHandler": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether a call handler object is required as input to the conversation.", "name": "RequiresCallHandler", "title": "Requires Call Handler" }, "CnvCallHandlerAfterGreeting": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination for a call, after a greeting is played. This flag applies to \"application\" call handlers, not primary call handlers belonging to a subscriber.", "name": "CnvCallHandlerAfterGreeting", "title": "Cnv Call Handler After Greeting" }, "IsVui": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation is a VUI conversation.", "name": "IsVui", "title": "Is Vui" }, "CnvInterviewHandlerAfterMessage": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination for a call after a caller leaves a message for the interview handler.", "name": "CnvInterviewHandlerAfterMessage", "title": "Cnv Interview Handler After Message" }, "CnvRoutingRuleForwardedCall": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination in a call routing rule for a forwarded call.", "name": "CnvRoutingRuleForwardedCall", "title": "Cnv Routing Rule Forwarded Call" }, "CnvDirectoryHandlerNoInput": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination from a directory handler when the caller does not respond to the name entry prompt.", "name": "CnvDirectoryHandlerNoInput", "title": "Cnv Directory Handler No Input" }, "LanguageCode": { "minItems": 0, "type": "integer", "description": " The language code (LCID) indicating the language of the text in the LocalizedName column.", "name": "LanguageCode", "title": "Language Code" }, "TextName": { "minItems": 0, "type": "string", "description": " Localization key used to lookup the localized name in tbl_LocalizedText. - template parameter [1]", "name": "TextName", "title": "Text Name" }, "TextNameLanguageCode": { "type": "string", "description": "Unique Identifier composed of Name & Language Code", "name": "TextNameLanguageCode", "title": "Text Name / Language Code" }, "CnvSubscriberAfterGreeting": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination for a call, after a subscriber greeting is played.", "name": "CnvSubscriberAfterGreeting", "title": "Cnv Subscriber After Greeting" }, "CnvCallHandlerAfterMessage": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination for a call after a caller leaves a message for the call handler. This flag applies to \"application\" call handlers, not primary call handlers belonging to a subscriber.", "name": "CnvCallHandlerAfterMessage", "title": "Cnv Call Handler After Message" }, "CnvSubscriberMainConv": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be used as a subscriber main conversation.", "name": "CnvSubscriberMainConv", "title": "Cnv Subscriber Main Conv" }, "CnvSubscriberExit": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination when exiting a subscriber conversation.", "name": "CnvSubscriberExit", "title": "Cnv Subscriber Exit" }, "CnvDirectoryHandlerExit": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination from a directory handler when the caller presses * to exit.", "name": "CnvDirectoryHandlerExit", "title": "Cnv Directory Handler Exit" }, "ConversationName": { "minItems": 0, "type": "string", "description": " The name of the conversation that can be used to identify a conversation. A subscriber uses this for message retrieval, sending, and setup; or the target of a call routing rule.", "name": "ConversationName", "title": "Conversation Name" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "LocalizedName": { "minItems": 0, "type": "string", "description": "The localized name of the conversation, which is displayed in the SA. The localized version of the string.", "name": "LocalizedName", "title": "Localized Name" }, "CnvSubscriberAfterMessage": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be the destination for a call after a caller leaves a message for a subscriber.", "name": "CnvSubscriberAfterMessage", "title": "Cnv Subscriber After Message" }, "CnvSubscriberCallerInput": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be assigned to user input keys for a subscriber greeting.", "name": "CnvSubscriberCallerInput", "title": "Cnv Subscriber Caller Input" }, "CnvCallHandlerCallerInput": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be assigned to user input keys for a call handler greeting. This flag applies to \"application\" call handlers, not primary call handlers belonging to a subscriber.", "name": "CnvCallHandlerCallerInput", "title": "Cnv Call Handler Caller Input" }, "CnvDirectoryHandlerNoSelection": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination from a directory handler when the caller enters a name but does not select an item from the resulting match list, or when the Play All Names is enabled and the caller does not respond to prompts.", "name": "CnvDirectoryHandlerNoSelection", "title": "Cnv Directory Handler No Selection" }, "RequiresSubscriber": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether a subscriber object is required as input to the conversation.", "name": "RequiresSubscriber", "title": "Requires Subscriber" }, "RequiresDirectoryHandler": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether a directory handler object is required as input to the conversation.", "name": "RequiresDirectoryHandler", "title": "Requires Directory Handler" }, "CnvDirectoryHandlerZeroExit": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the conversation can be a destination from a directory handler when the caller presses the zero (\"0\") key.", "name": "CnvDirectoryHandlerZeroExit", "title": "Cnv Directory Handler Zero Exit" }, "RequiresInterviewHandler": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether a interview handler object is required as input to the conversation.", "name": "RequiresInterviewHandler", "title": "Requires Interview Handler" } }, "schema_version": "12.5" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/Conversation/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/Conversation/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/Conversation/[pkid1]", "/api/v0/device/cuc/Conversation/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/Conversation/?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/Conversation |
|
{"hrefs": ["/api/device/cuc/Conversation/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/Conversation |
|
{"hrefs": ["/api/device/cuc/Conversation/[pkid1]", "/api/device/cuc/Conversation/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/Conversation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/Conversation/export/ |
|
{ "hrefs":["/api/device/cuc/Conversation/[pkid1]", "/api/device/cuc/Conversation/[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/Conversation and the JSON format can be used to import instances of device/cuc/Conversation.
GET http://[host-proxy]/api/device/cuc/Conversation/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/Conversation | POST | /api/device/cuc/Conversation/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/Conversation/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/Conversation/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/Conversation/ |
|
The device/cuc/Conversation schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/Conversation instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "TextName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/Conversation/?skip=0&limit=3&order_by=TextName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 192 }, "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/Conversation/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/Conversation", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Conversation/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/Conversation/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/Conversation/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/Conversation/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/Conversation/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Conversation/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Conversation/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Conversation", "model_specific_actions": [ "list", "get", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "help", "move" ], "summary_attrs": [ { "name": "TextName", "title": "Text Name" }, { "name": "LanguageCode", "title": "Language Code" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "resources": [ { "pkid": "5dcd30d38192d40018f77b22", "meta": { "tags": [], "cached": true, "title": "Conversation.Name.AD", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd3073e186e30018ebc837", "href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837" } ], "self": [ { "pkid": "5dcd30d38192d40018f77b22", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/" } ], "parent": [ { "pkid": "5dcd2d8b9d77dd0018b0ebe6", "href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd30d38192d40018f77b22/?model_type=device/cuc/Conversation", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Conversation", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd2d8b9d77dd0018b0ebe6", "5dcd30d38192d40018f77b22" ], "summary_attrs": [ { "name": "TextName", "title": "Text Name" }, { "name": "LanguageCode", "title": "Language Code" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "CnvRoutingRuleDirectCall": false, "RequiresCallHandler": false, "CnvCallHandlerAfterGreeting": false, "hierarchy": "5dcd2d8b9d77dd0018b0ebe6", "IsVui": false, "CnvInterviewHandlerAfterMessage": false, "hierarchy_friendly_name": "Overton (Customer)", "CnvRoutingRuleForwardedCall": false, "CnvDirectoryHandlerNoInput": false, "hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton", "LanguageCode": 1033, "TextName": "Conversation.Name.AD", "TextNameLanguageCode": "Conversation.Name.AD|1033", "CnvSubscriberAfterGreeting": false, "CnvCallHandlerAfterMessage": false, "CnvSubscriberMainConv": false, "summary_device": "Dedicated CUCxn, 10.120.9.246, 8443, hcs.CS-P.CS-NB.Overton", "CnvSubscriberExit": false, "CnvDirectoryHandlerExit": false, "ConversationName": "AD", "URI": "/conversations?query=(TextName is Conversation.Name.AD)", "LocalizedName": "Alpha Directory Conversation", "CnvSubscriberAfterMessage": false, "CnvSubscriberCallerInput": false, "CnvCallHandlerCallerInput": false, "CnvDirectoryHandlerNoSelection": false, "RequiresSubscriber": false, "RequiresDirectoryHandler": true, "CnvDirectoryHandlerZeroExit": false, "RequiresInterviewHandler": false } }, { "pkid": "5dcd187d56b5de0018914934", "meta": { "tags": [], "cached": true, "title": "Conversation.Name.AD", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd18514544b7001860529a", "href": "/api/v0/data/UnityConnection/5dcd18514544b7001860529a" } ], "self": [ { "pkid": "5dcd187d56b5de0018914934", "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/" } ], "parent": [ { "pkid": "5dcd1812e186e30018eb7023", "href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd187d56b5de0018914934/?model_type=device/cuc/Conversation", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/Conversation/5dcd187d56b5de0018914934/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/Conversation", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd1812e186e30018eb7023", "5dcd187d56b5de0018914934" ], "summary_attrs": [ { "name": "TextName", "title": "Text Name" }, { "name": "LanguageCode", "title": "Language Code" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "CnvRoutingRuleDirectCall": false, "RequiresCallHandler": false, "CnvCallHandlerAfterGreeting": false, "hierarchy": "5dcd1812e186e30018eb7023", "IsVui": false, "CnvInterviewHandlerAfterMessage": false, "hierarchy_friendly_name": "AAAGlobal (Customer)", "CnvRoutingRuleForwardedCall": false, "CnvDirectoryHandlerNoInput": false, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal", "LanguageCode": 1033, "TextName": "Conversation.Name.AD", "TextNameLanguageCode": "Conversation.Name.AD|1033", "CnvSubscriberAfterGreeting": false, "CnvCallHandlerAfterMessage": false, "CnvSubscriberMainConv": false, "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal", "CnvSubscriberExit": false, "CnvDirectoryHandlerExit": false, "ConversationName": "AD", "URI": "/conversations?query=(TextName is Conversation.Name.AD)", "LocalizedName": "Alpha Directory Conversation", "CnvSubscriberAfterMessage": false, "CnvSubscriberCallerInput": false, "CnvCallHandlerCallerInput": false, "CnvDirectoryHandlerNoSelection": false, "RequiresSubscriber": false, "RequiresDirectoryHandler": true, "CnvDirectoryHandlerZeroExit": false, "RequiresInterviewHandler": false } }, { "pkid": "5dcd18b38192d40018f7185e", "meta": { "tags": [], "cached": true, "title": "Conversation.Name.AD", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd18824544b70018605580", "href": "/api/v0/data/UnityConnection/5dcd18824544b70018605580" } ], "self": [ { "pkid": "5dcd18b38192d40018f7185e", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/" } ], "parent": [ { "pkid": "5dcd1812e186e30018eb7023", "href": "/api/data/HierarchyNode/5dcd1812e186e30018eb7023" } ], "foreign_key": [] }, "actions": [ { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd18b38192d40018f7185e/?model_type=device/cuc/Conversation", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/Conversation/5dcd18b38192d40018f7185e/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/Conversation", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd1812e186e30018eb7023", "5dcd18b38192d40018f7185e" ], "summary_attrs": [ { "name": "TextName", "title": "Text Name" }, { "name": "LanguageCode", "title": "Language Code" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "CnvRoutingRuleDirectCall": false, "RequiresCallHandler": false, "CnvCallHandlerAfterGreeting": false, "hierarchy": "5dcd1812e186e30018eb7023", "IsVui": false, "CnvInterviewHandlerAfterMessage": false, "hierarchy_friendly_name": "AAAGlobal (Customer)", "CnvRoutingRuleForwardedCall": false, "CnvDirectoryHandlerNoInput": false, "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal", "LanguageCode": 1033, "TextName": "Conversation.Name.AD", "TextNameLanguageCode": "Conversation.Name.AD|1033", "CnvSubscriberAfterGreeting": false, "CnvCallHandlerAfterMessage": false, "CnvSubscriberMainConv": false, "summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal", "CnvSubscriberExit": false, "CnvDirectoryHandlerExit": false, "ConversationName": "AD", "URI": "/conversations?query=(TextName is Conversation.Name.AD)", "LocalizedName": "Alpha Directory Conversation", "CnvSubscriberAfterMessage": false, "CnvSubscriberCallerInput": false, "CnvCallHandlerCallerInput": false, "CnvDirectoryHandlerNoSelection": false, "RequiresSubscriber": false, "RequiresDirectoryHandler": true, "CnvDirectoryHandlerZeroExit": false, "RequiresInterviewHandler": false } } ] }
(Show the first instance)
{ "pkid": "5dcd30d38192d40018f77b22", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "Conversation.Name.AD", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5dcd2d8b9d77dd0018b0ebe6", "href": "/api/data/HierarchyNode/5dcd2d8b9d77dd0018b0ebe6" } ], "self": [ { "pkid": "5dcd30d38192d40018f77b22", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5dcd3073e186e30018ebc837", "href": "/api/v0/data/UnityConnection/5dcd3073e186e30018ebc837" } ], "children": [] }, "actions": [ { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5dcd30d38192d40018f77b22/?hierarchy=[hierarchy]&model_type=device/cuc/Conversation", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/Conversation/5dcd30d38192d40018f77b22/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/Conversation", "path": [ "6t0ggef2c0deab00hb595101", "5dcc7ff74544b7001862482f", "5dcd17c256b5de00189138f9", "5dcd180233fc9b00189005b2", "5dcd2d8b9d77dd0018b0ebe6", "5dcd30d38192d40018f77b22" ], "summary_attrs": [ { "name": "TextName", "title": "Text Name" }, { "name": "LanguageCode", "title": "Language Code" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" }, { "allow_filtering": false, "name": "summary_device", "title": "Device" } ], "api_version": "19.3.1", "tagged_versions": [] }, "data": { "CnvRoutingRuleDirectCall": false, "RequiresCallHandler": false, "CnvCallHandlerAfterGreeting": false, "IsVui": false, "CnvInterviewHandlerAfterMessage": false, "CnvRoutingRuleForwardedCall": false, "CnvDirectoryHandlerNoInput": false, "LanguageCode": 1033, "TextName": "Conversation.Name.AD", "TextNameLanguageCode": "Conversation.Name.AD|1033", "CnvSubscriberAfterGreeting": false, "CnvCallHandlerAfterMessage": false, "CnvSubscriberMainConv": false, "CnvSubscriberExit": false, "CnvDirectoryHandlerExit": false, "ConversationName": "AD", "URI": "/conversations?query=(TextName is Conversation.Name.AD)", "LocalizedName": "Alpha Directory Conversation", "CnvSubscriberAfterMessage": false, "CnvSubscriberCallerInput": false, "CnvCallHandlerCallerInput": false, "CnvDirectoryHandlerNoSelection": false, "RequiresSubscriber": false, "RequiresDirectoryHandler": true, "CnvDirectoryHandlerZeroExit": false, "RequiresInterviewHandler": false } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/Conversation. | GET | /api/device/cuc/Conversation/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/Conversation as HTML |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/Conversation/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/Conversation/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/Conversation | 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/Conversation; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/Conversation/[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/Conversation and the JSON format can be used to import instances of device/cuc/Conversation.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/Conversation/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/Conversation instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/Conversation/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/Conversation. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/Conversation/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |