[Index]
CustomerBuild-AddCiscoCUC-WFC_REL
Model ref.: relation/CustomerBuild-AddCiscoCUC-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": {
"name": {
"is_password": false,
"title": "Name",
"required": true,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"relation_HcsUnityConnectionREL": {
"title": "Relation Hcs Unity Connection Rel",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"isUCPublisher": {
"title": "Is UC Publisher",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": false
},
"name": {
"title": "Server Name",
"type": "string",
"maxLength": 64,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"description": {
"title": "Description",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"typeDeploymentMode": {
"title": "Type Deployment Mode",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"choices": [
{
"value": "HCS",
"title": "HCS"
},
{
"value": "HCS_LE",
"title": "HCS_LE"
},
{
"value": "ENTERPRISE",
"title": "ENTERPRISE"
}
]
},
"isAutoLinked": {
"title": "Is Auto Linked",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": true
},
"routingId": {
"title": "Routing Id",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"cUCxnCluster": {
"title": "CUCxn Cluster",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCxnClusterDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUCxnClusterDAT",
"choices": []
},
"virtualMachine": {
"title": "Virtual Machine",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfVirtualMachineDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfVirtualMachineDAT",
"choices": []
},
"credentials": {
"title": "Credentials",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "object",
"is_password": false,
"properties": {
"description": {
"title": "Description",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"typeCredential": {
"title": "Type Credential",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"displayable": false,
"is_password": false,
"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"
}
]
},
"userID": {
"title": "User ID",
"type": "string",
"maxLength": 256,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"password_CommunityString": {
"title": "Password Community String",
"type": "string",
"maxLength": 512,
"required": false,
"readonly": false,
"displayable": false,
"is_password": true,
"store_encrypted": true
},
"typeSNMPAccess": {
"title": "Type SNMP Access",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false,
"default": "RO",
"choices": [
{
"value": "RO",
"title": "RO"
},
{
"value": "RW",
"title": "RW"
}
]
}
}
}
},
"networkAddresses": {
"title": "Network Addresses",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "object",
"is_password": false,
"properties": {
"typeAddressSpace": {
"title": "Type Address Space",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"displayable": false,
"is_password": false,
"choices": [
{
"value": "APPLICATION_SPACE",
"title": "APPLICATION_SPACE"
},
{
"value": "SERVICE_PROVIDER_SPACE",
"title": "SERVICE_PROVIDER_SPACE"
},
{
"value": "CUSTOMER_SPACE",
"title": "CUSTOMER_SPACE"
}
]
},
"description": {
"title": "Description",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"iPAddrV4": {
"title": "IP Addr V4",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"iPAddrV6": {
"title": "IP Addr V6",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"hostShortNameOnly": {
"title": "Host Short Name Only",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"domain": {
"title": "Domain",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"displayable": false,
"is_password": false
},
"isSRVAddress": {
"title": "Is SRV Address",
"type": "boolean",
"required": true,
"readonly": false,
"displayable": false,
"is_password": false,
"default": false
}
}
}
},
"bkCUCxnCluster_name": {
"title": "Cluster Name",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCxnClusterDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HCSHcmfCUCxnClusterDAT",
"choices": []
},
"sdrCluster": {
"title": "Sdr Cluster",
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"typeCucxnSharingMode": {
"title": "Type Cucxn Sharing Mode",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "DEDICATED",
"choices": [
{
"value": "DEDICATED",
"title": "DEDICATED"
},
{
"value": "SHARED",
"title": "SHARED"
},
{
"value": "PARTITIONED",
"title": "PARTITIONED"
}
]
},
"name": {
"title": "Name",
"type": "string",
"maxLength": 128,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false
},
"clusterID": {
"title": "Cluster ID",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"callProcessingID": {
"title": "Call Processing ID",
"type": "string",
"maxLength": 64,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"description": {
"title": "Description",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"typeAppVersion": {
"title": "Type App Version",
"type": "string",
"maxLength": 1024,
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"choices": [
{
"value": "VERSION_PRE_8_6",
"title": "VERSION_PRE_8_6"
},
{
"value": "VERSION_8_6",
"title": "VERSION_8_6"
},
{
"value": "VERSION_9_0",
"title": "VERSION_9_0"
},
{
"value": "VERSION_9_1",
"title": "VERSION_9_1"
},
{
"value": "VERSION_10_0",
"title": "VERSION_10_0"
},
{
"value": "VERSION_10_5",
"title": "VERSION_10_5"
}
]
},
"isManualMode": {
"title": "Is Manual Mode",
"type": "boolean",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": false
},
"email": {
"title": "Email",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"countryCode": {
"title": "Country Code",
"type": "string",
"maxLength": 8,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"numEndUserSubscribers": {
"title": "Num End User Subscribers",
"type": "integer",
"maximum": 65535,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"eLMID": {
"title": "ELMID",
"type": "string",
"maxLength": 128,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false
},
"cUOM": {
"title": "CUOM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUOMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCUOMDAT",
"choices": []
},
"eLM": {
"title": "ELM",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfELMDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfELMDAT",
"choices": []
},
"ownsOrgUnit": {
"title": "Owns Org Unit",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfOrgUnitDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfOrgUnitDAT",
"choices": []
},
"monitorsPrimeCollab": {
"title": "Monitors Prime Collab",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfPrimeCollabDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfPrimeCollabDAT",
"choices": []
},
"customers": {
"title": "Customers",
"type": "array",
"minItems": 0,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"items": {
"type": "string",
"format": "uri",
"is_password": false,
"target": "/api/data/HCSHcmfCustomerDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "data/HCSHcmfCustomerDAT",
"choices": []
}
}
}
},
"vossApplication": {
"title": "Voss Application",
"type": "object",
"properties": {
"host": {
"required": true,
"type": "string",
"description": "The host name of the Cisco Unity Connection server.",
"title": "Host Name"
},
"username": {
"required": true,
"type": "string",
"description": "The administrator Username to connect to the Cisco Unity Connection server.",
"title": "Admin Username"
},
"password": {
"is_password": true,
"description": "The administrator Password associated with the Username to connect to the Cisco Unity Connection server. The text will be hidden.",
"title": "Admin Password",
"required": true,
"store_encrypted": true,
"type": "string"
},
"version": {
"description": "The version of the Cisco Unity Connection server to connect to.",
"title": "Version",
"required": true,
"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"
}
],
"type": "string"
},
"port": {
"default": "443",
"type": "string",
"description": "The port on the Cisco Unity Connection server to connect to.",
"title": "Port"
},
"description": {
"description": "The description of the Cisco Unified Communications Manager.",
"title": "Description",
"required": false,
"readonly": false,
"type": "string"
},
"notes": {
"description": "CUC Cluster Notes Field",
"title": "CUC Cluster Notes",
"required": false,
"readonly": false,
"type": "string"
}
}
},
"vossCluster": {
"title": "Voss Cluster",
"type": "object",
"properties": {
"name": {
"title": "Name",
"description": "The (unique) name of the CUCxn cluster.",
"type": "string",
"maxLength": 1024,
"format": "uri",
"required": true,
"readonly": false,
"is_password": false,
"displayable": false,
"target": "/api/data/HCSHcmfCUCxnClusterDAT/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "name",
"target_model_type": "data/HCSHcmfCUCxnClusterDAT",
"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 CUCxns 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 CUCxn",
"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 partitioned for multiple customers",
"type": "string",
"maxLength": 1024,
"required": false,
"readonly": false,
"is_password": false,
"displayable": false,
"default": "(( macro.HcsCustomerHnCountMCR > 0 )) <Dedicated> <Partitioned>",
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Partitioned",
"title": "Partitioned"
}
]
},
"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": []
}
}
}
}
}
}
}
},
"maxItems": 1
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/add/ |
|
The GUI Add form of relation/CustomerBuild-AddCiscoCUC-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-AddCiscoCUC-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-AddCiscoCUC-WFC_REL | POST | /api/relation/CustomerBuild-AddCiscoCUC-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-AddCiscoCUC-WFC_REL/ |
|
The relation/CustomerBuild-AddCiscoCUC-WFC_REL schema and all instances as JSON. |
(The list will return 0 to 3 relation/CustomerBuild-AddCiscoCUC-WFC_REL instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"list",
"help",
"field_display_policy",
"get",
"configuration_template",
"update",
"bulk_update",
"export",
"add",
"remove",
"export_bulkload_template"
],
"meta": {
"model_type": "relation/CustomerBuild-AddCiscoCUC-WFC_REL",
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"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": [],
"self": [
{
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/None/",
"pkid": null
}
]
},
"model_specific_actions": [
"list",
"update",
"remove",
"add",
"export",
"export_bulkload_template",
"get"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"export_bulkload_template": {
"method": "POST",
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
}
]
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoCUC-WFC_REL instance with [pkid]. |