[Index]
Model ref.: device/cucm/TvsCertificate
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": {
"ipv4Address": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Ipv4Address"
},
"roles": {
"title": "Roles",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"role": {
"name": "role",
"title": "Role",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"roleName": {
"name": "roleName",
"title": "Role Name",
"minItems": 0,
"required": false,
"choices": [
{
"value": "SAST",
"title": "SAST"
},
{
"value": "CallManager",
"title": "CallManager"
},
{
"value": "CallManagerTFTP",
"title": "CallManagerTFTP"
},
{
"value": "TFTP",
"title": "TFTP"
},
{
"value": "CAPF",
"title": "CAPF"
},
{
"value": "SRST",
"title": "SRST"
},
{
"value": "Firewall",
"title": "Firewall"
},
{
"value": "Application Server",
"title": "Application Server"
},
{
"value": "Certificate Authority",
"title": "Certificate Authority"
},
{
"value": "Authentication and Authorization",
"title": "Authentication and Authorization"
},
{
"value": "Signaling and Call Control",
"title": "Signaling and Call Control"
},
{
"value": "Provisioning Service",
"title": "Provisioning Service"
},
{
"value": "Data Service",
"title": "Data Service"
},
{
"value": "Network Element",
"title": "Network Element"
},
{
"value": "Virtual Private Network",
"title": "Virtual Private Network"
},
{
"value": "Serviceability",
"title": "Serviceability"
},
{
"value": "Unknown",
"title": "Unknown"
},
{
"value": "CallManager-ECDSA",
"title": "CallManager-ECDSA"
}
],
"maxItems": 1,
"type": "string"
}
}
},
"required": true,
"type": "array"
}
}
},
"ipv6Address": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Ipv6Address"
},
"serialNumber": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Serial Number"
},
"subjectName": {
"minItems": 0,
"required": false,
"type": "string",
"maxItems": 1,
"title": "Subject Name"
},
"timeToLive": {
"minItems": 0,
"required": false,
"type": [
"integer",
"null"
],
"maxItems": 1,
"title": "Time To Live"
},
"services": {
"title": "Services",
"minItems": 0,
"required": false,
"maxItems": 1,
"type": [
"object",
"null"
],
"properties": {
"service": {
"name": "service",
"title": "Service",
"minItems": 1,
"items": {
"type": [
"object",
"null"
],
"properties": {
"serviceName": {
"name": "serviceName",
"title": "Service Name",
"minItems": 0,
"required": false,
"choices": [
{
"value": "Phone-trust",
"title": "Phone-trust"
},
{
"value": "Phone-VPN-trust",
"title": "Phone-VPN-trust"
},
{
"value": "CallManager",
"title": "CallManager"
},
{
"value": "CallManager-trust",
"title": "CallManager-trust"
},
{
"value": "tomcat",
"title": "tomcat"
},
{
"value": "tomcat-trust",
"title": "tomcat-trust"
},
{
"value": "ipsec",
"title": "ipsec"
},
{
"value": "ipsec-trust",
"title": "ipsec-trust"
},
{
"value": "CAPF",
"title": "CAPF"
},
{
"value": "CAPF-trust",
"title": "CAPF-trust"
},
{
"value": "TVS",
"title": "TVS"
},
{
"value": "TVS-trust",
"title": "TVS-trust"
},
{
"value": "directory-trust",
"title": "directory-trust"
},
{
"value": "Phone-SAST-trust",
"title": "Phone-SAST-trust"
},
{
"value": "Phone-CTL-trust",
"title": "Phone-CTL-trust"
},
{
"value": "userlicensing-trust",
"title": "userlicensing-trust"
},
{
"value": "ITLRecovery",
"title": "ITLRecovery"
},
{
"value": "CallManager-ECDSA",
"title": "CallManager-ECDSA"
},
{
"value": "tomcat-ECDSA",
"title": "tomcat-ECDSA"
},
{
"value": "Phone-CTL-ASA-trust",
"title": "Phone-CTL-ASA-trust"
},
{
"value": "Phone-Edge-trust",
"title": "Phone-Edge-trust"
}
],
"maxItems": 1,
"type": "string"
}
}
},
"required": true,
"type": "array"
}
}
},
"issuerName": {
"minItems": 1,
"required": true,
"type": "string",
"maxItems": 1,
"title": "Issuer Name"
}
},
"schema_version": "14.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/device/cucm/TvsCertificate/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/device/cucm/TvsCertificate/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cucm/TvsCertificate/[pkid1]", "/api/v0/device/cucm/TvsCertificate/[pkid2]",...]}} |
GET http://[host-proxy]/api/device/cucm/TvsCertificate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=device/cucm/TvsCertificate |
|
{"hrefs": ["/api/device/cucm/TvsCertificate/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=device/cucm/TvsCertificate |
|
{"hrefs": ["/api/device/cucm/TvsCertificate/[pkid1]", "/api/device/cucm/TvsCertificate/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cucm/TvsCertificate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/device/cucm/TvsCertificate/export/ |
|
{ "hrefs":["/api/device/cucm/TvsCertificate/[pkid1]", "/api/device/cucm/TvsCertificate/[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/cucm/TvsCertificate and the JSON format can be used to import instances of device/cucm/TvsCertificate.
GET http://[host-proxy]/api/device/cucm/TvsCertificate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for device/cucm/TvsCertificate | POST | /api/device/cucm/TvsCertificate/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/cucm/TvsCertificate/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/device/cucm/TvsCertificate/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/device/cucm/TvsCertificate/ |
|
The device/cucm/TvsCertificate schema and all instances as JSON. |
(The list will return 0 to 3 device/cucm/TvsCertificate instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"bulk_update_form",
"transform",
"export",
"export_bulkload_template"
],
"pagination": {
"direction": "asc",
"order_by": "subjectName",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/device/cucm/TvsCertificate/?skip=0&limit=3&order_by=subjectName&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 66
},
"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/cucm/TvsCertificate/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/cucm/TvsCertificate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/TvsCertificate/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/cucm/TvsCertificate/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/device/cucm/TvsCertificate/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/device/cucm/TvsCertificate/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/device/cucm/TvsCertificate/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/TvsCertificate/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/TvsCertificate/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/TvsCertificate",
"model_specific_actions": [
"field_display_policy",
"configuration_template",
"help",
"get",
"clone",
"move",
"list",
"update",
"export",
"export_bulkload_template",
"bulk_update_form"
],
"summary_attrs": [
{
"name": "subjectName",
"title": "Subject Name"
},
{
"name": "issuerName",
"title": "Issuer Name"
},
{
"name": "serialNumber",
"title": "Serial Number"
},
{
"name": "timeToLive",
"title": "Time To Live"
},
{
"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": "6109c127e04a4a00149d95bf",
"meta": {
"tags": [],
"cached": true,
"title": "CN=ACT2 SUDI CA,O=Cisco",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109c060e04a4a00149d6aa3",
"href": "/api/v0/data/CallManager/6109c060e04a4a00149d6aa3"
}
],
"self": [
{
"pkid": "6109c127e04a4a00149d95bf",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/"
}
],
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109c127e04a4a00149d95bf/?model_type=device/cucm/TvsCertificate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/help",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/purge/",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/TvsCertificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c127e04a4a00149d95bf"
],
"summary_attrs": [
{
"name": "subjectName",
"title": "Subject Name"
},
{
"name": "issuerName",
"title": "Issuer Name"
},
{
"name": "serialNumber",
"title": "Serial Number"
},
{
"name": "timeToLive",
"title": "Time To Live"
},
{
"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": {
"ipv4Address": "192.168.100.17",
"roles": null,
"hierarchy": "6109bff5e04a4a00149d4e1d",
"serialNumber": "61096e7d00000000000c",
"subjectName": "CN=ACT2 SUDI CA,O=Cisco",
"timeToLive": null,
"services": {
"service": [
{
"serviceName": "CallManager-trust"
},
{
"serviceName": "CAPF-trust"
}
]
},
"issuerName": "CN=Cisco Root CA 2048,O=Cisco Systems",
"summary_device": "Shared CUCM, 192.168.100.17, 8443, hcs.CS-P",
"hierarchy_friendly_name": "CS-P (Provider)",
"hierarchy_path": "sys.hcs.CS-P"
}
},
{
"pkid": "6109c1c2e04a4a00149db613",
"meta": {
"tags": [],
"cached": true,
"title": "CN=ACT2 SUDI CA,O=Cisco",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109c094e04a4a00149d75a4",
"href": "/api/v0/data/CallManager/6109c094e04a4a00149d75a4"
}
],
"self": [
{
"pkid": "6109c1c2e04a4a00149db613",
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/"
}
],
"parent": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/data/HierarchyNode/6109c040e04a4a00149d61cf"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"clone": {
"support_async": false,
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109c1c2e04a4a00149db613/?model_type=device/cucm/TvsCertificate",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/help",
"title": "Help",
"class": "help",
"method": "GET"
}
},
{
"purge": {
"support_async": false,
"href": "/api/device/cucm/TvsCertificate/6109c1c2e04a4a00149db613/purge/",
"title": "Purge",
"class": "purge",
"method": "POST"
}
}
],
"model_type": "device/cucm/TvsCertificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c1c2e04a4a00149db613"
],
"summary_attrs": [
{
"name": "subjectName",
"title": "Subject Name"
},
{
"name": "issuerName",
"title": "Issuer Name"
},
{
"name": "serialNumber",
"title": "Serial Number"
},
{
"name": "timeToLive",
"title": "Time To Live"
},
{
"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": {
"ipv4Address": "192.168.100.15",
"roles": null,
"hierarchy": "6109c040e04a4a00149d61cf",
"serialNumber": "61096e7d00000000000c",
"subjectName": "CN=ACT2 SUDI CA,O=Cisco",
"timeToLive": null,
"services": {
"service": [
{
"serviceName": "CallManager-trust"
},
{
"serviceName": "CAPF-trust"
}
]
},
"issuerName": "CN=Cisco Root CA 2048,O=Cisco Systems",
"summary_device": "Dedicated CUCM, 192.168.100.15, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
},
{
"pkid": "6109c284e04a4a00149dfb93",
"meta": {
"tags": [],
"cached": true,
"title": "CN=ACT2 SUDI CA,O=Cisco",
"business_key": {},
"schema_version": "",
"summary": "false",
"references": {
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109c0dfe04a4a00149d86cb",
"href": "/api/v0/data/CallManager/6109c0dfe04a4a00149d86cb"
}
],
"self": [
{
"pkid": "6109c284e04a4a00149dfb93",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/"
}
],
"parent": [
{
"pkid": "6109c040e04a4a00149d61cf",
"href": "/api/data/HierarchyNode/6109c040e04a4a00149d61cf"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/",
"class": "update",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"method": "POST",
"href": "/api/tool/DataMove/6109c284e04a4a00149dfb93/?model_type=device/cucm/TvsCertificate",
"class": "move",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"method": "GET",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/export/",
"class": "export",
"view": "/api/view/ExportData/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/help",
"class": "help",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"method": "POST",
"href": "/api/device/cucm/TvsCertificate/6109c284e04a4a00149dfb93/purge/",
"class": "purge",
"title": "Purge"
}
}
],
"model_type": "device/cucm/TvsCertificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c032e04a4a00149d5e4d",
"6109c040e04a4a00149d61cf",
"6109c284e04a4a00149dfb93"
],
"summary_attrs": [
{
"name": "subjectName",
"title": "Subject Name"
},
{
"name": "issuerName",
"title": "Issuer Name"
},
{
"name": "serialNumber",
"title": "Serial Number"
},
{
"name": "timeToLive",
"title": "Time To Live"
},
{
"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": {
"ipv4Address": "192.168.100.16",
"roles": null,
"hierarchy": "6109c040e04a4a00149d61cf",
"serialNumber": "61096e7d00000000000c",
"subjectName": "CN=ACT2 SUDI CA,O=Cisco",
"timeToLive": null,
"services": {
"service": [
{
"serviceName": "CallManager-trust"
},
{
"serviceName": "CAPF-trust"
}
]
},
"issuerName": "CN=Cisco Root CA 2048,O=Cisco Systems",
"summary_device": "Dedicated CUCM, 192.168.100.16, 8443, hcs.CS-P.CS-NB.AAAGlobal",
"hierarchy_friendly_name": "AAAGlobal (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal"
}
}
]
}
(Show the first instance)
{
"pkid": "6109c127e04a4a00149d95bf",
"meta": {
"tags": [],
"cached": true,
"cache_control_policy": "cache_then_device",
"title": "CN=ACT2 SUDI CA,O=Cisco",
"business_key": {},
"schema_version": "11.5",
"references": {
"parent": [
{
"pkid": "6109bff5e04a4a00149d4e1d",
"href": "/api/data/HierarchyNode/6109bff5e04a4a00149d4e1d"
}
],
"self": [
{
"pkid": "6109c127e04a4a00149d95bf",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/"
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"device": [
{
"pkid": "6109c060e04a4a00149d6aa3",
"href": "/api/v0/data/CallManager/6109c060e04a4a00149d6aa3"
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/6109c127e04a4a00149d95bf/?hierarchy=[hierarchy]&model_type=device/cucm/TvsCertificate",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"purge": {
"support_async": false,
"class": "purge",
"href": "/api/device/cucm/TvsCertificate/6109c127e04a4a00149d95bf/purge/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Purge"
}
}
],
"model_type": "device/cucm/TvsCertificate",
"path": [
"6t0ggef2c0deab00hb595101",
"61097058e04a4a001501b18c",
"6109bff5e04a4a00149d4e1d",
"6109c127e04a4a00149d95bf"
],
"summary_attrs": [
{
"name": "subjectName",
"title": "Subject Name"
},
{
"name": "issuerName",
"title": "Issuer Name"
},
{
"name": "serialNumber",
"title": "Serial Number"
},
{
"name": "timeToLive",
"title": "Time To Live"
},
{
"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": {
"ipv4Address": "192.168.100.17",
"roles": null,
"serialNumber": "61096e7d00000000000c",
"subjectName": "CN=ACT2 SUDI CA,O=Cisco",
"timeToLive": null,
"services": {
"service": [
{
"serviceName": "CallManager-trust"
},
{
"serviceName": "CAPF-trust"
}
]
},
"issuerName": "CN=Cisco Root CA 2048,O=Cisco Systems"
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for device/cucm/TvsCertificate. | GET | /api/device/cucm/TvsCertificate/help | hierarchy=[hierarchy] | On-line help of Model ref.: device/cucm/TvsCertificate as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/device/cucm/TvsCertificate/[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/cucm/TvsCertificate/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/device/cucm/TvsCertificate/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=device/cucm/TvsCertificate | 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/cucm/TvsCertificate; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/device/cucm/TvsCertificate/[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/cucm/TvsCertificate and the JSON format can be used to import instances of device/cucm/TvsCertificate.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/device/cucm/TvsCertificate/[pkid]/ | hierarchy=[hierarchy] | The device/cucm/TvsCertificate instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/device/cucm/TvsCertificate/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for device/cucm/TvsCertificate. |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Purge | POST | /api/device/cucm/TvsCertificate/[pkid]/purge/ | hierarchy=[hierarchy] | If payload required: |