[Index]
Model ref.: device/cuc/CredentialPolicy
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": {
"TrivialCredChecking": {
"minItems": 0,
"type": "boolean",
"description": " A flag indicating whether Cisco Unity Connection should check against trivial credentials for extra security. ",
"name": "TrivialCredChecking",
"title": "Trivial Cred Checking"
},
"MaxHacks": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of failed logon attempts (hacks) before action is taken.",
"name": "MaxHacks",
"title": "Max Hacks"
},
"ObjectId": {
"description": " The primary key for this table. A globally unique, system-generated identifier for a CredentialPolicy object. - template parameter [1]",
"title": "Object Id",
"minItems": 0,
"readonly": true,
"type": "string",
"name": "ObjectId"
},
"MaxDays": {
"minItems": 0,
"type": "integer",
"description": " The maximum number of days before the credential must be changed.",
"name": "MaxDays",
"title": "Max Days"
},
"MinLength": {
"minItems": 0,
"type": "integer",
"description": " The minimum number of characters or digits (PIN) required for the credential.",
"name": "MinLength",
"title": "Min Length"
},
"HackResetTime": {
"minItems": 0,
"type": "integer",
"description": " The length of time (in minutes) after which if no failed logon attempts occur, the count of failed logon attempts is cleared.",
"name": "HackResetTime",
"title": "Hack Reset Time"
},
"ExpiryWarningDays": {
"minItems": 0,
"type": "integer",
"description": " The number of days prior to the expiration of a credential when Cisco Unity Connection begins prompting a user to change their credential upon logon, until the change is made.",
"name": "ExpiryWarningDays",
"title": "Expiry Warning Days"
},
"LockoutDuration": {
"minItems": 0,
"type": "integer",
"description": " The length of time (in minutes) that a user who is locked out must wait until they can attempt to access the system again with this credential.",
"name": "LockoutDuration",
"title": "Lockout Duration"
},
"URI": {
"name": "URI",
"format": "uri",
"minItems": 0,
"title": "URI",
"choices": [],
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"MinCharsToChange": {
"minItems": 0,
"type": "integer",
"description": " To hold the count of the minimum number of characters that must change between new and old password, during a password change.",
"name": "MinCharsToChange",
"title": "Min Chars To Change"
},
"LocationObjectId": {
"minItems": 0,
"type": "string",
"description": " The unique identifier of the Location object to which this credential policy belongs.",
"name": "LocationObjectId",
"title": "Location Object Id"
},
"MinDuration": {
"minItems": 0,
"type": "integer",
"description": " The minimum number of minutes that must pass from the time of the last change before the credential can be changed.",
"name": "MinDuration",
"title": "Min Duration"
},
"DisplayName": {
"minItems": 0,
"type": "string",
"description": " The unique text name (e.g., \"Administrator Password Policy\") of the credential policy to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration.",
"name": "DisplayName",
"title": "Display Name"
},
"PrevCredCount": {
"minItems": 0,
"type": "integer",
"description": " The number of credentials to store. ",
"name": "PrevCredCount",
"title": "Prev Cred Count"
},
"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/CredentialPolicy/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cuc/CredentialPolicy/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/CredentialPolicy/[pkid1]", "/api/v0/device/cuc/CredentialPolicy/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cuc/CredentialPolicy/?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/CredentialPolicy |
|
{"hrefs": ["/api/device/cuc/CredentialPolicy/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cuc/CredentialPolicy |
|
{"hrefs": ["/api/device/cuc/CredentialPolicy/[pkid1]", "/api/device/cuc/CredentialPolicy/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cuc/CredentialPolicy/export/ |
|
{ "hrefs":["/api/device/cuc/CredentialPolicy/[pkid1]", "/api/device/cuc/CredentialPolicy/[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/CredentialPolicy and the JSON format can be used to import instances of device/cuc/CredentialPolicy.
GET http://[host-proxy]/api/device/cuc/CredentialPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cuc/CredentialPolicy | POST | /api/device/cuc/CredentialPolicy/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/CredentialPolicy/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/CredentialPolicy/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cuc/CredentialPolicy/ |
|
The device/cuc/CredentialPolicy schema and all instances as JSON. |
(The list will return 0 to 3 device/cuc/CredentialPolicy instances)
{
"operations": [
"move"
],
"pagination": {
"direction": "asc",
"order_by": "DisplayName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cuc/CredentialPolicy/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 2
},
"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/CredentialPolicy/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/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CredentialPolicy/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/CredentialPolicy/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cuc/CredentialPolicy/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cuc/CredentialPolicy/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cuc/CredentialPolicy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CredentialPolicy/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CredentialPolicy/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CredentialPolicy",
"model_specific_actions": [
"list",
"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": "5f3ae6cfce894e0012058e17",
"meta": {
"tags": [],
"cached": true,
"title": "Recommended Voice Mail Authentication Rule",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"self": [
{
"pkid": "5f3ae6cfce894e0012058e17",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cfce894e0012058e17/?model_type=device/cuc/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cfce894e0012058e17"
],
"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": {
"TrivialCredChecking": false,
"MaxHacks": 3,
"ObjectId": "bd84aa8b-3cf9-4452-8388-c9df0bf051f7",
"MaxDays": 0,
"MinLength": 5,
"HackResetTime": 30,
"MinDuration": 1440,
"LockoutDuration": 0,
"URI": "/vmrest/credentialpolicies/bd84aa8b-3cf9-4452-8388-c9df0bf051f7",
"hierarchy": "5f3ae552ce894e00120537fa",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ExpiryWarningDays": 15,
"DisplayName": "Recommended Voice Mail Authentication Rule",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"PrevCredCount": 0,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
},
{
"pkid": "5f3ae6cfce894e0012058df9",
"meta": {
"tags": [],
"cached": true,
"title": "Recommended Web Application Authentication Rule",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae6cfce894e0012058df9",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": []
},
"actions": [
{
"clone": {
"support_async": false,
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cfce894e0012058df9/?model_type=device/cuc/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058df9/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cuc/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cfce894e0012058df9"
],
"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": {
"TrivialCredChecking": false,
"MaxHacks": 7,
"ObjectId": "97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"MaxDays": 0,
"MinLength": 5,
"HackResetTime": 30,
"MinDuration": 0,
"LockoutDuration": 0,
"URI": "/vmrest/credentialpolicies/97cdd898-bde9-4e8e-89a7-3dc7ce28a9ae",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"ExpiryWarningDays": 15,
"DisplayName": "Recommended Web Application Authentication Rule",
"hierarchy_friendly_name": "AB_Group (Customer)",
"summary_device": "Dedicated CUCxn, 192.168.100.20, 8443, hcs.CS-P.CS-AB.AB_Group",
"PrevCredCount": 0,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae6cfce894e0012058e17",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "Recommended Voice Mail Authentication Rule",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae6cfce894e0012058e17",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "5f3ae59cce894e00120554b1",
"href": "/api/v0/data/UnityConnection/5f3ae59cce894e00120554b1"
}
],
"children": []
},
"actions": [
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5f3ae6cfce894e0012058e17/?hierarchy=[hierarchy]&model_type=device/cuc/CredentialPolicy",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cuc/CredentialPolicy/5f3ae6cfce894e0012058e17/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cuc/CredentialPolicy",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae6cfce894e0012058e17"
],
"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": {
"TrivialCredChecking": false,
"MaxHacks": 3,
"ObjectId": "bd84aa8b-3cf9-4452-8388-c9df0bf051f7",
"MaxDays": 0,
"MinLength": 5,
"HackResetTime": 30,
"ExpiryWarningDays": 15,
"LockoutDuration": 0,
"URI": "/vmrest/credentialpolicies/bd84aa8b-3cf9-4452-8388-c9df0bf051f7",
"LocationObjectId": "93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2",
"MinDuration": 1440,
"DisplayName": "Recommended Voice Mail Authentication Rule",
"PrevCredCount": 0,
"LocationURI": "/vmrest/locations/connectionlocations/93ef0f3b-966c-45a7-ab0b-2fc9dfb47cb2"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cuc/CredentialPolicy. | GET | /api/device/cuc/CredentialPolicy/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cuc/CredentialPolicy as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/device/cuc/CredentialPolicy/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cuc/CredentialPolicy/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cuc/CredentialPolicy | 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/CredentialPolicy; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cuc/CredentialPolicy/[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/CredentialPolicy and the JSON format can be used to import instances of device/cuc/CredentialPolicy.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cuc/CredentialPolicy/[pkid] | hierarchy=[hierarchy] | The device/cuc/CredentialPolicy instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cuc/CredentialPolicy/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cuc/CredentialPolicy. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cuc/CredentialPolicy/[pkid]/purge | hierarchy=[hierarchy] | If payload required: |