[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": {
"items": {
"type": "object",
"properties": {
"vossApplication": {
"type": "object",
"properties": {
"username": {
"required": true,
"type": "string",
"description": "The administrator Username to connect to the Cisco Unity Connection server.",
"title": "Admin Username"
},
"description": {
"readonly": false,
"required": false,
"type": "string",
"description": "The description of the Cisco Unified Communications Manager.",
"title": "Description"
},
"notes": {
"readonly": false,
"required": false,
"type": "string",
"description": "CUC Cluster Notes Field",
"title": "CUC Cluster Notes"
},
"host": {
"required": true,
"type": "string",
"description": "The host name of the Cisco Unity Connection server.",
"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 version of the Cisco Unity Connection server to connect to.",
"title": "Version"
},
"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"
},
"port": {
"default": "443",
"type": "string",
"description": "The port on the Cisco Unity Connection server to connect to.",
"title": "Port"
}
},
"title": "Voss Application"
},
"description": {
"type": [
"string",
"null"
],
"name": "description",
"title": "description"
},
"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"
},
"cUCxnCluster": {
"target": "/api/device/hcmf/CUCxnCluster/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "cUCxnCluster",
"required": true,
"choices": [],
"target_model_type": "device/hcmf/CUCxnCluster",
"type": "string",
"name": "cUCxnCluster"
},
"type": {
"name": "type",
"title": "type",
"default": "CUCxn",
"required": true,
"readonly": true,
"type": "string"
},
"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"
},
"bkCUCxnCluster_name": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "bkCUCxnCluster_name",
"title": "Cluster Name"
},
"name": {
"required": true,
"type": "string",
"name": "name",
"searchable": "CUCxn",
"title": "CUCxn Server Name"
},
"routingId": {
"type": [
"string",
"null"
],
"name": "routingId",
"searchable": "CUCxn",
"title": "routingId"
},
"isUCPublisher": {
"default": false,
"type": [
"boolean",
"null"
],
"name": "isUCPublisher",
"searchable": "CUCxn",
"title": "isUCPublisher"
},
"isModifiable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isModifiable",
"title": "isModifiable"
},
"cdmUpdateTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "cdmUpdateTimestamp",
"title": "cdmUpdateTimestamp"
},
"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"
},
"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"
},
"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": "CUCxnCluster",
"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": "CUCxnCluster",
"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"
},
"typeCucxnSharingMode": {
"default": "DEDICATED",
"choices": [
[
"DEDICATED",
"DEDICATED"
],
[
"SHARED",
"SHARED"
],
[
"PARTITIONED",
"PARTITIONED"
]
],
"type": [
"string",
"null"
],
"name": "typeCucxnSharingMode",
"title": "typeCucxnSharingMode"
},
"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": "CUCxnCluster",
"title": "name"
},
"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"
},
"lastSuccessfulTime": {
"type": [
"string",
"null"
],
"name": "lastSuccessfulTime",
"title": "lastSuccessfulTime"
},
"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"
},
"vossCluster": {
"type": "object",
"properties": {
"filter_move_mode": {
"is_password": false,
"description": "The behavior for moving users to site. Setting this value to Automatic will trigger the system to apply the move filters (refer to User Management) automatically when users are sync'd into the system. Automatic is only applicable to creating new users. Setting this value to Manual means that users must be moved to site by an Adminstrator (refer to User Management).",
"title": "User Move Mode",
"default": "Automatic",
"required": false,
"displayable": false,
"choices": [
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "Manual",
"title": "Manual"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"name": {
"is_password": false,
"description": "The (unique) name of the CUCxn cluster.",
"format": "uri",
"title": "Name",
"required": true,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "device/hcmf/CUCxnCluster",
"type": "string",
"target": "/api/device/hcmf/CUCxnCluster/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"hostNameOrIP": {
"is_password": false,
"description": "The hostname or IPV4 of the CUCxn",
"title": "HostNameOrIP",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"migrate": {
"is_password": false,
"description": "Migrate HCM-F Models to CUCDM Models",
"title": "Migrate from HCM-F to CUCDM",
"default": "false",
"required": false,
"displayable": false,
"readonly": false,
"type": "boolean"
},
"misc_data": {
"is_password": false,
"description": "Miscellaneous data used at run-time",
"title": "Misc Data",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"version": {
"is_password": false,
"description": "Indicates the version of the CUCxns within the cluster.",
"format": "uri",
"title": "Version",
"required": false,
"displayable": false,
"choices": [],
"target_attr": "name",
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsVossToSdrVersionMap",
"type": "string",
"target": "/api/data/HcsVossToSdrVersionMap/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"default_entitlement_profile": {
"is_password": false,
"description": "The Entitlement Profile assigned to users imported from this UC Application.",
"format": "uri",
"title": "User Entitlement Profile",
"required": false,
"displayable": false,
"choices": [],
"readonly": false,
"maxLength": 1024,
"target_model_type": "data/HcsEntitlementProfileDAT",
"type": "string",
"target": "/api/data/HcsEntitlementProfileDAT/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"monitoring": {
"properties": {
"arbitrators": {
"items": {
"type": "string",
"choices": []
},
"type": "array",
"description": "Select the Assurance Arbitrator servers to configure for monitoring this cluster.",
"title": "Assurance Arbitrator Servers"
},
"credential_type": {
"default": "ADMIN",
"choices": [
{
"value": "SNMP_V1",
"title": "SNMP_V1"
},
{
"value": "SNMP_V2",
"title": "SNMP_V2"
},
{
"value": "SNMP_V3",
"title": "SNMP_V3"
},
{
"value": "ADMIN",
"title": "ADMIN"
},
{
"value": "PLATFORM",
"title": "PLATFORM"
},
{
"value": "WMI",
"title": "WMI"
},
{
"value": "IOS_ENABLE",
"title": "IOS_ENABLE"
},
{
"value": "HTTP",
"title": "HTTP"
},
{
"value": "CLI",
"title": "CLI"
},
{
"value": "OPERATOR",
"title": "OPERATOR"
},
{
"value": "SFTP",
"title": "SFTP"
},
{
"value": "JTAPI",
"title": "JTAPI"
}
],
"type": "string",
"description": "Select the credential type to use for the monitoring.",
"title": "Credential Type"
}
},
"type": "object",
"description": "Manage Monitoring for this Cluster",
"title": "Monitoring"
},
"multi_tenant": {
"is_password": false,
"description": "Indicates whether the cluster applications are dedicated to a customer, or partitioned for multiple customers",
"title": "Multi-Tenant",
"default": "(( macro.HcsCustomerHnCountMCR > 0 )) <Dedicated> <Partitioned>",
"required": false,
"displayable": false,
"choices": [
{
"value": "Dedicated",
"title": "Dedicated"
},
{
"value": "Partitioned",
"title": "Partitioned"
}
],
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"sync_on_save": {
"type": "boolean",
"description": "If this checkbox is selected, then when saving this form (on either create or update), it will also immediately trigger the auto-import (sync) of this UC App server now.",
"title": "Sync on Create/Update"
}
},
"title": "Voss Cluster"
},
"id": {
"type": [
"string",
"null"
],
"name": "id",
"title": "id"
},
"syncTimestamp": {
"readonly": true,
"type": [
"string",
"null"
],
"name": "syncTimestamp",
"title": "syncTimestamp"
},
"isDeletable": {
"readonly": true,
"type": [
"boolean",
"null"
],
"name": "isDeletable",
"title": "isDeletable"
}
}
},
"type": "array",
"maxItems": 1,
"title": "Relation Hcs Unity Connection Rel"
}
}
}
| 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)
{
"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-AddCiscoCUC-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-AddCiscoCUC-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-AddCiscoCUC-WFC_REL/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"export_bulkload_template": {
"support_async": false,
"class": "bulkload_template",
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/relation/CustomerBuild-AddCiscoCUC-WFC_REL/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
}
],
"model_type": "relation/CustomerBuild-AddCiscoCUC-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-AddCiscoCUC-WFC_REL/[pkid] | hierarchy=[hierarchy] | The relation/CustomerBuild-AddCiscoCUC-WFC_REL instance with [pkid]. |