[Index]
Model ref.: device/cuc/DistributionList
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "VoiceName": { "minItems": 0, "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" }, "PartitionURI": { "name": "PartitionURI", "format": "uri", "minItems": 0, "title": "Partition URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "DistributionListMembersURI": { "name": "DistributionListMembersURI", "format": "uri", "minItems": 0, "title": "Distribution List Members URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "CreationTime": { "minItems": 0, "type": "string", "description": " The date and time the system distribution list was created.", "name": "CreationTime", "title": "Creation Time" }, "DisplayName": { "minItems": 0, "type": "string", "description": " The unique text name of the system distribution list to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.", "name": "DisplayName", "title": "Display Name" }, "PartitionObjectId": { "minItems": 0, "type": "string", "description": " The unique identifier of the Partition to which the DistributionList is assigned.", "name": "PartitionObjectId", "title": "Partition Object Id" }, "DtmfName": { "minItems": 0, "type": "string", "description": " The series of digits corresponding to the numeric keypad mapping on a standard touchtone phone representing the display name of the system distribution list. These digits are used for searching the distribution list by name via the phone.", "name": "DtmfName", "title": "Dtmf Name" }, "VoiceNameURI": { "name": "VoiceNameURI", "format": "uri", "minItems": 0, "title": "Voice Name URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "LocationObjectId": { "minItems": 0, "type": "string", "description": " The unique identifier of the LocationVMS object to which this system distribution list belongs.", "name": "LocationObjectId", "title": "Location Object Id" }, "AllowContacts": { "minItems": 0, "type": "boolean", "description": "A flag indicating whether contacts (system, VPIM, virtual) are allowed to be members of this Distribution List. Purpose of this flag is to enable administrators to create a Distribution List whose members are Unity users only. A flag indicating whether contacts (system, VPIM, virtual) are allowed to be members of this Distribution List. Purpose of this flag is to enable administrators to create a Distribution List whose members are Unity users only.", "name": "AllowContacts", "title": "Allow Contacts" }, "ObjectId": { "description": " The primary key for this table. A globally unique, system-generated identifier for a DistributionList object. - template parameter [1]", "title": "Object Id", "minItems": 0, "readonly": true, "type": "string", "name": "ObjectId" }, "URI": { "name": "URI", "format": "uri", "minItems": 0, "title": "URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "AllowForeignMessage": { "minItems": 0, "type": "boolean", "description": " Controls if we allow foreign message systems to send to this particular distribution list. Only valid if the list is for subscribers only (i.e. does not allow contacts)", "name": "AllowForeignMessage", "title": "Allow Foreign Message" }, "TenantObjectId": { "minItems": 0, "type": "string", "description": " Unique key for tbl_Tenant.", "name": "TenantObjectId", "title": "Tenant Object Id" }, "Undeletable": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether this distribution list 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" }, "AlternateNamesURI": { "type": "string", "description": "The URI to get the alternate names of the distribution list.", "name": "AlternateNamesURI", "title": "Alternate Names URI" }, "VoiceFileURI": { "name": "VoiceFileURI", "format": "uri", "minItems": 0, "title": "Voice File URI", "choices": [], "type": "string", "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "Alias": { "minItems": 0, "type": "string", "description": " The unique text name for either a user, distribution list, or personal group.", "name": "Alias", "title": "Alias" }, "IsPublic": { "minItems": 0, "type": "boolean", "description": " A flag indicating whether the system distribution list is addressable by all subscribers on all VMSes throughout the Unity Organization.", "name": "IsPublic", "title": "Is Public" }, "DtmfAccessId": { "minItems": 0, "type": "string", "description": "The DTMF access id (i.e., extension) for the distribution list. This column shadows the object's optional dtmfaccessid from tbl_DtmfAccessId. It was added to speed up queries.", "name": "DtmfAccessId", "title": "Dtmf Access Id" }, "AltName": { "minItems": 0, "type": "string", "description": " The alternate spelling of the distributionlist name in an internationally recognizable format (i.e., ASCII only characters) used for TUI client name lookup and message addressing.", "name": "AltName", "title": "Alt 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/DistributionList/add/ |
|
The GUI Add form of device/cuc/DistributionList 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/DistributionList | 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/DistributionList/ | hierarchy=[hierarchy] | {"hrefs":["/api/device/cuc/DistributionList/[pkid1]", "/api/device/cuc/DistributionList/[pkid2]", ...]} |
GET http://[host-proxy]/api/device/cuc/DistributionList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/device/cuc/DistributionList/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/device/cuc/DistributionList/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/DistributionList/[pkid1]", "/api/v0/device/cuc/DistributionList/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/DistributionList/?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/DistributionList |
|
{"hrefs": ["/api/device/cuc/DistributionList/[pkid]"]} |
Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/DistributionList |
|
{"hrefs": ["/api/device/cuc/DistributionList/[pkid1]", "/api/device/cuc/DistributionList/[pkid2]",...]} |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/DistributionList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/DistributionList/export/ |
|
{ "hrefs":["/api/device/cuc/DistributionList/[pkid1]", "/api/device/cuc/DistributionList/[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/DistributionList and the JSON format can be used to import instances of device/cuc/DistributionList.
GET http://[host-proxy]/api/device/cuc/DistributionList/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/DistributionList | POST | /api/device/cuc/DistributionList/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/DistributionList/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/DistributionList/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/device/cuc/DistributionList/ |
|
The device/cuc/DistributionList schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/DistributionList instances)
{ "operations": [ "move" ], "pagination": { "direction": "asc", "order_by": "DisplayName", "maximum_limit": 2000, "skip": 0, "current": "/api/device/cuc/DistributionList/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 3 }, "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/DistributionList/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/DistributionList/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "bulk_update_form": { "support_async": false, "class": "update", "href": "/api/device/cuc/DistributionList/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/DistributionList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/DistributionList/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/DistributionList/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/device/cuc/DistributionList/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/device/cuc/DistributionList/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "list": { "support_async": false, "class": "list", "href": "/api/device/cuc/DistributionList/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/DistributionList/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/DistributionList/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/DistributionList", "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": "5f3ae6d8ce894e0012058eb5", "meta": { "tags": [], "cached": true, "title": "All Voice Mail Users", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae6d8ce894e0012058eb5", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/clone/?schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae6d8ce894e0012058eb5/?model_type=device/cuc/DistributionList", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/help", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/purge/", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/DistributionList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae6d8ce894e0012058eb5" ], "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": { "VoiceName": "3af12d95-94f2-4da2-bbf6-f25a71d5eeb4.wav", "PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b", "hierarchy": "5f3ae552ce894e00120537fa", "DistributionListMembersURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08/distributionlistmembers", "CreationTime": "2018-02-15T15:05:43Z", "DisplayName": "All Voice Mail Users", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b", "DtmfName": "2558642362458737", "VoiceNameURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08/voicename", "LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "AllowContacts": false, "ObjectId": "074b7d87-d59e-4a18-acd6-23be0aa73d08", "URI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08", "Alias": "allvoicemailusers", "Undeletable": true, "AlternateNamesURI": "/vmrest/alternatenames?query=(DistributionListObjectId%20is%20074b7d87-d59e-4a18-acd6-23be0aa73d08)", "VoiceFileURI": "/vmrest/voicefiles/3af12d95-94f2-4da2-bbf6-f25a71d5eeb4.wav", "AllowForeignMessage": false, "IsPublic": true, "DtmfAccessId": "99991", "LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2" } }, { "pkid": "5f3ae6d9ce894e0012058f38", "meta": { "tags": [], "cached": true, "title": "All Voicemail Enabled Contacts", "business_key": {}, "schema_version": "", "summary": "false", "references": { "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "self": [ { "pkid": "5f3ae6d9ce894e0012058f38", "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "clone": { "support_async": false, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/clone/?schema=&schema_rules=true", "title": "Clone", "class": "clone", "method": "GET" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae6d9ce894e0012058f38/?model_type=device/cuc/DistributionList", "method": "POST", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/help", "title": "Help", "class": "help", "method": "GET" } }, { "purge": { "support_async": false, "href": "/api/device/cuc/DistributionList/5f3ae6d9ce894e0012058f38/purge/", "title": "Purge", "class": "purge", "method": "POST" } } ], "model_type": "device/cuc/DistributionList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae6d9ce894e0012058f38" ], "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": { "VoiceName": "c0cc096e-1b16-4ee7-a72c-923aa5288ba4.wav", "PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b", "hierarchy": "5f3ae552ce894e00120537fa", "DistributionListMembersURI": "/vmrest/distributionlists/73bf027a-1975-44f3-9311-9fa534d8ddfa/distributionlistmembers", "CreationTime": "2018-02-15T15:05:44Z", "DisplayName": "All Voicemail Enabled Contacts", "hierarchy_friendly_name": "AB_Group (Customer)", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b", "DtmfName": "2558642362453622", "VoiceNameURI": "/vmrest/distributionlists/73bf027a-1975-44f3-9311-9fa534d8ddfa/voicename", "LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "AllowContacts": true, "ObjectId": "73bf027a-1975-44f3-9311-9fa534d8ddfa", "URI": "/vmrest/distributionlists/73bf027a-1975-44f3-9311-9fa534d8ddfa", "Alias": "allvoicemailenabledcontacts", "Undeletable": true, "AlternateNamesURI": "/vmrest/alternatenames?query=(DistributionListObjectId%20is%2073bf027a-1975-44f3-9311-9fa534d8ddfa)", "VoiceFileURI": "/vmrest/voicefiles/c0cc096e-1b16-4ee7-a72c-923aa5288ba4.wav", "AllowForeignMessage": false, "IsPublic": true, "DtmfAccessId": "99992", "LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2" } }, { "pkid": "5f3ae6d7ce894e0012058e87", "meta": { "tags": [], "cached": true, "title": "Undeliverable Messages", "business_key": {}, "schema_version": "", "summary": "false", "references": { "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "5f3ae6d7ce894e0012058e87", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/" } ], "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/", "class": "delete", "title": "Delete" } }, { "clone": { "support_async": false, "method": "GET", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/clone/?schema=&schema_rules=true", "class": "clone", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "method": "POST", "href": "/api/tool/DataMove/5f3ae6d7ce894e0012058e87/?model_type=device/cuc/DistributionList", "class": "move", "view": "/api/tool/DataMove/" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/help", "class": "help", "title": "Help" } }, { "purge": { "support_async": false, "method": "POST", "href": "/api/device/cuc/DistributionList/5f3ae6d7ce894e0012058e87/purge/", "class": "purge", "title": "Purge" } } ], "model_type": "device/cuc/DistributionList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae6d7ce894e0012058e87" ], "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": { "VoiceName": "61be9a38-b6d1-46c1-be47-abe3009c6028.wav", "PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b", "DistributionListMembersURI": "/vmrest/distributionlists/58dc494b-afca-4fdb-aaf1-b0a6d95c3740/distributionlistmembers", "CreationTime": "2018-02-15T15:05:43Z", "DisplayName": "Undeliverable Messages", "hierarchy_friendly_name": "AB_Group (Customer)", "hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group", "PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b", "DtmfName": "8633548372253637", "VoiceNameURI": "/vmrest/distributionlists/58dc494b-afca-4fdb-aaf1-b0a6d95c3740/voicename", "LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group", "AllowContacts": false, "ObjectId": "58dc494b-afca-4fdb-aaf1-b0a6d95c3740", "URI": "/vmrest/distributionlists/58dc494b-afca-4fdb-aaf1-b0a6d95c3740", "AllowForeignMessage": false, "Undeletable": true, "AlternateNamesURI": "/vmrest/alternatenames?query=(DistributionListObjectId%20is%2058dc494b-afca-4fdb-aaf1-b0a6d95c3740)", "VoiceFileURI": "/vmrest/voicefiles/61be9a38-b6d1-46c1-be47-abe3009c6028.wav", "Alias": "undeliverablemessages", "IsPublic": true, "LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2" } } ] }
(Show the first instance)
{ "pkid": "5f3ae6d8ce894e0012058eb5", "meta": { "tags": [], "cached": true, "cache_control_policy": "cache_then_device", "title": "All Voice Mail Users", "business_key": {}, "schema_version": "11.5", "references": { "parent": [ { "pkid": "5f3ae552ce894e00120537fa", "href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa" } ], "self": [ { "pkid": "5f3ae6d8ce894e0012058eb5", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/" } ], "foreign_key": [], "owner": [ { "pkid": "" } ], "device": [ { "pkid": "5f3ae59cce894e00120554b1", "href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "clone": { "support_async": false, "class": "clone", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "method": "GET", "title": "Clone" } }, { "move": { "title": "Move", "support_async": true, "class": "move", "href": "/api/tool/DataMove/5f3ae6d8ce894e0012058eb5/?hierarchy=[hierarchy]&model_type=device/cuc/DistributionList", "method": "POST", "view": "/api/tool/DataMove/?auth_token=[authtoken] } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "purge": { "support_async": false, "class": "purge", "href": "/api/device/cuc/DistributionList/5f3ae6d8ce894e0012058eb5/purge/?hierarchy=[hierarchy]", "method": "POST", "title": "Purge" } } ], "model_type": "device/cuc/DistributionList", "path": [ "6t0ggef2c0deab00hb595101", "5df35e48ce894e0012b345a1", "5f3ae1fcce894e001204e0ed", "5f3ae256ce894e001204f7db", "5f3ae552ce894e00120537fa", "5f3ae6d8ce894e0012058eb5" ], "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": { "PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b", "VoiceName": "3af12d95-94f2-4da2-bbf6-f25a71d5eeb4.wav", "PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b", "ObjectId": "074b7d87-d59e-4a18-acd6-23be0aa73d08", "AllowContacts": false, "DtmfName": "2558642362458737", "DistributionListMembersURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08/distributionlistmembers", "IsPublic": true, "CreationTime": "2018-02-15T15:05:43Z", "URI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08", "VoiceNameURI": "/vmrest/distributionlists/074b7d87-d59e-4a18-acd6-23be0aa73d08/voicename", "DtmfAccessId": "99991", "AllowForeignMessage": false, "Alias": "allvoicemailusers", "LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2", "VoiceFileURI": "/vmrest/voicefiles/3af12d95-94f2-4da2-bbf6-f25a71d5eeb4.wav", "DisplayName": "All Voice Mail Users", "Undeletable": true, "AlternateNamesURI": "/vmrest/alternatenames?query=(DistributionListObjectId%20is%20074b7d87-d59e-4a18-acd6-23be0aa73d08)", "LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for device/cuc/DistributionList. | GET | /api/device/cuc/DistributionList/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/DistributionList as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/device/cuc/DistributionList/[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/DistributionList/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/DistributionList/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/DistributionList/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/DistributionList | 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/DistributionList; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/DistributionList/[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/DistributionList and the JSON format can be used to import instances of device/cuc/DistributionList.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/device/cuc/DistributionList/[pkid] | hierarchy=[hierarchy] | The device/cuc/DistributionList instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/device/cuc/DistributionList/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/DistributionList. |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Purge | POST | /api/device/cuc/DistributionList/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |