[Index]
This data model contains information about CUCxn cluster types.
Model ref.: data/HcsVossCUCxnClusterDAT
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": {
"filter_move_mode": {
"is_password": false,
"description": "The behavior for moving users to site. Setting this value to Automatic will trigger the system to apply the move filters (refer to User Management) automatically when users are sync'd into the system. Automatic is only applicable to creating new users. Setting this value to Manual means that users must be moved to site by an Adminstrator (refer to User Management).",
"title": "User Move Mode",
"default": "Automatic",
"required": false,
"displayable": false,
"choices": [
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "Manual",
"title": "Manual"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"description": "The (unique) name of the CUCxn cluster.",
"format": "uri",
"title": "Name",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "device/hcmf/CUCxnCluster",
"type": "string",
"target": "/api/device/hcmf/CUCxnCluster/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"hostNameOrIP": {
"is_password": false,
"description": "The hostname or IPV4 of the CUCxn",
"title": "HostNameOrIP",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"migrate": {
"is_password": false,
"description": "Migrate HCM-F Models to CUCDM Models",
"title": "Migrate from HCM-F to CUCDM",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"misc_data": {
"is_password": false,
"description": "Miscellaneous data used at run-time",
"title": "Misc Data",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"version": {
"is_password": false,
"description": "Indicates the version of the CUCxns within the cluster.",
"format": "uri",
"title": "Version",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsVossToSdrVersionMap",
"type": "string",
"target": "/api/data/HcsVossToSdrVersionMap/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"default_entitlement_profile": {
"is_password": false,
"description": "The Entitlement Profile assigned to users imported from this UC Application.",
"format": "uri",
"title": "User Entitlement Profile",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsEntitlementProfileDAT",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"monitoring": {
"properties": {
"arbitrators": {
"items": {
"type": "string",
"choices": []
},
"type": "array",
"description": "Select the Assurance Arbitrator servers to configure for monitoring this cluster.",
"title": "Assurance Arbitrator Servers"
},
"credential_type": {
"default": "ADMIN",
"choices": [
{
"value": "SNMP_V1",
"title": "SNMP_V1"
},
{
"value": "SNMP_V2",
"title": "SNMP_V2"
},
{
"value": "SNMP_V3",
"title": "SNMP_V3"
},
{
"value": "ADMIN",
"title": "ADMIN"
},
{
"value": "PLATFORM",
"title": "PLATFORM"
},
{
"value": "WMI",
"title": "WMI"
},
{
"value": "IOS_ENABLE",
"title": "IOS_ENABLE"
},
{
"value": "HTTP",
"title": "HTTP"
},
{
"value": "CLI",
"title": "CLI"
},
{
"value": "OPERATOR",
"title": "OPERATOR"
},
{
"value": "SFTP",
"title": "SFTP"
},
{
"value": "JTAPI",
"title": "JTAPI"
}
],
"type": "string",
"description": "Select the credential type to use for the monitoring.",
"title": "Credential Type"
}
},
"type": "object",
"description": "Manage Monitoring for this Cluster",
"title": "Monitoring"
},
"multi_tenant": {
"is_password": false,
"description": "Indicates whether the cluster applications are dedicated to a customer, or partitioned for multiple customers",
"title": "Multi-Tenant",
"default": "(( macro.HcsCustomerHnCountMCR > 0 )) <Dedicated> <Partitioned>",
"required": false,
"displayable": false,
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Partitioned",
"title": "Partitioned"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"sync_on_save": {
"type": "boolean",
"description": "If this checkbox is selected, then when saving this form (on either create or update), it will also immediately trigger the auto-import (sync) of this UC App server now.",
"title": "Sync on Create/Update"
}
},
"schema_version": "2.5"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsVossCUCxnClusterDAT/add/ |
|
The GUI Add form of data/HcsVossCUCxnClusterDAT as JSON |
The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Create | POST | /api/data/HcsVossCUCxnClusterDAT | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk delete [pkid1],[pkid2]... | DELETE | /api/data/HcsVossCUCxnClusterDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsVossCUCxnClusterDAT/[pkid1]", "/api/data/HcsVossCUCxnClusterDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsVossCUCxnClusterDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsVossCUCxnClusterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsVossCUCxnClusterDAT/export/ |
|
{ "hrefs":["/api/data/HcsVossCUCxnClusterDAT/[pkid1]", "/api/data/HcsVossCUCxnClusterDAT/[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 data/HcsVossCUCxnClusterDAT and the JSON format can be used to import instances of data/HcsVossCUCxnClusterDAT.
GET http://[host-proxy]/api/data/HcsVossCUCxnClusterDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsVossCUCxnClusterDAT | POST | /api/data/HcsVossCUCxnClusterDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsVossCUCxnClusterDAT/ |
|
The data/HcsVossCUCxnClusterDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsVossCUCxnClusterDAT instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"transform",
"add",
"export",
"migration",
"bulk_update_form"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/data/HcsVossCUCxnClusterDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 1
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": "2.5",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/data/HcsVossCUCxnClusterDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCxnClusterDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCxnClusterDAT/export/?hierarchy=[hierarchy]",
"method": "POST",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/data/HcsVossCUCxnClusterDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsVossCUCxnClusterDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCxnClusterDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCxnClusterDAT",
"model_specific_actions": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": [
{
"pkid": "5f3ae59cce894e001205549e",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.5",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae59cce894e001205549e",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": [
{
"pkid": "5df36166ce894e0012b36960",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCxnClusterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae59cce894e001205549e"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"filter_move_mode": "Automatic",
"name": "ABG-CUCXN1",
"hostNameOrIP": "192.168.100.20",
"migrate": false,
"misc_data": "",
"pkid": "5f3ae59cce894e00120554a2",
"version": "11.5",
"multi_tenant": "Dedicated",
"hierarchy_friendly_name": "AB_Group (Customer)",
"sync_on_save": true,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae59cce894e001205549e",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.5",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae59cce894e001205549e",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/"
}
],
"foreign_key": [
{
"pkid": "5df36166ce894e0012b36960",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCxnClusterDAT/5f3ae59cce894e001205549e/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCxnClusterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae59cce894e001205549e"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"data": {
"filter_move_mode": "Automatic",
"name": "ABG-CUCXN1",
"hostNameOrIP": "192.168.100.20",
"migrate": false,
"misc_data": "",
"pkid": "5f3ae59cce894e00120554a2",
"version": "11.5",
"multi_tenant": "Dedicated",
"sync_on_save": true
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsVossCUCxnClusterDAT. | GET | /api/data/HcsVossCUCxnClusterDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsVossCUCxnClusterDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsVossCUCxnClusterDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsVossCUCxnClusterDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsVossCUCxnClusterDAT/[pkid]/import | 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 data/HcsVossCUCxnClusterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsVossCUCxnClusterDAT/[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 data/HcsVossCUCxnClusterDAT and the JSON format can be used to import instances of data/HcsVossCUCxnClusterDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsVossCUCxnClusterDAT/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsVossCUCxnClusterDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsVossCUCxnClusterDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsVossCUCxnClusterDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsVossCUCxnClusterDAT. |