[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": {
"FieldMapping": {
"is_password": false,
"title": "Field Mapping",
"required": false,
"displayable": false,
"readonly": false,
"type": "object",
"properties": {
"customString3": {
"is_password": false,
"description": "The CUCM field mapped to a custom string.",
"title": "Custom String 3",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"buildingName": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom building name.",
"title": "Building Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customString2": {
"is_password": false,
"description": "The CUCM field mapped to a custom string.",
"title": "Custom String 2",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"objectClass": {
"is_password": false,
"description": "The CUCM field mapped to the user's object class.",
"title": "Object Class",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"unverifiedMailBox": {
"is_password": false,
"description": "The CUCM field mapped to the user's unverified mailbox.",
"title": "Unverified Mail Box",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"manager": {
"is_password": false,
"description": "The CUCM field mapped to the user's manager.",
"title": "Manager ID",
"default": "manager",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"street": {
"is_password": false,
"description": "The CUCM field mapped to the user's street.",
"title": "Street",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"timezone": {
"is_password": false,
"description": "The CUCM field mapped to the user's time zone.",
"title": "Timezone",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"uid": {
"is_password": false,
"description": "The CUCM field mapped to the user's userid.",
"title": "Uid",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"jabberID": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom Jabber ID.",
"title": "Jabber ID",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"directoryUri": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom directory URI.",
"title": "Directory URI",
"default": "directoryUri",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"employeeType": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom employee type.",
"title": "Employee Type",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"otherMailbox": {
"is_password": false,
"description": "The CUCM field mapped to the user's other mailbox.",
"title": "Other Mailbox",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"title": {
"is_password": false,
"description": "The CUCM field mapped to the user's title.",
"title": "Title",
"default": "title",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"facsimileTelephoneNumber": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom FAX number.",
"title": "Facsimile Telephone Number",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customString4": {
"is_password": false,
"description": "The CUCM field mapped to a custom string.",
"title": "Custom String 4",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"postalCode": {
"is_password": false,
"description": "The CUCM field mapped to the user's postal code.",
"title": "Postal Code",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"mail": {
"is_password": false,
"description": "The CUCM field mapped to the user's email address.",
"title": "Mail ID",
"default": "mailid",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"username": {
"is_password": false,
"description": "The CUCM field mapped to the user's login attribute.",
"title": "User ID",
"default": "userid",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"departmentNumber": {
"is_password": false,
"description": "The CUCM field mapped to the user's department number.",
"title": "Department",
"default": "department",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customString1": {
"is_password": false,
"description": "The CUCM field mapped to a custom string.",
"title": "Custom String 1",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customString5": {
"is_password": false,
"description": "The CUCM field mapped to a custom string.",
"title": "Custom String 5",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"photoURL": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom photo URL.",
"title": "Photo URL",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"employeeNumber": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom employee number.",
"title": "Employee Number",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"physicalDeliveryOfficeName": {
"is_password": false,
"description": "The CUCM field mapped to the user's post office.",
"title": "Physical Delivery Office Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customListOfStrings2": {
"is_password": false,
"description": "The CUCM field mapped to a custom list of strings.",
"title": "Custom List of Strings 2",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customListOfStrings3": {
"is_password": false,
"description": "The CUCM field mapped to a custom list of strings.",
"title": "Custom List of Strings 3",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customListOfStrings4": {
"is_password": false,
"description": "The CUCM field mapped to a custom list of strings.",
"title": "Custom List of Strings 4",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customListOfStrings5": {
"is_password": false,
"description": "The CUCM field mapped to a custom list of strings.",
"title": "Custom List of Strings 5",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"homePhone": {
"is_password": false,
"description": "The CUCM field mapped to the user's home phone number.",
"title": "Home Number",
"default": "homeNumber",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"telephoneNumber": {
"is_password": false,
"description": "The CUCM field mapped to the user's telephone number.",
"title": "Telephone Number",
"default": "telephoneNumber",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"c": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom country.",
"title": "C",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"displayName": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom display name.",
"title": "Display Name",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"mobile": {
"is_password": false,
"description": "The CUCM field mapped to the user's mobile phone number.",
"title": "Mobile Number",
"default": "mobileNumber",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"memberOf": {
"is_password": false,
"description": "The CUCM field mapped to the user's groups.",
"title": "Member Of",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"customListOfStrings1": {
"is_password": false,
"description": "The CUCM field mapped to a custom list of strings.",
"title": "Custom List of Strings 1",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"l": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom city.",
"title": "L",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"o": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom organization name.",
"title": "O",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"st": {
"is_password": false,
"description": "The CUCM field mapped to the user's state.",
"title": "St",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"preferredLanguage": {
"is_password": false,
"description": "The CUCM field mapped to the user's preferred language.",
"title": "Preferred Language",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"sn": {
"is_password": false,
"description": "The CUCM field mapped to the user's last name.",
"title": "Last Name",
"default": "lastName",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"ou": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom organization unit name.",
"title": "Ou",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"givenName": {
"is_password": false,
"description": "The CUCM field mapped to the user's first name.",
"title": "First Name",
"default": "firstName",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"ipPhone": {
"is_password": false,
"description": "The CUCM field mapped to the user's custom IP phone number.",
"title": "IP Phone",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
},
"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 CUCM cluster.",
"format": "uri",
"title": "Name",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "device/hcmf/CUCMCluster",
"type": "string",
"target": "/api/device/hcmf/CUCMCluster/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"hostNameOrIP": {
"is_password": false,
"description": "The hostname or IPV4 of the CUCM",
"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"
},
"enableCnf": {
"is_password": false,
"description": "Enable Change Notification Sync for Cluster",
"title": "Enable Change Notification Sync",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"version": {
"is_password": false,
"description": "Indicates the version of the CUCMs 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 server to monitor this cluster.",
"title": "Assurance Arbitrator Servers"
},
"credential_type": {
"title": "Credential Type",
"type": "string",
"description": "Select the credential type to use for the monitoring.",
"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": "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 shared across multiple customers",
"title": "Multi-Tenant",
"required": false,
"displayable": false,
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Shared",
"title": "Shared"
}
],
"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.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)
{
"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/HcsVossCUCMClusterDAT/?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.6",
"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/HcsVossCUCMClusterDAT/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/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/HcsVossCUCMClusterDAT/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/HcsVossCUCMClusterDAT/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCMClusterDAT",
"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": "5f3ae589ce894e00120550af",
"meta": {
"tags": [],
"cached": true,
"title": "title format",
"business_key": {},
"schema_version": "2.6",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5f3ae589ce894e00120550af",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/"
}
],
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"foreign_key": [
{
"pkid": "5df36166ce894e0012b36960",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
},
{
"pkid": "5f3ae56fce894e0012054339",
"path": "default_entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
]
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/import/",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/execute/",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/help",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCMClusterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae589ce894e00120550af"
],
"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": {
"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": "5f3ae58ace894e00120550b3",
"version": "11.5",
"default_entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"hierarchy_friendly_name": "AB_Group (Customer)",
"multi_tenant": "Dedicated",
"sync_on_save": true,
"hierarchy_path": "sys.hcs.CS-P.CS-AB.AB_Group"
}
}
]
}
(Show the first instance)
{
"pkid": "5f3ae589ce894e00120550af",
"meta": {
"tags": [],
"cached": false,
"title": "title format",
"business_key": {},
"schema_version": "2.6",
"references": {
"parent": [
{
"pkid": "5f3ae552ce894e00120537fa",
"href": "/api/data/HierarchyNode/5f3ae552ce894e00120537fa"
}
],
"self": [
{
"pkid": "5f3ae589ce894e00120550af",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/"
}
],
"foreign_key": [
{
"pkid": "5df36166ce894e0012b36960",
"path": "version",
"model_type": "data/HcsVossToSdrVersionMap"
},
{
"pkid": "5f3ae56fce894e0012054339",
"path": "default_entitlement_profile",
"model_type": "data/HcsEntitlementProfileDAT"
}
],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"import": {
"support_async": true,
"method": "POST",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/import/?hierarchy=[hierarchy]",
"class": "import",
"title": "Import"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"execute": {
"support_async": true,
"class": "execute",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/execute/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Execute"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/HcsVossCUCMClusterDAT/5f3ae589ce894e00120550af/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "data/HcsVossCUCMClusterDAT",
"path": [
"6t0ggef2c0deab00hb595101",
"5df35e48ce894e0012b345a1",
"5f3ae1fcce894e001204e0ed",
"5f3ae256ce894e001204f7db",
"5f3ae552ce894e00120537fa",
"5f3ae589ce894e00120550af"
],
"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": {
"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",
"displayName": "displayName",
"homePhone": "homeNumber",
"telephoneNumber": "telephoneNumber",
"c": "c",
"physicalDeliveryOfficeName": "physicalDeliveryOfficeName",
"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": "5f3ae58ace894e00120550b3",
"version": "11.5",
"default_entitlement_profile": "[\"AB_Group-Standard-EP\", \"hcs.CS-P.CS-AB.AB_Group\"]",
"multi_tenant": "Dedicated",
"sync_on_save": true
}
}
| 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. |