[Index]
Model ref.: device/cuc/DefaultUserTemplate
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": {
"City": {
"minItems": 0,
"type": "string",
"description": " The name of a locality, such as a city, county or other geographic region where the user is located, or with which a user is associated.",
"name": "City",
"title": "City"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The preferred text name of a person to be used when displaying entries such as in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"CreationTime": {
"minItems": 0,
"type": "string",
"description": " The date and time the user account was created. ",
"name": "CreationTime",
"title": "Creation Time"
},
"UseDefaultTimeZone": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether the timezone for this user template is derived from the user template object attribute or the default timezone from the location to which the user template belongs. Always use the Timezone column - if this is set, then the column Timezone is being derived directly from the location.",
"name": "UseDefaultTimeZone",
"title": "Use Default Time Zone"
},
"State": {
"minItems": 0,
"type": "string",
"description": " The full name of the state or province where this user is located, or with which a user is associated.",
"name": "State",
"title": "State"
},
"RouteNDRToSender": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating, for an undeliverable message, whether NDR messages will appear in the subscriber's mailbox or are deleted by the system.",
"name": "RouteNDRToSender",
"title": "Route NDR To Sender"
},
"DefaultUserTemplateVoicePinURI": {
"type": "string",
"description": "The URI to change the voice mail pin of the template.",
"name": "DefaultUserTemplateVoicePinURI",
"title": "Default User Template Voice Pin URI"
},
"Department": {
"minItems": 0,
"type": "string",
"description": " The name or number for the department or subdivision of an organization to which a person belongs.",
"name": "Department",
"title": "Department"
},
"PartitionURI": {
"name": "PartitionURI",
"format": "uri",
"minItems": 0,
"title": "Partition URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"PartitionObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Partition to which a subscriber's DtmfAccessId created with this template will be assigned.",
"name": "PartitionObjectId",
"title": "Partition Object Id"
},
"DoesntExpire": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether or not the user credential will automatically expire (and the user required to change the credential upon its expiration) based on a defined schedule. Regardless, the user still may change the credential (if allowed by CantChange). ",
"name": "DoesntExpire",
"title": "Doesnt Expire"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a User object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"CreateSmtpProxyFromCorp": {
"minItems": 0,
"type": "boolean",
"description": " Flag indicating whether an SMTP proxy address matching the corporate e-mail address (column EmailAddress) should be created for this User.",
"name": "CreateSmtpProxyFromCorp",
"title": "Create Smtp Proxy From Corp"
},
"LocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the LocationVMS object to which this user belongs.",
"name": "LocationObjectId",
"title": "Location Object Id"
},
"DefaultUserTemplateWebPasswordURI": {
"type": "string",
"description": "The URI to change the web application password.",
"name": "DefaultUserTemplateWebPasswordURI",
"title": "Default User Template Web Password URI"
},
"DisplayNameRule": {
"minItems": 0,
"type": "integer",
"description": " The format for generating the user display name. ",
"name": "DisplayNameRule",
"title": "Display Name Rule"
},
"Address": {
"minItems": 0,
"type": "string",
"description": " The physical address such as a house number and street name where the user is located, or with which a user is associated.",
"name": "Address",
"title": "Address"
},
"UseDefaultLanguage": {
"minItems": 0,
"type": "boolean",
"description": "A flag indicating whether the language for this user template is derived from the user template object attribute or the default language from the location to which the user template belongs. Always use the Language column - if this is set, then the column Language is being derived directly from the location.",
"name": "UseDefaultLanguage",
"title": "Use Default Language"
},
"CosURI": {
"name": "CosURI",
"format": "uri",
"minItems": 0,
"title": "Cos URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"Building": {
"minItems": 0,
"type": "string",
"description": " The name of the building where the user is based (e.g., SJ-21).",
"name": "Building",
"title": "Building"
},
"LdapType": {
"minItems": 0,
"type": "integer",
"description": " The LDAP configuration information for the user.",
"name": "LdapType",
"title": "Ldap Type"
},
"Language": {
"minItems": 0,
"type": "integer",
"description": " The preferred language of this user. For a user with a voice mailbox, it is the language in which the subscriber hears instructions played to them. If the subscriber has TTS enabled by their COS, it is the language used for TTS. ",
"name": "Language",
"title": "Language"
},
"Country": {
"minItems": 0,
"type": "string",
"description": " The two-letter ISO 3166-1 country code where the user is located, or with which a user is associated.",
"name": "Country",
"title": "Country"
},
"CosObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the COS (Class of Service) object to which this user account is associated.",
"name": "CosObjectId",
"title": "Cos Object Id"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"TimeZone": {
"minItems": 0,
"type": "integer",
"description": " The time zone to which this user account is associated.",
"name": "TimeZone",
"title": "Time Zone"
},
"Alias": {
"minItems": 0,
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias",
"title": "Alias"
},
"MailboxDn": {
"minItems": 0,
"type": "string",
"description": " The distinguished name of the mailbox.",
"name": "MailboxDn",
"title": "Mailbox Dn"
},
"PabLastImported": {
"minItems": 0,
"type": "string",
"description": " The date and time when the personal address book was last imported from a groupware package into the personal groups for a user.",
"name": "PabLastImported",
"title": "Pab Last Imported"
},
"PostalCode": {
"minItems": 0,
"type": "string",
"description": " For users in the United States, the zip code where the user is located. For users in Canada, Mexico, and other countries, the postal code where the user is located.",
"name": "PostalCode",
"title": "Postal Code"
},
"Undeletable": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether this subscriber 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"
},
"LdapCcmPkid": {
"minItems": 0,
"type": "string",
"description": " The pkid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmPkid",
"title": "Ldap Ccm Pkid"
},
"CantChange": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether the user can set/change their credential (i.e., the credential specified by the associated credential policy).",
"name": "CantChange",
"title": "Cant Change"
},
"MailboxStoreObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the MailboxStore object where a mailbox is created for a new subscriber created with this template.",
"name": "MailboxStoreObjectId",
"title": "Mailbox Store Object Id"
},
"LdapCcmUserId": {
"minItems": 0,
"type": "string",
"description": " The userid of associated end user in the sleeping SeaDragon database.",
"name": "LdapCcmUserId",
"title": "Ldap Ccm User Id"
},
"ReadOnly": {
"minItems": 0,
"type": "boolean",
"description": " If set to 1 (true) user is read-only and cannot be modified.",
"name": "ReadOnly",
"title": "Read Only"
},
"BillingId": {
"minItems": 0,
"type": "string",
"description": " Accounting information or project code associated with this user.",
"name": "BillingId",
"title": "Billing Id"
},
"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 |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/DefaultUserTemplate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/DefaultUserTemplate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/DefaultUserTemplate/[pkid1]", "/api/v0/device/cuc/DefaultUserTemplate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/DefaultUserTemplate/?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/DefaultUserTemplate |
|
{"hrefs": ["/api/device/cuc/DefaultUserTemplate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/DefaultUserTemplate |
|
{"hrefs": ["/api/device/cuc/DefaultUserTemplate/[pkid1]", "/api/device/cuc/DefaultUserTemplate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/DefaultUserTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/DefaultUserTemplate/export/ |
|
{ "hrefs":["/api/device/cuc/DefaultUserTemplate/[pkid1]", "/api/device/cuc/DefaultUserTemplate/[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/DefaultUserTemplate and the JSON format can be used to import instances of device/cuc/DefaultUserTemplate.
GET http://[host-proxy]/api/device/cuc/DefaultUserTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/DefaultUserTemplate | POST | /api/device/cuc/DefaultUserTemplate/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/DefaultUserTemplate/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/DefaultUserTemplate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/DefaultUserTemplate/ |
|
The device/cuc/DefaultUserTemplate schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/DefaultUserTemplate instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/DefaultUserTemplate/?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": [
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/device/cuc/DefaultUserTemplate/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/DefaultUserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DefaultUserTemplate/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/DefaultUserTemplate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/DefaultUserTemplate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/DefaultUserTemplate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/DefaultUserTemplate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DefaultUserTemplate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DefaultUserTemplate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DefaultUserTemplate",
"model_specific_actions": [
"list",
"update",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"summary_attrs": [
{
"name": "DisplayName",
"title": "Display Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
},
{
"allow_filtering": false,
"name": "summary_device",
"title": "Device"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae6d2ce894e0012058e4d",
"meta": {
"tags": [],
"cached": true,
"title": "Administrator Template",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae6d2ce894e0012058e4d",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6d2ce894e0012058e4d/?model_type=device/cuc/DefaultUserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DefaultUserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6d2ce894e0012058e4d"
],
"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": {
"DisplayName": "Administrator Template",
"hierarchy": "5f3ae552ce894e00120537fa",
"CreationTime": "2018-02-15T15:05:44Z",
"UseDefaultTimeZone": true,
"RouteNDRToSender": true,
"TimeZone": 140,
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"DefaultUserTemplateVoicePinURI": "/vmrest/usertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d/credential/pin",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"DoesntExpire": false,
"Language": 1033,
"CreateSmtpProxyFromCorp": false,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DefaultUserTemplateWebPasswordURI": "/vmrest/usertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d/credential/password",
"DisplayNameRule": 1,
"UseDefaultLanguage": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"LdapType": 0,
"ObjectId": "3e5209ce-48fd-4dee-a23f-fc9745d0f74d",
"URI": "/vmrest/defaultusertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d",
"Alias": "administratortemplate",
"Undeletable": true,
"CantChange": false,
"ReadOnly": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
},
{
"pkid": "60eeea1ae04a4a001131cfd7",
"meta": {
"tags": [],
"cached": true,
"title": "Voice mail for AB_Group",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "60eeea1ae04a4a001131cfd7",
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/60eeea1ae04a4a001131cfd7/?model_type=device/cuc/DefaultUserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/DefaultUserTemplate/60eeea1ae04a4a001131cfd7/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/DefaultUserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"60eeea1ae04a4a001131cfd7"
],
"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": {
"DisplayName": "Voice mail for AB_Group",
"CreationTime": "2020-08-17T20:40:29Z",
"UseDefaultTimeZone": true,
"RouteNDRToSender": true,
"DefaultUserTemplateVoicePinURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/pin",
"PartitionURI": "/vmrest/partitions/570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"PartitionObjectId": "570a900d-4b6b-4ffd-8d36-6f5f74faa07c",
"DoesntExpire": false,
"ObjectId": "acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"CreateSmtpProxyFromCorp": false,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DefaultUserTemplateWebPasswordURI": "/vmrest/usertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e/credential/password",
"DisplayNameRule": 1,
"UseDefaultLanguage": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"CosURI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"LdapType": 0,
"Language": 1033,
"CosObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"URI": "/vmrest/defaultusertemplates/acfa5341-7582-4ccf-a1d3-7d01bf3d4f8e",
"TimeZone": 140,
"Alias": "Cu1-BasicVoiceMail-UT",
"Undeletable": false,
"CantChange": false,
"MailboxStoreObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804",
"ReadOnly": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
},
{
"pkid": "5f3ae6d0ce894e0012058e42",
"meta": {
"tags": [],
"cached": true,
"title": "Voice Mail User Template",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6d0ce894e0012058e42",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/5f3ae6d0ce894e0012058e42/?model_type=device/cuc/DefaultUserTemplate",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d0ce894e0012058e42/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DefaultUserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6d0ce894e0012058e42"
],
"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": {
"DisplayName": "Voice Mail User Template",
"CreationTime": "2018-02-15T15:05:49Z",
"UseDefaultTimeZone": true,
"RouteNDRToSender": true,
"DefaultUserTemplateVoicePinURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/credential/pin",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"DoesntExpire": false,
"Language": 1033,
"CreateSmtpProxyFromCorp": false,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DefaultUserTemplateWebPasswordURI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/credential/password",
"DisplayNameRule": 1,
"UseDefaultLanguage": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"CosURI": "/vmrest/coses/6a56c290-c222-459e-a462-7a8b5236eeda",
"LdapType": 0,
"ObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"CosObjectId": "6a56c290-c222-459e-a462-7a8b5236eeda",
"URI": "/vmrest/defaultusertemplates/cdfadb1e-4b22-486c-ac60-5543558de813",
"TimeZone": 140,
"Alias": "voicemailusertemplate",
"Undeletable": true,
"CantChange": false,
"MailboxStoreObjectId": "9179c99c-07ed-447a-8b1a-ce25f8aff804",
"ReadOnly": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6d2ce894e0012058e4d",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Administrator Template",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6d2ce894e0012058e4d",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/"
}
],
"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/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6d2ce894e0012058e4d/?hierarchy=[hierarchy]&model_type=device/cuc/DefaultUserTemplate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/DefaultUserTemplate/5f3ae6d2ce894e0012058e4d/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/DefaultUserTemplate",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6d2ce894e0012058e4d"
],
"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": {
"DisplayName": "Administrator Template",
"CreationTime": "2018-02-15T15:05:44Z",
"UseDefaultTimeZone": true,
"RouteNDRToSender": true,
"DefaultUserTemplateVoicePinURI": "/vmrest/usertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d/credential/pin",
"PartitionURI": "/vmrest/partitions/29335726-0914-46d5-8605-16d626c7dc7b",
"PartitionObjectId": "29335726-0914-46d5-8605-16d626c7dc7b",
"DoesntExpire": false,
"ObjectId": "3e5209ce-48fd-4dee-a23f-fc9745d0f74d",
"CreateSmtpProxyFromCorp": false,
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"DefaultUserTemplateWebPasswordURI": "/vmrest/usertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d/credential/password",
"DisplayNameRule": 1,
"UseDefaultLanguage": true,
"LdapType": 0,
"Language": 1033,
"URI": "/vmrest/defaultusertemplates/3e5209ce-48fd-4dee-a23f-fc9745d0f74d",
"TimeZone": 140,
"Alias": "administratortemplate",
"Undeletable": true,
"CantChange": false,
"ReadOnly": false,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/DefaultUserTemplate. | GET | /api/device/cuc/DefaultUserTemplate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/DefaultUserTemplate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/DefaultUserTemplate/[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/DefaultUserTemplate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/DefaultUserTemplate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/DefaultUserTemplate | 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/DefaultUserTemplate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/DefaultUserTemplate/[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/DefaultUserTemplate and the JSON format can be used to import instances of device/cuc/DefaultUserTemplate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/DefaultUserTemplate/[pkid] | hierarchy=[hierarchy] | The device/cuc/DefaultUserTemplate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/DefaultUserTemplate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/DefaultUserTemplate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/DefaultUserTemplate/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |