GET http://[host-proxy]/api/data/ucprep_UC_Profiles/schema/?hierarchy=[hierarchy]&format=json&schema=1
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"ucprep_profilename": {
"type": "string",
"title": "UC Prep Profile Name"
},
"ucprep_profile_notes": {
"type": "string",
"title": "UC Prep Profile Notes"
},
"cucm_ip_array": {
"items": {
"type": "object",
"properties": {
"cucm_currenthost": {
"target": "/api/device/cucm/CallManager/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Current ID",
"target_attr": "name",
"type": "string",
"description": "Current ID Used in Call Manager",
"target_model_type": "device/cucm/CallManager",
"choices": []
},
"cucm_newname": {
"type": "string",
"description": "New Host Identifier",
"title": "New Host Identifier"
},
"cucm_autoreg_startdn": {
"type": "string",
"description": "Starting Directory Number",
"title": "Starting Directory Number"
},
"cucm_autoreg_enddn": {
"type": "string",
"description": "Ending Directory Number",
"title": "Ending Directory Number"
},
"cucm_autoreg_disabled": {
"choices": [
{
"value": "true",
"title": "Enabled"
},
{
"value": "false",
"title": "Disabled"
}
],
"type": "string",
"title": "Auto-registration on this Cisco Unified Communications Manager"
},
"cucm_autoreg_ult": {
"target": "/api/device/cucm/UniversalLineTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Manager Universal Line Template",
"target_attr": "name",
"type": "string",
"description": "Required ULT for autoregistration",
"target_model_type": "device/cucm/UniversalLineTemplate",
"choices": []
},
"cucm_autoreg_udt": {
"target": "/api/device/cucm/UniversalDeviceTemplate/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Call Manager Universal Device Template",
"target_attr": "name",
"type": "string",
"description": "Required UDT for autoregistration",
"target_model_type": "device/cucm/UniversalDeviceTemplate",
"choices": []
}
}
},
"type": "array",
"description": "Call Manager Hostname",
"title": "Call Manager Hostname"
},
"tz_cft": {
"target_attr": "name",
"type": "string",
"description": "Template to conifigure the details of the Date Time groups. eg: separator, format",
"title": "Date/Time Group Configuration Template"
},
"TimeZone": {
"items": {
"type": "object",
"properties": {
"dtg_custom": {
"type": "string",
"description": "DTG Custom Name",
"title": "DTG Custom Name"
},
"timezone": {
"target_attr": "timezone",
"type": "string",
"target": "/api/data/ucprep_friendlytimezones/choices/?field=timezone&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"target_model_type": "data/ucprep_friendlytimezones",
"choices": []
}
}
},
"type": "array",
"description": "TimeZone add as an array from data model of friendly time zone names",
"title": "Date/Time Group Add"
},
"add_cucmgroup": {
"items": {
"type": "object",
"properties": {
"cmg_Name": {
"type": "string",
"title": "Call Manager Group Name"
},
"cmg_membersarray": {
"items": {
"type": "object",
"properties": {
"cmg_members": {
"target": "/api/device/cucm/CallManager/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Member",
"target_attr": "name",
"type": "string",
"description": "Member",
"target_model_type": "device/cucm/CallManager",
"choices": []
}
}
},
"type": "array",
"description": "Members (In Order)",
"title": "Members (In Order)"
}
}
},
"type": "array",
"description": "Add Standard CUCM Group",
"title": "Standard CUCM Group"
},
"cucm_appuserarray": {
"items": {
"type": "object",
"properties": {
"appuser_userid": {
"target": "/api/data/ucprep_appusers/choices/?field=username&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "User ID",
"target_attr": "username",
"type": "string",
"description": "User ID Dropdown driven by data/ucprep_appusers data model",
"target_model_type": "data/ucprep_appusers",
"choices": []
},
"appuser_pw": {
"is_password": true,
"description": "Password",
"title": "Password",
"store_encrypted": false,
"type": "string"
},
"appuser_cntldevarray": {
"items": {
"type": "object",
"properties": {
"appuser_cntldev": {
"target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Device",
"target_attr": "name",
"type": "string",
"description": "Device to add - Replace URI with gui rule for scope down",
"target_model_type": "device/cucm/Phone",
"choices": []
}
}
},
"type": "array",
"description": "Controlled Devices",
"title": "Controlled Devices"
},
"appuser_contdparray": {
"description": "CTI Controlled Device Profiles",
"title": "CTI Controlled Device Profiles",
"items": {
"type": "object",
"properties": {
"appuser_contdp": {
"target": "/api/device/cucm/DeviceProfile/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Device Profile",
"target_attr": "name",
"type": "string",
"description": "Device Profile",
"target_model_type": "device/cucm/DeviceProfile",
"choices": []
}
}
},
"target_attr": "name",
"type": "array"
},
"appuser_grouparray": {
"items": {
"type": "object",
"properties": {
"appuser_group": {
"target": "/api/device/cucm/UserGroup/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Group",
"target_attr": "name",
"type": "string",
"description": "Group",
"target_model_type": "device/cucm/UserGroup",
"choices": []
}
}
},
"type": "array",
"description": "Group Permissions",
"title": "Group Permissions"
}
}
},
"type": "array",
"description": "Add Application Users",
"title": "Application Users"
},
"cucm_fcp_array": {
"items": {
"type": "object",
"properties": {
"policy_name": {
"type": "string",
"description": "Unique Name of Policy",
"title": "Policy Name"
},
"policy_desc": {
"type": "string",
"description": "Policy Description",
"title": "Policy Description"
},
"policy_barge": {
"type": "boolean",
"title": "Barge"
},
"policy_callback": {
"type": "boolean",
"description": "Call Back",
"title": "Call Back"
},
"policy_callpickup": {
"type": "boolean",
"description": "Call Pickup",
"title": "Call Pickup"
},
"policy_conflist": {
"type": "boolean",
"description": "Conference List",
"title": "Conference List"
},
"policy_divertalert": {
"type": "boolean",
"description": "Divert (Alerting)",
"title": "Divert (Alerting)"
},
"policy_divertconn": {
"type": "boolean",
"description": "Divert (Connected)",
"title": "Divert (Connected)"
},
"policy_fwdall": {
"type": "boolean",
"description": "Forward All",
"title": "Forward All"
},
"policy_groupcallpu": {
"type": "boolean",
"description": "Group Call PickUp",
"title": "Group Call PickUp"
},
"policy_meetme": {
"type": "boolean",
"description": "Meet Me",
"title": "Meet Me"
},
"policy_mobility": {
"type": "boolean",
"description": "Mobility",
"title": "Mobility"
},
"policy_ocp": {
"type": "boolean",
"description": "Other Call PickUp",
"title": "Other Call PickUp"
},
"policy_park": {
"type": "boolean",
"description": "Park",
"title": "Park"
},
"policy_redial": {
"type": "boolean",
"description": "Redial",
"title": "Redial"
},
"policy_reportcaller": {
"type": "boolean",
"description": "Report Caller",
"title": "Report Caller"
},
"policy_reportquality": {
"type": "boolean",
"description": "Report Quality",
"title": "Report Quality"
},
"policy_speeddial": {
"type": "boolean",
"description": "Speed Dial",
"title": "Speed Dial"
}
}
},
"type": "array",
"title": "Feature Control Policy"
},
"cucm_sipprof_array": {
"items": {
"type": "object",
"properties": {
"sip_p_name": {
"type": "string",
"title": "Name"
},
"sip_p_desc": {
"type": "string",
"title": "Description"
},
"sip_p_fqdnreq": {
"type": "boolean",
"description": "Use Fully Qualified Domain Name in SIP Requests",
"title": "Use Fully Qualified Domain Name in SIP Requests"
},
"sip_p_redirectByApplication": {
"default": false,
"type": "boolean",
"description": "Redirect By Application",
"title": "Redirect By Application"
},
"sip_p_phregdelta": {
"default": "5",
"type": "string",
"description": "Phone Parameters: Timer Register Delta",
"title": "Phone Parameters: Timer Register Delta"
},
"sip_p_phregexpires": {
"default": "3600",
"type": "string",
"description": "Phone Parameters: Timer Register Expires (seconds)",
"title": "Phone Parameters: Timer Register Expires (seconds)"
},
"sip_p_phkaexpires": {
"default": "120",
"type": "string",
"title": "Phone Parameters: Timer Keep Alive Expires (seconds)"
},
"sip_p_phsubexpires": {
"default": "120",
"type": "string",
"title": "Phone Parameters: Timer Subscribe Expires (seconds)"
},
"sip_p_phtimesubdelta": {
"default": "5",
"type": "string",
"title": "Phone Parameters: Timer Subscribe Delta (seconds)"
},
"sip_p_trk_rel1xx": {
"choices": [
{
"value": "Disabled",
"title": "Disabled"
},
{
"value": "Send PRACK if 1xx Contains SDP",
"title": "Send PRACK if 1xx Contains SDP"
},
{
"value": "Send PRACK for all 1xx Messages",
"title": "Send PRACK for all 1xx Messages"
}
],
"type": "string",
"title": "Trunk Configuration: SIP Rel1XX Options"
},
"sip_p_trk_clidp": {
"choices": [
{
"value": "Default",
"title": "Default"
},
{
"value": "Strict From URI presentation Only",
"title": "Strict From URI presentation Only"
},
{
"value": "Strict Identity Headers presentation Only",
"title": "Strict Identity Headers presentation Only"
}
],
"type": "string",
"title": "Trunk Configuration: Calling Line Identification Presentation"
},
"sip_p_trk_refreshmeth": {
"choices": [
{
"value": "Invite",
"title": "Invite"
},
{
"value": "Update",
"title": "Update"
}
],
"type": "string",
"title": "Trunk Configuration: Session Refresh Method"
},
"sip_p_trk_anat": {
"type": "boolean",
"title": "Trunk Configuration: Enable ANAT"
},
"sip_p_trk_deliverid": {
"type": "boolean",
"title": "Trunk Configuration: Deliver Conference Bridge Identifier"
},
"sip_p_ping_option": {
"type": "boolean",
"title": "Enable OPTIONS Ping to monitor destination status for Trunks with Service Type \"None (Default)\""
},
"sip_p_bfcp": {
"type": "boolean",
"title": "SDP Information: Allow Presentation Sharing using BFCP"
}
}
},
"type": "array",
"title": "Call Manager SIP Profiles"
},
"cucm_stsp_array": {
"items": {
"type": "object",
"properties": {
"stsp_name": {
"type": "string",
"description": "name",
"title": "Name"
},
"stsp_description": {
"type": "string",
"description": "Description",
"title": "Description"
},
"stsp_devicesecuritymode": {
"choices": [
{
"value": "Non Secure",
"title": "Non Secure"
},
{
"value": "Authenticated",
"title": "Authenticated"
},
{
"value": "Encrypted",
"title": "Encrypted"
}
],
"type": "string",
"description": "Device Security Mode",
"title": "Device Security Mode"
},
"stsp_incomingtransport": {
"description": "Incoming Transport Type",
"title": "Incoming Transport Type",
"required": true,
"choices": [
{
"value": "TLS",
"title": "TLS"
},
{
"value": "TCP+UDP",
"title": "TCP+UDP"
}
],
"type": "string"
},
"stsp_outgoingtransport": {
"choices": [
{
"value": "TCP",
"title": "TCP"
},
{
"value": "UDP",
"title": "UDP"
},
{
"value": "TLS",
"title": "TLS"
}
],
"type": "string",
"description": "Outgoing Transport Type",
"title": "Outgoing Transport Type"
},
"stsp_enabledigest": {
"type": "boolean",
"description": "Enable Digest Authentication",
"title": "Enable Digest Authentication"
},
"stsp_acceptpresence": {
"type": "boolean",
"description": "Accept presence subscription",
"title": "Accept presence subscription"
},
"stsp_acceptoutofdialog": {
"type": "boolean",
"description": "Accept out-of-dialog refer",
"title": "Accept out-of-dialog refer"
},
"stsp_acceptunsolicited": {
"type": "boolean",
"description": "Accept unsolicited notification",
"title": "Accept unsolicited notification"
},
"stsp_acceptrepheader": {
"type": "boolean",
"description": "Accept replaces header",
"title": "Accept replaces header"
},
"stsp_inport": {
"default": "5060",
"type": "string",
"description": "Incoming TCP SIP Port",
"title": "Incoming SIP Port"
}
}
},
"type": "array",
"description": "Sip Trunk Security Profile",
"title": "Sip Trunk Security Profile"
},
"cucm_routefilter_array": {
"items": {
"type": "object",
"properties": {
"rf_cft": {
"target": "data/ConfigurationTemplate",
"title": "Route Filter Template to Apply",
"target_attr": "name",
"type": "string",
"description": "Route Filter Template to Apply"
}
}
},
"type": "array",
"title": "Route Filters"
},
"add_cucwebauthcft": {
"target_attr": "name",
"type": "string",
"description": "Web Authentication Rule CFT to update the CUC Web Authentication Rules",
"title": "Web Authentication Rule CFT"
},
"add_cucvmauth": {
"type": "boolean",
"description": "Voice Authentication Rule Modify Option",
"title": "Update Voice Mail Authentication Rules"
},
"add_cucvmauthcft": {
"target": "data/ConfigurationTemplate",
"title": "Voice Authentication Rule CFT",
"target_attr": "name",
"type": "string",
"description": "Voice Authentication Rule CFT"
},
"unity_usertemplatearray": {
"items": {
"type": "object",
"properties": {
"unity_chosencft": {
"target": "data/ConfigurationTemplate",
"title": "CUC User Template CFT",
"target_attr": "name",
"type": "string",
"description": "CUC User Template CFT"
},
"unity_ut_alias": {
"type": "string",
"description": "Alias",
"title": "Alias"
},
"unity_ut_display": {
"type": "string",
"description": "Display Name",
"title": "Display Name"
},
"unity_ut_bat": {
"target": "/api/device/cuc/UserTemplate/choices/?field=Alias&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Based On Template",
"target_attr": "Alias",
"type": "string",
"description": "Based On Template",
"target_model_type": "device/cuc/UserTemplate",
"choices": []
},
"unity_ut_phonesystem": {
"target": "/api/device/cuc/PhoneSystem/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Phone System",
"target_attr": "DisplayName",
"type": "string",
"description": "Phone System",
"target_model_type": "device/cuc/PhoneSystem",
"choices": []
},
"unity_ut_cos": {
"target": "/api/device/cuc/Cos/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Class Of Service",
"target_attr": "DisplayName",
"type": "string",
"description": "Class Of Service",
"target_model_type": "device/cuc/Cos",
"choices": []
},
"unity_ut_partition": {
"target": "/api/device/cuc/Partition/choices/?field=Name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Partition",
"target_attr": "Name",
"type": "string",
"description": "Partition",
"target_model_type": "device/cuc/Partition",
"choices": []
},
"unity_ut_css": {
"target": "/api/device/cuc/SearchSpace/choices/?field=Name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Search Scope",
"target_attr": "Name",
"type": "string",
"description": "Search Scope",
"target_model_type": "device/cuc/SearchSpace",
"choices": []
},
"unity_ut_map": {
"target": "/api/device/cuc/MessageAgingPolicy/choices/?field=DisplayName&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"format": "uri",
"title": "Message Aging Policy",
"target_attr": "DisplayName",
"type": "string",
"description": "Message Aging Policy",
"target_model_type": "device/cuc/MessageAgingPolicy",
"choices": []
}
}
},
"type": "array",
"description": "Unity User Template",
"title": "Unity User Template"
},
"cucm_audiocodecprefs": {
"items": {
"type": "object",
"properties": {
"acpl_cft": {
"target": "data/ConfigurationTemplate",
"title": "Configuration Template to Apply",
"target_attr": "name",
"type": "string",
"description": "Configuration Template to apply"
}
}
},
"type": "array",
"description": "Audio Codec Preference List",
"title": "Audio Codec Preference List"
},
"add_cucwebauth": {
"type": "boolean",
"description": "Web Authentication Update Option",
"title": "Update Web Authentication Rules"
},
"cucm_phone_services_remove": {
"items": {
"type": "string"
},
"type": "array",
"description": "CUCM Phone Services to remove",
"title": "Remove CUCM Phone Services"
},
"cucm_phone_services_add": {
"items": {
"type": "object",
"properties": {
"serviceName": {
"type": "string",
"title": "Service Name"
},
"serviceDescription": {
"type": "string",
"title": "Service Description"
},
"serviceUrl": {
"type": "string",
"title": "Service URL"
},
"serviceCategory": {
"default": "XML Service",
"type": "string",
"title": "Service Category"
},
"serviceType": {
"default": "Standard IP Phone Service",
"type": "string",
"title": "Service Type"
},
"enabled": {
"default": false,
"type": "boolean",
"title": "Enabled"
},
"enterpriseSubscription": {
"default": false,
"type": "boolean",
"title": "Enterprise Subscription"
}
}
},
"type": "array",
"description": "CUCM Phone Services to add",
"title": "Add CUCM Phone Services"
},
"cucm_sip_normalization_scripts": {
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"content": {
"type": "string",
"title": "Script"
},
"systemResourceErrorRecoveryAction": {
"default": "Disable Script",
"type": "string",
"title": "System Resource Error Recovery Action"
},
"scriptExecutionErrorRecoveryAction": {
"default": "Message Rollback Only",
"type": "string",
"title": "Script Execution Error Recovery Action"
},
"maxMemoryThreshold": {
"default": "50",
"type": "string",
"title": "Maximum Memory Threshold"
},
"maxLuaInstructionsThreshold": {
"default": "1000",
"type": "string",
"title": "Maximum Lua Instructions Threshold"
},
"isStandard": {
"default": false,
"type": "boolean",
"title": "Is Standard"
}
}
},
"type": "array",
"description": "CUCM SIP Normalization Scripts",
"title": "CUCM SIP Normalization Scripts"
}
},
"schema_version": "0.4"
}