[Index]
Model ref.: device/cuc/UserTemplatePassword
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": {
"CredentialPolicyURI": {
"minItems": 0,
"title": "Credential Policy URI",
"type": "string",
"name": "CredentialPolicyURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"UserObjectId": {
"target": "/api/device/cuc/UserTemplate/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"minItems": 0,
"required": true,
"name": "UserObjectId",
"target_attr": "ObjectId",
"title": "User Object Id",
"type": [
"string"
],
"description": " The unique identifier of the User object to which this credential belongs. - template parameter [1]",
"target_model_type": "device/cuc/UserTemplate",
"choices": []
},
"Locked": {
"minItems": 0,
"title": "Locked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked.",
"name": "Locked"
},
"TimeHacked": {
"minItems": 0,
"title": "Time Hacked",
"type": "string",
"description": " The date and time that the credential was locked due to too many hacks. The date and time is recorded in this column whenever a user credential is locked due to too many hacks based on the credential policy.",
"name": "TimeHacked"
},
"TimeChanged": {
"minItems": 0,
"title": "Time Changed",
"type": "string",
"description": " The date and time when the credentials were last changed. The date and time is recorded in this column whenever a user credential is created or changed.",
"name": "TimeChanged"
},
"CantChange": {
"minItems": 0,
"title": "Cant Change",
"type": "boolean",
"description": " A flag indicating whether the user can set this credential.",
"name": "CantChange"
},
"Credentials": {
"is_password": true,
"description": " The PIN or password, for a user. The credentials are stored in an encrypted format.",
"title": "Credentials",
"minItems": 0,
"type": "string",
"name": "Credentials"
},
"TimeLastHack": {
"minItems": 0,
"title": "Time Last Hack",
"type": "string",
"description": " The date and time of the last logon attempt with an invalid user credential.",
"name": "TimeLastHack"
},
"CredentialPolicyObjectId": {
"minItems": 0,
"title": "Credential Policy Object Id",
"type": "string",
"description": " The unique identifier of the CredentialPolicy object that is associated with this credential.",
"name": "CredentialPolicyObjectId"
},
"URI": {
"minItems": 0,
"title": "URI",
"type": "string",
"name": "URI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"UserURI": {
"minItems": 0,
"title": "User URI",
"type": "string",
"name": "UserURI",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"choices": []
},
"CredentialType": {
"minItems": 0,
"title": "Credential Type",
"type": "integer",
"description": " The type of credential such as password, PIN, Windows or Domino credential. ",
"name": "CredentialType"
},
"Alias": {
"minItems": 0,
"title": "Alias",
"type": "string",
"description": " The unique text name for either a user, distribution list, or personal group.",
"name": "Alias"
},
"Hacked": {
"minItems": 0,
"title": "Hacked",
"type": "boolean",
"description": "A flag indicating whether access to the user account associated with this set of credentials is locked due too many hack attempts.",
"name": "Hacked"
},
"HackCount": {
"minItems": 0,
"title": "Hack Count",
"type": "integer",
"description": " The number of logons attempted that failed due to invalid credentials. The Unity system or external authentication provider determined that the credentials supplied as part of a user logon attempt were invalid. ",
"name": "HackCount"
},
"DoesntExpire": {
"minItems": 0,
"title": "Doesnt Expire",
"type": "boolean",
"description": " A flag indicating whether this user credential will expire, and therefore the user must change the credential periodically. However, if the credential does not expire (value = \"1\"), the user still may change the credential (if allowed by CantChange). ",
"name": "DoesntExpire"
},
"IsPrimary": {
"minItems": 0,
"title": "Is Primary",
"type": "boolean",
"description": " A flag indicating whether this credential is mapped to the user NT/AD domain account and as such is designated as the 'primary' credential for the user. This column is not currently used, but is retained from Unity 4.x in case it is needed in the future.",
"name": "IsPrimary"
},
"ObjectId": {
"description": " Surrogate key to support IMS",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"CredMustChange": {
"minItems": 0,
"title": "Cred Must Change",
"type": "boolean",
"description": " A flag indicating whether the user must change their credentials (PIN or password) at the next login.",
"name": "CredMustChange"
},
"TimeLockout": {
"minItems": 0,
"title": "Time Lockout",
"type": "string",
"description": " The date and time that the credential was locked by an administrator.",
"name": "TimeLockout"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cuc/UserTemplatePassword/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/UserTemplatePassword/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/UserTemplatePassword/[pkid1]", "/api/v0/device/cuc/UserTemplatePassword/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/UserTemplatePassword/?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/UserTemplatePassword |
|
{"hrefs": ["/api/device/cuc/UserTemplatePassword/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/UserTemplatePassword |
|
{"hrefs": ["/api/device/cuc/UserTemplatePassword/[pkid1]", "/api/device/cuc/UserTemplatePassword/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/UserTemplatePassword; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/UserTemplatePassword/export/ |
|
{ "hrefs":["/api/device/cuc/UserTemplatePassword/[pkid1]", "/api/device/cuc/UserTemplatePassword/[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/UserTemplatePassword and the JSON format can be used to import instances of device/cuc/UserTemplatePassword.
GET http://[host-proxy]/api/device/cuc/UserTemplatePassword/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/UserTemplatePassword | POST | /api/device/cuc/UserTemplatePassword/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/UserTemplatePassword/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/UserTemplatePassword/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/UserTemplatePassword/ |
|
The device/cuc/UserTemplatePassword schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/UserTemplatePassword instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 4,
"total_limit": null,
"order_by": "ObjectId",
"direction": "asc",
"current": "/api/device/cuc/UserTemplatePassword/?skip=0&limit=3&order_by=ObjectId&direction=asc&traversal=down"
},
"operations": [
"move"
],
"meta": {
"model_type": "device/cuc/UserTemplatePassword",
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"update",
"list",
"get",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"help",
"move"
],
"schema_version": "14.0",
"actions": [
{
"bulk_update_form": {
"method": "GET",
"class": "update",
"href": "/api/device/cuc/UserTemplatePassword/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Bulk Modify"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplatePassword",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/device/cuc/UserTemplatePassword/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/device/cuc/UserTemplatePassword/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/device/cuc/UserTemplatePassword/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/device/cuc/UserTemplatePassword/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/device/cuc/UserTemplatePassword/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplatePassword/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplatePassword/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"resources": [
{
"data": {
"Locked": false,
"ObjectId": "bf03b753-7470-4b00-a1a5-3eac7bdaca9f",
"CantChange": false,
"Credentials": "",
"URI": "/vmrest/usertemplates/11dd0513-3e17-4a38-aae4-1b647be8cc97/credential/password",
"Alias": "Cu1-BasicVoiceMail-UT",
"CredentialPolicyObjectId": "97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"DoesntExpire": false,
"UserObjectId": "11dd0513-3e17-4a38-aae4-1b647be8cc97",
"CredMustChange": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplatePassword",
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "bf03b753-7470-4b00-a1a5-3eac7bdaca9f",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/",
"pkid": "5ae8b150affa931cce3d59fd"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8b150affa931cce3d59fd"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8b150affa931cce3d59fd/?model_type=device/cuc/UserTemplatePassword",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8b150affa931cce3d59fd"
},
{
"data": {
"Locked": false,
"ObjectId": "f46c4837-45d4-40a1-a424-01ee500b5346",
"CantChange": false,
"Credentials": "",
"URI": "/vmrest/usertemplates/df276a05-64ac-4bbb-b8ab-fbd8e867c304/credential/password",
"Alias": "Cu1-BasicVoiceMail-UT",
"CredentialPolicyObjectId": "97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"DoesntExpire": false,
"UserObjectId": "df276a05-64ac-4bbb-b8ab-fbd8e867c304",
"CredMustChange": true,
"summary_device": "Dedicated CUCxn, 192.168.100.21, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplatePassword",
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "f46c4837-45d4-40a1-a424-01ee500b5346",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ef8affa931cce38ca95",
"pkid": "5ae89ef8affa931cce38ca95"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/",
"pkid": "5ae8b171affa931cce3d5ca0"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8b171affa931cce3d5ca0"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8b171affa931cce3d5ca0/?model_type=device/cuc/UserTemplatePassword",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b171affa931cce3d5ca0/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8b171affa931cce3d5ca0"
},
{
"data": {
"Locked": false,
"ObjectId": "f9c8e860-89b4-41cd-9359-bd4d9f143884",
"CantChange": false,
"Credentials": "",
"URI": "/vmrest/usertemplates/cdfadb1e-4b22-486c-ac60-5543558de813/credential/password",
"Alias": "voicemailusertemplate",
"CredentialPolicyObjectId": "97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"DoesntExpire": false,
"UserObjectId": "cdfadb1e-4b22-486c-ac60-5543558de813",
"CredMustChange": true,
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "device/cuc/UserTemplatePassword",
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "f9c8e860-89b4-41cd-9359-bd4d9f143884",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"self": [
{
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/",
"pkid": "5ae8a01baffa931cce390813"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8a01baffa931cce390813"
],
"schema_version": "",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8a01baffa931cce390813/?model_type=device/cuc/UserTemplatePassword",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/help",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplatePassword/5ae8a01baffa931cce390813/purge/",
"support_async": false,
"title": "Purge"
}
}
],
"summary": "false"
},
"pkid": "5ae8a01baffa931cce390813"
}
]
}
(Show the first instance)
{
"data": {
"DoesntExpire": false,
"Locked": false,
"CantChange": false,
"URI": "/vmrest/usertemplates/11dd0513-3e17-4a38-aae4-1b647be8cc97/credential/password",
"Alias": "Cu1-BasicVoiceMail-UT",
"CredentialPolicyObjectId": "97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"ObjectId": "bf03b753-7470-4b00-a1a5-3eac7bdaca9f",
"Credentials": "",
"UserObjectId": "11dd0513-3e17-4a38-aae4-1b647be8cc97",
"CredMustChange": true
},
"meta": {
"model_type": "device/cuc/UserTemplatePassword",
"summary_attrs": [
{
"name": "ObjectId",
"title": "Object Id"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
},
{
"name": "summary_device",
"title": "Device",
"allow_filtering": false
}
],
"tagged_versions": [],
"tags": [],
"title": "bf03b753-7470-4b00-a1a5-3eac7bdaca9f",
"business_key": {},
"api_version": "21.2",
"cached": true,
"cache_control_policy": "cache_then_device",
"references": {
"device": [
{
"href": "/api/v0/data/UnityConnection/5ae89ee8affa931cce38c5a8",
"pkid": "5ae89ee8affa931cce38c5a8"
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [],
"children": [],
"self": [
{
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/",
"pkid": "5ae8b150affa931cce3d59fd"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae8b150affa931cce3d59fd"
],
"schema_version": "11.5",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"move": {
"method": "POST",
"class": "move",
"href": "/api/tool/DataMove/5ae8b150affa931cce3d59fd/?hierarchy=[hierarchy]&model_type=device/cuc/UserTemplatePassword",
"support_async": true,
"title": "Move",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
},
{
"purge": {
"method": "POST",
"class": "purge",
"href": "/api/device/cuc/UserTemplatePassword/5ae8b150affa931cce3d59fd/purge/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Purge"
}
}
]
},
"pkid": "5ae8b150affa931cce3d59fd"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/UserTemplatePassword. | GET | /api/device/cuc/UserTemplatePassword/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/UserTemplatePassword as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplatePassword/purge/ |
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cuc/UserTemplatePassword/[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/UserTemplatePassword/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/UserTemplatePassword/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/UserTemplatePassword | 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/UserTemplatePassword; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/UserTemplatePassword/[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/UserTemplatePassword and the JSON format can be used to import instances of device/cuc/UserTemplatePassword.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/UserTemplatePassword/[pkid] | hierarchy=[hierarchy] | The device/cuc/UserTemplatePassword instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/UserTemplatePassword/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/UserTemplatePassword. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/UserTemplatePassword/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |