[Index]
CustomerBuild-AddCiscoCUCM-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoCUCM-WFC_REL
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": {
"relation_HcsCallManagerREL": {
"items": {
"type": "object",
"properties": {
"isMediaTerminationPoint": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isMediaTerminationPoint",
"title": "isMediaTerminationPoint"
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "cdmUpdateTimestamp",
"title": "cdmUpdateTimestamp"
},
"typeCucmServer": {
"name": "typeCucmServer",
"title": "typeCucmServer",
"default": "VOICE_VIDEO",
"required": true,
"choices": [
[
"VOICE_VIDEO",
"VOICE_VIDEO"
],
[
"IM_P",
"IM_P"
]
],
"type": "string"
},
"id": {
"type": [
"string",
"null"
],
"name": "id",
"title": "id"
},
"routingId": {
"type": [
"string",
"null"
],
"name": "routingId",
"searchable": "CUCM",
"title": "routingId"
},
"virtualMachine": {
"target": "/api/device/hcmf/VirtualMachine/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "virtualMachine",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/VirtualMachine",
"type": [
"string",
"null"
],
"name": "virtualMachine"
},
"isConferenceServer": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isConferenceServer",
"title": "isConferenceServer"
},
"isTFTPServer": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isTFTPServer",
"title": "isTFTPServer"
},
"networkAddresses": {
"items": {
"type": "object",
"properties": {
"domain": {
"type": [
"string",
"null"
]
},
"iPAddrV4": {
"type": [
"string",
"null"
]
},
"description": {
"type": [
"string",
"null"
]
},
"iPAddrV6": {
"type": [
"string",
"null"
]
},
"hostShortNameOnly": {
"type": [
"string",
"null"
]
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
]
},
"isSRVAddress": {
"default": false,
"required": true,
"type": "boolean"
},
"typeAddressSpace": {
"required": true,
"type": "string",
"choices": [
[
"APPLICATION_SPACE",
"APPLICATION_SPACE"
],
[
"SERVICE_PROVIDER_SPACE",
"SERVICE_PROVIDER_SPACE"
],
[
"CUSTOMER_SPACE",
"CUSTOMER_SPACE"
]
]
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
]
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
]
}
}
},
"type": [
"array",
"null"
],
"name": "networkAddresses",
"title": "networkAddresses"
},
"isCTIManager": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isCTIManager",
"title": "isCTIManager"
},
"isAttendantConsole": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isAttendantConsole",
"title": "isAttendantConsole"
},
"isUCPublisher": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isUCPublisher",
"searchable": "CUCM",
"title": "isUCPublisher"
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isModifiable",
"title": "isModifiable"
},
"bkCUCMCluster_name": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "bkCUCMCluster_name",
"title": "Cluster Name"
},
"isMusicServer": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isMusicServer",
"title": "isMusicServer"
},
"type": {
"name": "type",
"title": "type",
"default": "CUCM",
"required": true,
"readonly": true,
"type": "string"
},
"description": {
"type": [
"string",
"null"
],
"name": "description",
"title": "description"
},
"sIPTrunks": {
"items": {
"target": "/api/device/hcmf/SIPTrunk/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/SIPTrunk",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "sIPTrunks",
"title": "sIPTrunks"
},
"isAnnunciator": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isAnnunciator",
"title": "isAnnunciator"
},
"credentials": {
"items": {
"type": "object",
"properties": {
"description": {
"type": [
"string",
"null"
]
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
]
},
"userID": {
"type": [
"string",
"null"
]
},
"id": {
"type": [
"string",
"null"
]
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
]
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
]
},
"typeSNMPAccess": {
"default": "RO",
"type": [
"string",
"null"
],
"choices": [
[
"RO",
"RO"
],
[
"RW",
"RW"
]
]
},
"typeCredential": {
"required": true,
"type": "string",
"choices": [
[
"SNMP_V1",
"SNMP_V1"
],
[
"SNMP_V2",
"SNMP_V2"
],
[
"SNMP_V3",
"SNMP_V3"
],
[
"ADMIN",
"ADMIN"
],
[
"PLATFORM",
"PLATFORM"
],
[
"WMI",
"WMI"
],
[
"IOS_ENABLE",
"IOS_ENABLE"
],
[
"HTTP",
"HTTP"
],
[
"CLI",
"CLI"
],
[
"OPERATOR",
"OPERATOR"
],
[
"SFTP",
"SFTP"
],
[
"JTAPI",
"JTAPI"
]
]
},
"password_CommunityString": {
"store_encrypted": true,
"is_password": true,
"type": [
"string",
"null"
]
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
]
}
}
},
"type": [
"array",
"null"
],
"name": "credentials",
"title": "credentials"
},
"isAutoLinked": {
"default": true,
"type": [
"boolean",
"null"
],
"name": "isAutoLinked",
"title": "isAutoLinked"
},
"vossCluster": {
"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"
}
},
"title": "Voss Cluster"
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isDeletable",
"title": "isDeletable"
},
"isCallProcessingEngine": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isCallProcessingEngine",
"title": "isCallProcessingEngine"
},
"name": {
"required": true,
"type": "string",
"name": "name",
"searchable": "CUCM",
"title": "CUCM Server Name"
},
"sdrCluster": {
"type": "object",
"properties": {
"typeAppVersion": {
"choices": [
[
"VERSION_PRE_8_6",
"VERSION_PRE_8_6"
],
[
"VERSION_8_6",
"VERSION_8_6"
],
[
"VERSION_9_0",
"VERSION_9_0"
],
[
"VERSION_9_1",
"VERSION_9_1"
],
[
"VERSION_10_0",
"VERSION_10_0"
],
[
"VERSION_10_5",
"VERSION_10_5"
],
[
"VERSION_11_5",
"VERSION_11_5"
],
[
"VERSION_12_5",
"VERSION_12_5"
]
],
"required": true,
"type": "string",
"name": "typeAppVersion",
"title": "typeAppVersion"
},
"ownsOrgUnit": {
"target": "/api/device/hcmf/OrgUnit/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "ownsOrgUnit",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/OrgUnit",
"type": [
"string",
"null"
],
"name": "ownsOrgUnit"
},
"connectionStatus": {
"type": [
"string",
"null"
],
"name": "connectionStatus",
"title": "connectionStatus"
},
"eLM": {
"target": "/api/device/hcmf/ELM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "eLM",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/ELM",
"type": [
"string",
"null"
],
"name": "eLM"
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "cdmUpdateTimestamp",
"title": "cdmUpdateTimestamp"
},
"id": {
"type": [
"string",
"null"
],
"name": "id",
"title": "id"
},
"uUID": {
"type": [
"string",
"null"
],
"name": "uUID",
"searchable": "CUCMCluster",
"title": "uUID"
},
"numEndUserSubscribers": {
"type": [
"integer",
"null"
],
"name": "numEndUserSubscribers",
"title": "numEndUserSubscribers"
},
"countryCode": {
"type": [
"string",
"null"
],
"name": "countryCode",
"title": "countryCode"
},
"monitorsPrimeCollab": {
"target": "/api/device/hcmf/PrimeCollab/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "monitorsPrimeCollab",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/PrimeCollab",
"type": [
"string",
"null"
],
"name": "monitorsPrimeCollab"
},
"clusterID": {
"type": [
"string",
"null"
],
"name": "clusterID",
"title": "clusterID"
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isModifiable",
"title": "isModifiable"
},
"callProcessingID": {
"type": [
"string",
"null"
],
"name": "callProcessingID",
"title": "callProcessingID"
},
"type": {
"name": "type",
"title": "type",
"default": "CUCMCluster",
"required": true,
"readonly": true,
"type": "string"
},
"email": {
"type": [
"string",
"null"
],
"name": "email",
"title": "email"
},
"status": {
"type": [
"string",
"null"
],
"name": "status",
"title": "status"
},
"customers": {
"items": {
"target": "/api/device/hcmf/Customer/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/Customer",
"type": [
"string",
"null"
]
},
"type": [
"array",
"null"
],
"name": "customers",
"title": "customers"
},
"description": {
"type": [
"string",
"null"
],
"name": "description",
"title": "description"
},
"lastExecutedTime": {
"type": [
"string",
"null"
],
"name": "lastExecutedTime",
"title": "lastExecutedTime"
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isDeletable",
"title": "isDeletable"
},
"isManualMode": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isManualMode",
"title": "isManualMode"
},
"name": {
"required": true,
"type": "string",
"name": "name",
"searchable": "CUCMCluster",
"title": "name"
},
"lastSuccessfulTime": {
"type": [
"string",
"null"
],
"name": "lastSuccessfulTime",
"title": "lastSuccessfulTime"
},
"typeCucmCupSharingMode": {
"default": "DEDICATED",
"choices": [
[
"DEDICATED",
"DEDICATED"
],
[
"SHARED",
"SHARED"
]
],
"type": [
"string",
"null"
],
"name": "typeCucmCupSharingMode",
"title": "typeCucmCupSharingMode"
},
"virtualAccounts": {
"target": "/api/device/hcmf/VirtualAccounts/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "virtualAccounts",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/VirtualAccounts",
"type": [
"string",
"null"
],
"name": "virtualAccounts"
},
"cUOM": {
"target": "/api/device/hcmf/CUOM/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "cUOM",
"required": false,
"choices": [],
"target_model_type": "device/hcmf/CUOM",
"type": [
"string",
"null"
],
"name": "cUOM"
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "syncTimestamp",
"title": "syncTimestamp"
}
},
"title": "Sdr Cluster"
},
"vossApplication": {
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "The administrator Username to connect to the Cisco Unified Communications Manager.",
"title": "Admin Username"
},
"description": {
"required": false,
"type": "string",
"description": "The description of the Cisco Unified Communications Manager.",
"title": "Description"
},
"notes": {
"readonly": false,
"required": false,
"type": "string",
"description": "CUCM Cluster Notes Field",
"title": "CUCM Cluster Notes"
},
"host": {
"required": true,
"type": "string",
"description": "The host name of the Cisco Unified Communications Manager.",
"title": "Host Name"
},
"version": {
"choices": [
{
"value": "9.1",
"title": "9.1"
},
{
"value": "10.0",
"title": "10.0"
},
{
"value": "10.5",
"title": "10.5"
},
{
"value": "11.5",
"title": "11.5"
},
{
"value": "12.5",
"title": "12.5"
},
{
"value": "14.0",
"title": "14.0"
}
],
"required": true,
"type": "string",
"description": "The selected version of the Cisco Unified Communications Manager to connect to. The list of versions is maintained in the CallManagerVersion model.",
"title": "Version"
},
"import": {
"type": "boolean",
"description": "Deprecated.",
"title": "Immediate Import"
},
"password": {
"is_password": true,
"description": "The administrator Password associated with the Username to connect to the Cisco Unified Communications Manager. The text will be hidden.",
"title": "Admin Password",
"required": true,
"store_encrypted": true,
"type": "string"
},
"port": {
"default": "8443",
"type": "string",
"description": "The port on the Cisco Unified Communications Manager server to connect to.",
"title": "Port"
}
},
"title": "Voss Application"
},
"cUCMCluster": {
"target": "/api/device/hcmf/CUCMCluster/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "cUCMCluster",
"required": true,
"choices": [],
"target_model_type": "device/hcmf/CUCMCluster",
"type": "string",
"name": "cUCMCluster"
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "syncTimestamp",
"title": "syncTimestamp"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Relation Hcs Call Manager Rel"
},
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoCUCM-WFC_REL 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/relation/CustomerBuild-AddCiscoCUCM-WFC_REL | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]to inspect the created resource and its instance pkid.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for relation/CustomerBuild-AddCiscoCUCM-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoCUCM-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoCUCM-WFC_REL instances)
{
"operations": [
"field_display_policy",
"configuration_template",
"help",
"get",
"export_bulkload_template",
"list",
"update",
"remove",
"add",
"bulk_update",
"export"
],
"pagination": {
"direction": "asc",
"order_by": "name",
"maximum_limit": 2000,
"skip": 0,
"current": "/api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"self": [
{
"pkid": null,
"href": "/api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/None/"
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/CustomerBuild-AddCiscoCUCM-WFC_REL",
"model_specific_actions": [
"add",
"export",
"get",
"export_bulkload_template",
"list",
"update",
"remove"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoCUCM-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoCUCM-WFC_REL instance with [pkid]. |