[Index]
This data model contains information about CUCM cluster types.
Model ref.: data/HcsVossCUCMClusterDAT
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": {
"name": {
"title": "Name",
"description": "The (unique) name of the CUCM cluster.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCMClusterDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HCSHcmfCUCMClusterDAT",
"choices": []
},
"sync_on_save": {
"title": "Sync on Create/Update",
"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.",
"type": "boolean"
},
"version": {
"title": "Version",
"description": "Indicates the version of the CUCMs within the cluster.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HcsVossToSdrVersionMap/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HcsVossToSdrVersionMap",
"choices": []
},
"hostNameOrIP": {
"title": "HostNameOrIP",
"description": "The hostname or IPV4 of the CUCM",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"filter_move_mode": {
"title": "User Move Mode",
"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).",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "Automatic",
"choices": [
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "Manual",
"title": "Manual"
}
]
},
"default_entitlement_profile": {
"title": "User Entitlement Profile",
"description": "The Entitlement Profile assigned to users imported from this UC Application.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HcsEntitlementProfileDAT",
"choices": []
},
"misc_data": {
"title": "Misc Data",
"description": "Miscellaneous data used at run-time",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"migrate": {
"title": "Migrate from HCM-F to CUCDM",
"description": "Migrate HCM-F Models to CUCDM Models",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"multi_tenant": {
"title": "Multi-Tenant",
"description": "Indicates whether the cluster applications are dedicated to a customer or shared across multiple customers",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Shared",
"title": "Shared"
}
]
},
"enableCnf": {
"title": "Enable Change Notification Sync",
"description": "Enable Change Notification Sync for Cluster",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "false"
},
"monitoring": {
"title": "Monitoring",
"description": "Manage Monitoring for this Cluster",
"type": "object",
"properties": {
"credential_type": {
"title": "Credential Type",
"description": "Select the credential type to use for the monitoring.",
"type": "string",
"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"
}
]
},
"arbitrators": {
"title": "Assurance Arbitrator Servers",
"description": "Select the Assurance Arbitrator servers to configure for monitoring this cluster.",
"type": "array",
"items": {
"type": "string",
"choices": []
}
}
}
},
"FieldMapping": {
"title": "Field Mapping",
"type": "object",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"properties": {
"username": {
"title": "User ID",
"description": "The CUCM field mapped to the user's login attribute.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "userid"
},
"buildingName": {
"title": "Building Name",
"description": "The CUCM field mapped to the user's custom building name.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"c": {
"title": "C",
"description": "The CUCM field mapped to the user's custom country.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"departmentNumber": {
"title": "Department",
"description": "The CUCM field mapped to the user's department number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "department"
},
"directoryUri": {
"title": "Directory URI",
"description": "The CUCM field mapped to the user's custom directory URI.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "directoryUri"
},
"displayName": {
"title": "Display Name",
"description": "The CUCM field mapped to the user's custom display name.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"employeeNumber": {
"title": "Employee Number",
"description": "The CUCM field mapped to the user's custom employee number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"employeeType": {
"title": "Employee Type",
"description": "The CUCM field mapped to the user's custom employee type.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"facsimileTelephoneNumber": {
"title": "Facsimile Telephone Number",
"description": "The CUCM field mapped to the user's custom FAX number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"givenName": {
"title": "First Name",
"description": "The CUCM field mapped to the user's first name.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "firstName"
},
"homePhone": {
"title": "Home Number",
"description": "The CUCM field mapped to the user's home phone number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "homeNumber"
},
"ipPhone": {
"title": "IP Phone",
"description": "The CUCM field mapped to the user's custom IP phone number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"jabberID": {
"title": "Jabber ID",
"description": "The CUCM field mapped to the user's custom Jabber ID.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"l": {
"title": "L",
"description": "The CUCM field mapped to the user's custom city.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"mail": {
"title": "Mail ID",
"description": "The CUCM field mapped to the user's email address.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "mailid"
},
"manager": {
"title": "Manager ID",
"description": "The CUCM field mapped to the user's manager.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "manager"
},
"memberOf": {
"title": "Member Of",
"description": "The CUCM field mapped to the user's groups.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"mobile": {
"title": "Mobile Number",
"description": "The CUCM field mapped to the user's mobile phone number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "mobileNumber"
},
"o": {
"title": "O",
"description": "The CUCM field mapped to the user's custom organization name.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"objectClass": {
"title": "Object Class",
"description": "The CUCM field mapped to the user's object class.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"otherMailbox": {
"title": "Other Mailbox",
"description": "The CUCM field mapped to the user's other mailbox.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"ou": {
"title": "Ou",
"description": "The CUCM field mapped to the user's custom organization unit name.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"photoURL": {
"title": "Photo URL",
"description": "The CUCM field mapped to the user's custom photo URL.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"physicalDeliveryOfficeName": {
"title": "Physical Delivery Office Name",
"description": "The CUCM field mapped to the user's post office.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"postalCode": {
"title": "Postal Code",
"description": "The CUCM field mapped to the user's postal code.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"preferredLanguage": {
"title": "Preferred Language",
"description": "The CUCM field mapped to the user's preferred language.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"sn": {
"title": "Last Name",
"description": "The CUCM field mapped to the user's last name.",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "lastName"
},
"st": {
"title": "St",
"description": "The CUCM field mapped to the user's state.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"street": {
"title": "Street",
"description": "The CUCM field mapped to the user's street.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"telephoneNumber": {
"title": "Telephone Number",
"description": "The CUCM field mapped to the user's telephone number.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "telephoneNumber"
},
"timezone": {
"title": "Timezone",
"description": "The CUCM field mapped to the user's time zone.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"title": {
"title": "Title",
"description": "The CUCM field mapped to the user's title.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "title"
},
"uid": {
"title": "Uid",
"description": "The CUCM field mapped to the user's userid.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"unverifiedMailBox": {
"title": "Unverified Mail Box",
"description": "The CUCM field mapped to the user's unverified mailbox.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customString1": {
"title": "Custom String 1",
"description": "The CUCM field mapped to a custom string.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customString2": {
"title": "Custom String 2",
"description": "The CUCM field mapped to a custom string.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customString3": {
"title": "Custom String 3",
"description": "The CUCM field mapped to a custom string.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customString4": {
"title": "Custom String 4",
"description": "The CUCM field mapped to a custom string.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customString5": {
"title": "Custom String 5",
"description": "The CUCM field mapped to a custom string.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customListOfStrings1": {
"title": "Custom List of Strings 1",
"description": "The CUCM field mapped to a custom list of strings.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customListOfStrings2": {
"title": "Custom List of Strings 2",
"description": "The CUCM field mapped to a custom list of strings.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customListOfStrings3": {
"title": "Custom List of Strings 3",
"description": "The CUCM field mapped to a custom list of strings.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customListOfStrings4": {
"title": "Custom List of Strings 4",
"description": "The CUCM field mapped to a custom list of strings.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"customListOfStrings5": {
"title": "Custom List of Strings 5",
"description": "The CUCM field mapped to a custom list of strings.",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
}
}
}
},
"schema_version": "2.6"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/HcsVossCUCMClusterDAT/add/ |
|
The GUI Add form of data/HcsVossCUCMClusterDAT 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/HcsVossCUCMClusterDAT | 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/HcsVossCUCMClusterDAT/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/HcsVossCUCMClusterDAT/[pkid1]", "/api/data/HcsVossCUCMClusterDAT/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/HcsVossCUCMClusterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/HcsVossCUCMClusterDAT/export/ |
|
{ "hrefs":["/api/data/HcsVossCUCMClusterDAT/[pkid1]", "/api/data/HcsVossCUCMClusterDAT/[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/HcsVossCUCMClusterDAT and the JSON format can be used to import instances of data/HcsVossCUCMClusterDAT.
GET http://[host-proxy]/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/HcsVossCUCMClusterDAT | POST | /api/data/HcsVossCUCMClusterDAT/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/HcsVossCUCMClusterDAT/ |
|
The data/HcsVossCUCMClusterDAT schema and all instances as JSON. |
(The list will return 0 to 3 data/HcsVossCUCMClusterDAT instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 2,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/HcsVossCUCMClusterDAT/?skip=0&limit=3&order_by=name&direction=asc&traversal=down"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"meta": {
"model_type": "data/HcsVossCUCMClusterDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"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": [
"list",
"get",
"add",
"update",
"remove",
"import",
"execute",
"export",
"export_bulkload_template",
"help"
],
"schema_version": "2.6",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/HcsVossCUCMClusterDAT/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/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/data/HcsVossCUCMClusterDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"FieldMapping": {
"buildingName": "buildingName",
"unverifiedMailBox": "unverifiedMailBox",
"manager": "manager",
"street": "street",
"timezone": "timezone",
"uid": "uid",
"jabberID": "jabberID",
"directoryUri": "directoryUri",
"employeeType": "employeeType",
"otherMailbox": "otherMailbox",
"title": "title",
"facsimileTelephoneNumber": "facsimileTelephoneNumber",
"postalCode": "postalCode",
"mail": "mailid",
"username": "userid",
"departmentNumber": "department",
"photoURL": "photoURL",
"employeeNumber": "employeeNumber",
"physicalDeliveryOfficeName": "physicalDeliveryOfficeName",
"homePhone": "homeNumber",
"telephoneNumber": "telephoneNumber",
"c": "c",
"displayName": "displayName",
"mobile": "mobileNumber",
"memberOf": "memberOf",
"l": "l",
"o": "o",
"st": "st",
"preferredLanguage": "preferredLanguage",
"sn": "lastName",
"ou": "ou",
"givenName": "firstName",
"ipPhone": "ipPhone"
},
"filter_move_mode": "Automatic",
"name": "ABG-CL1",
"hostNameOrIP": "192.168.100.15",
"migrate": false,
"misc_data": "",
"pkid": "5ae89eccaffa931cce38bd3e",
"version": "10.5",
"default_entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"multi_tenant": "Dedicated",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/HcsVossCUCMClusterDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [
{
"pkid": "5ae89ec9affa931cce38bc93",
"path": "name",
"model_type": "data/HCSHcmfCUCMClusterDAT"
},
{
"pkid": "5ad5d2a8affa9343e4d98ffc",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
},
{
"pkid": "5ae89eb7affa931cce38af7c",
"path": "default_entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
],
"self": [
{
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/",
"pkid": "5ae89eccaffa931cce38bd39"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89eccaffa931cce38bd39"
],
"schema_version": "2.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89eccaffa931cce38bd39"
},
{
"data": {
"FieldMapping": {
"buildingName": "buildingName",
"unverifiedMailBox": "unverifiedMailBox",
"manager": "manager",
"street": "street",
"timezone": "timezone",
"uid": "uid",
"jabberID": "jabberID",
"directoryUri": "directoryUri",
"employeeType": "employeeType",
"otherMailbox": "otherMailbox",
"title": "title",
"facsimileTelephoneNumber": "facsimileTelephoneNumber",
"postalCode": "postalCode",
"mail": "mailid",
"username": "userid",
"departmentNumber": "department",
"photoURL": "photoURL",
"employeeNumber": "employeeNumber",
"physicalDeliveryOfficeName": "physicalDeliveryOfficeName",
"homePhone": "homeNumber",
"telephoneNumber": "telephoneNumber",
"c": "c",
"displayName": "displayName",
"mobile": "mobileNumber",
"memberOf": "memberOf",
"l": "l",
"o": "o",
"st": "st",
"preferredLanguage": "preferredLanguage",
"sn": "lastName",
"ou": "ou",
"givenName": "firstName",
"ipPhone": "ipPhone"
},
"filter_move_mode": "Automatic",
"name": "ABG-CL2",
"hostNameOrIP": "192.168.100.16",
"migrate": false,
"misc_data": "",
"pkid": "5ae89edaaffa931cce38c12e",
"version": "11.5",
"default_entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"multi_tenant": "Dedicated",
"hierarchy_friendly_name": "AB_Group (Customer)",
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
},
"meta": {
"model_type": "data/HcsVossCUCMClusterDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"pkid": "5ae89ea2affa931cce38a523",
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523"
}
],
"foreign_key": [
{
"pkid": "5ae89ed7affa931cce38c083",
"path": "name",
"model_type": "data/HCSHcmfCUCMClusterDAT"
},
{
"pkid": "5ad5d2a7affa9343e4d98ff9",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
},
{
"pkid": "5ae89eb7affa931cce38af7c",
"path": "default_entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
],
"self": [
{
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/",
"pkid": "5ae89edaaffa931cce38c129"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89edaaffa931cce38c129"
],
"schema_version": "2.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/execute/",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89edaaffa931cce38c129/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "5ae89edaaffa931cce38c129"
}
]
}
(Show the first instance)
{
"data": {
"FieldMapping": {
"buildingName": "buildingName",
"unverifiedMailBox": "unverifiedMailBox",
"manager": "manager",
"street": "street",
"timezone": "timezone",
"uid": "uid",
"jabberID": "jabberID",
"directoryUri": "directoryUri",
"employeeType": "employeeType",
"otherMailbox": "otherMailbox",
"title": "title",
"facsimileTelephoneNumber": "facsimileTelephoneNumber",
"postalCode": "postalCode",
"mail": "mailid",
"username": "userid",
"departmentNumber": "department",
"photoURL": "photoURL",
"employeeNumber": "employeeNumber",
"physicalDeliveryOfficeName": "physicalDeliveryOfficeName",
"homePhone": "homeNumber",
"telephoneNumber": "telephoneNumber",
"c": "c",
"displayName": "displayName",
"mobile": "mobileNumber",
"memberOf": "memberOf",
"l": "l",
"o": "o",
"st": "st",
"preferredLanguage": "preferredLanguage",
"sn": "lastName",
"ou": "ou",
"givenName": "firstName",
"ipPhone": "ipPhone"
},
"filter_move_mode": "Automatic",
"name": "ABG-CL1",
"hostNameOrIP": "192.168.100.15",
"migrate": false,
"misc_data": "",
"version": "10.5",
"default_entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"multi_tenant": "Dedicated",
"pkid": "5ae89eccaffa931cce38bd3e"
},
"meta": {
"model_type": "data/HcsVossCUCMClusterDAT",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "multi_tenant",
"title": "Multi-Tenant"
},
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "title format",
"business_key": {},
"api_version": "21.2",
"cached": false,
"references": {
"device": [
{
"href": "",
"pkid": ""
}
],
"owner": [
{
"pkid": ""
}
],
"parent": [
{
"href": "/api/data/HierarchyNode/5ae89ea2affa931cce38a523",
"pkid": "5ae89ea2affa931cce38a523"
}
],
"foreign_key": [
{
"pkid": "5ae89ec9affa931cce38bc93",
"path": "name",
"model_type": "data/HCSHcmfCUCMClusterDAT"
},
{
"pkid": "5ad5d2a8affa9343e4d98ffc",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
},
{
"pkid": "5ae89eb7affa931cce38af7c",
"path": "default_entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
],
"children": [],
"self": [
{
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/",
"pkid": "5ae89eccaffa931cce38bd39"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"5ae89b62affa931cce3855c4",
"5ae89c0faffa931cce386c0f",
"5ae89ea2affa931cce38a523",
"5ae89eccaffa931cce38bd39"
],
"schema_version": "2.6",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"execute": {
"method": "POST",
"class": "execute",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/execute/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Execute"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/5ae89eccaffa931cce38bd39/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "5ae89eccaffa931cce38bd39"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/HcsVossCUCMClusterDAT. | GET | /api/data/HcsVossCUCMClusterDAT/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/HcsVossCUCMClusterDAT as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/HcsVossCUCMClusterDAT/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/HcsVossCUCMClusterDAT/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/HcsVossCUCMClusterDAT/[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/HcsVossCUCMClusterDAT; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/HcsVossCUCMClusterDAT/[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/HcsVossCUCMClusterDAT and the JSON format can be used to import instances of data/HcsVossCUCMClusterDAT.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Execute | POST | /api/data/HcsVossCUCMClusterDAT/[pkid]/execute | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/HcsVossCUCMClusterDAT/[pkid] | hierarchy=[hierarchy] | The data/HcsVossCUCMClusterDAT instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/HcsVossCUCMClusterDAT/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/HcsVossCUCMClusterDAT. |