[Index]
Model ref.: device/cuc/TemplateTransferOption
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": {
"TransferHoldingMode": {
"minItems": 0,
"title": "Transfer Holding Mode",
"type": "integer",
"description": " The action Cisco Unity Connection will take when the extension is busy.",
"name": "TransferHoldingMode"
},
"TransferOptionType": {
"description": " The type of transfer option, e.g. \"Standard,\" \"Off Hours,\" or \"Alternate.\" - template parameter [2]",
"title": "Transfer Option Type",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "TransferOptionType"
},
"PhoneSystemURI": {
"name": "PhoneSystemURI",
"title": "Phone System URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferConfirm": {
"minItems": 0,
"title": "Transfer Confirm",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection prompts the subscriber to accept or refuse a call (\"Press 1 to take the call or 2 and I'll take a message\"). If the call is accepted, it is transferred to the subscriber phone. If the call is refused, Cisco Unity Connection plays the applicable subscriber greeting. \n",
"name": "TransferConfirm"
},
"TransferRings": {
"minItems": 0,
"title": "Transfer Rings",
"type": "integer",
"description": " The number of times the extension rings before Cisco Unity Connection considers it a \"ring no answer\" and plays the subscriber or handler greeting.",
"name": "TransferRings"
},
"TransferScreening": {
"minItems": 0,
"title": "Transfer Screening",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will prompt callers to say their names. When the phone is answered, the subscriber hears \"Call from...\" before Cisco Unity Connection transfers the call.",
"name": "TransferScreening"
},
"RnaAction": {
"minItems": 0,
"title": "Rna Action",
"type": "integer",
"description": " The action Cisco Unity Connection takes for a \"Ring-No-Answer\" (RNA) condition. Cisco Unity Connection will either transfer the call to the appropriate greeting or releases the call to the phone system.",
"name": "RnaAction"
},
"PersonalCallTransfer": {
"minItems": 0,
"title": "Personal Call Transfer",
"type": "boolean",
"description": " A flag indicating whether or not Personal Call Transfer Rules are used for the specific Transfer Option.",
"name": "PersonalCallTransfer"
},
"Extension": {
"minItems": 0,
"title": "Extension",
"type": "string",
"description": " The extension (phone number) to transfer to.",
"name": "Extension"
},
"Enabled": {
"title": "Enabled",
"type": "boolean",
"description": "If TimeExpires is set, this field is ignored.",
"name": "Enabled"
},
"CallhandlerURI": {
"name": "CallhandlerURI",
"title": "Callhandler URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"URI": {
"name": "URI",
"title": "URI",
"minItems": 0,
"format": "uri",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"UsePrimaryExtension": {
"minItems": 0,
"title": "Use Primary Extension",
"type": "boolean",
"description": "If extension is null this will be set to 1 (true) to indicate we are using instead the DtmfAccessId for the owning handler or subscriber.",
"name": "UsePrimaryExtension"
},
"TransferAnnounce": {
"minItems": 0,
"title": "Transfer Announce",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection plays \"transferring call\" when the subscriber answers the phone. ",
"name": "TransferAnnounce"
},
"Action": {
"minItems": 0,
"title": "Action",
"type": "integer",
"description": " A flag indicating whether Cisco Unity Connection transfers the call to the call handler greeting or attempts to transfer the call to an extension.",
"name": "Action"
},
"TransferType": {
"minItems": 0,
"title": "Transfer Type",
"type": "integer",
"description": " The type of call transfer Cisco Unity Connection will perform - supervised or unsupervised (also referred to as \"Release to Switch\" transfer).",
"name": "TransferType"
},
"CallHandlerObjectId": {
"description": " The unique identifier of the CallHandler object to which this transfer rule belongs. - template parameter [1]",
"name": "CallHandlerObjectId",
"format": "uri",
"minItems": 0,
"required": true,
"choices": [],
"target_attr": "ObjectId",
"target_model_type": "device/cuc/CallhandlerTemplate",
"title": "Call Handler Object Id",
"type": [
"string"
],
"target": "/api/device/cuc/CallhandlerTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TransferDtDetect": {
"minItems": 0,
"title": "Transfer Dt Detect",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will check for dialtone before attempting to transfer the call.",
"name": "TransferDtDetect"
},
"PlayTransferPrompt": {
"minItems": 0,
"title": "Play Transfer Prompt",
"type": "boolean",
"description": " A flag indicating whether the \"Wait while I transfer your call\" prompt should be played prior to transferring a call. \n\n",
"name": "PlayTransferPrompt"
},
"TransferIntroduce": {
"minItems": 0,
"title": "Transfer Introduce",
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection will say \"call for <recorded name of the call handler>\" when the subscriber answers the phone. ",
"name": "TransferIntroduce"
},
"MediaSwitchObjectId": {
"minItems": 0,
"title": "Media Switch Object Id",
"type": "string",
"description": " The unique identifier of the MediaSwitch object that Cisco Unity Connection uses for transferring the call to the subscriber phone.",
"name": "MediaSwitchObjectId"
},
"TimeExpires": {
"minItems": 0,
"title": "Time Expires",
"type": "string",
"description": " The date and time when this transfer option expires. If the transfer rule is enabled, the value is NULL or a date in the future. If the transfer rule is disable, the value is a past date.",
"name": "TimeExpires"
}
},
"schema_version": "12.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/TemplateTransferOption/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/TemplateTransferOption/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/TemplateTransferOption/[pkid1]", "/api/v0/device/cuc/TemplateTransferOption/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/TemplateTransferOption/?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/TemplateTransferOption |
|
{"hrefs": ["/api/device/cuc/TemplateTransferOption/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/TemplateTransferOption |
|
{"hrefs": ["/api/device/cuc/TemplateTransferOption/[pkid1]", "/api/device/cuc/TemplateTransferOption/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/TemplateTransferOption; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/TemplateTransferOption/export/ |
|
{ "hrefs":["/api/device/cuc/TemplateTransferOption/[pkid1]", "/api/device/cuc/TemplateTransferOption/[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/TemplateTransferOption and the JSON format can be used to import instances of device/cuc/TemplateTransferOption.
GET http://[host-proxy]/api/device/cuc/TemplateTransferOption/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/TemplateTransferOption | POST | /api/device/cuc/TemplateTransferOption/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/TemplateTransferOption/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/TemplateTransferOption/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/TemplateTransferOption/ |
|
The device/cuc/TemplateTransferOption schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/TemplateTransferOption instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "URI",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/TemplateTransferOption/?skip=0&limit=3&order_by=URI&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 9
},
"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/TemplateTransferOption/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/TemplateTransferOption",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateTransferOption/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/TemplateTransferOption/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/TemplateTransferOption/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/TemplateTransferOption/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/TemplateTransferOption/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateTransferOption/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateTransferOption/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateTransferOption",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": "5e8a791bce894e001671f38e",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a7908ce894e001671eeef",
"href": "/api/v0/data/UnityConnection/5e8a7908ce894e001671eeef"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a791bce894e001671f38e",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a791bce894e001671f38e/?model_type=device/cuc/TemplateTransferOption",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateTransferOption",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a791bce894e001671f38e"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"TransferHoldingMode": 0,
"TransferOptionType": "Alternate",
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TransferConfirm": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"PersonalCallTransfer": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/162f2841-d97d-4b61-926c-208ce15fb8bf",
"Enabled": false,
"URI": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 0,
"TransferType": 0,
"CallHandlerObjectId": "162f2841-d97d-4b61-926c-208ce15fb8bf",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TimeExpires": "1972-01-01 02:00:00.0"
}
},
{
"pkid": "5e8a7958ce894e001672019e",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5e8a793ace894e001671faed",
"href": "/api/v0/data/UnityConnection/5e8a793ace894e001671faed"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a7958ce894e001672019e",
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a7958ce894e001672019e/?model_type=device/cuc/TemplateTransferOption",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/TemplateTransferOption/5e8a7958ce894e001672019e/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/TemplateTransferOption",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a7958ce894e001672019e"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"TransferHoldingMode": 0,
"TransferOptionType": "Alternate",
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TransferConfirm": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"TransferRings": 4,
"TransferScreening": false,
"RnaAction": 1,
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"PersonalCallTransfer": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/162f2841-d97d-4b61-926c-208ce15fb8bf",
"Enabled": false,
"URI": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 0,
"TransferType": 0,
"CallHandlerObjectId": "162f2841-d97d-4b61-926c-208ce15fb8bf",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TimeExpires": "1972-01-01 02:00:00.0"
}
},
{
"pkid": "5e8a791bce894e001671f392",
"meta": {
"tags": [],
"cached": true,
"title": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Off Hours",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5e8a7908ce894e001671eeef",
"href": "/api/v0/data/UnityConnection/5e8a7908ce894e001671eeef"
}
],
"self": [
{
"pkid": "5e8a791bce894e001671f392",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/"
}
],
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a791bce894e001671f392/?model_type=device/cuc/TemplateTransferOption",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f392/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateTransferOption",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a791bce894e001671f392"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"TransferHoldingMode": 0,
"hierarchy": "5e8a78cdce894e001671e1fb",
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TransferConfirm": false,
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal",
"TransferRings": 4,
"TransferOptionType": "Off Hours",
"TransferScreening": false,
"RnaAction": 1,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"PersonalCallTransfer": false,
"Enabled": false,
"CallhandlerURI": "/vmrest/handlers/callhandlers/162f2841-d97d-4b61-926c-208ce15fb8bf",
"URI": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Off Hours",
"UsePrimaryExtension": true,
"TransferAnnounce": false,
"Action": 0,
"TransferType": 0,
"CallHandlerObjectId": "162f2841-d97d-4b61-926c-208ce15fb8bf",
"TransferDtDetect": false,
"PlayTransferPrompt": true,
"TransferIntroduce": false,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TimeExpires": "1972-01-01 02:00:00.0"
}
}
]
}
(Show the first instance)
{
"pkid": "5e8a791bce894e001671f38e",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"business_key": {},
"schema_version": "12.5",
"references": {
"parent": [
{
"pkid": "5e8a78cdce894e001671e1fb",
"href": "/api/data/HierarchyNode/5e8a78cdce894e001671e1fb"
}
],
"self": [
{
"pkid": "5e8a791bce894e001671f38e",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/"
}
],
"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/TemplateTransferOption/5e8a791bce894e001671f38e/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a791bce894e001671f38e/?hierarchy=[hierarchy]&model_type=device/cuc/TemplateTransferOption",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/TemplateTransferOption/5e8a791bce894e001671f38e/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/TemplateTransferOption",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839364ce894e0015b96604",
"5e8a787fce894e001671ce1b",
"5e8a78bece894e001671de53",
"5e8a78cdce894e001671e1fb",
"5e8a791bce894e001671f38e"
],
"summary_attrs": [
{
"name": "URI",
"title": "URI"
},
{
"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": {
"TransferHoldingMode": 0,
"PersonalCallTransfer": false,
"CallHandlerObjectId": "162f2841-d97d-4b61-926c-208ce15fb8bf",
"TransferOptionType": "Alternate",
"Enabled": false,
"TransferDtDetect": false,
"TransferRings": 4,
"CallhandlerURI": "/vmrest/handlers/callhandlers/162f2841-d97d-4b61-926c-208ce15fb8bf",
"URI": "/vmrest/callhandlertemplates/162f2841-d97d-4b61-926c-208ce15fb8bf/templatetransferoptions/Alternate",
"UsePrimaryExtension": true,
"PhoneSystemURI": "/vmrest/phonesystems/eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TransferScreening": false,
"TransferAnnounce": false,
"TimeExpires": "1972-01-01 02:00:00.0",
"Action": 0,
"TransferIntroduce": false,
"RnaAction": 1,
"PlayTransferPrompt": true,
"MediaSwitchObjectId": "eeb41ed1-9672-4f34-a040-b76e05ff57b5",
"TransferConfirm": false,
"TransferType": 0
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/TemplateTransferOption. | GET | /api/device/cuc/TemplateTransferOption/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/TemplateTransferOption as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/TemplateTransferOption/[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/TemplateTransferOption/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/TemplateTransferOption/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/TemplateTransferOption | 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/TemplateTransferOption; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/TemplateTransferOption/[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/TemplateTransferOption and the JSON format can be used to import instances of device/cuc/TemplateTransferOption.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/TemplateTransferOption/[pkid]/ | hierarchy=[hierarchy] | The device/cuc/TemplateTransferOption instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/TemplateTransferOption/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/TemplateTransferOption. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/TemplateTransferOption/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |