[Index]
Site Defaults Doc
Model ref.: data/SiteDefaultsDoc
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": { "defaultuserrole": { "target": "/api/data/Role/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "title": "Default User Role", "default": "selfservice", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/Role", "type": "string" }, "defaultTeamsMessagingPolicy": { "type": "string", "description": "Default TeamsMessagingPolicy", "title": "Default Teams Messaging Policy" }, "defaultplarcss": { "target": "device/cucm/Css", "title": "Default PLAR CSS", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "name", "readonly": false, "type": "string" }, "custom_boolean_10": { "type": "boolean", "title": "custom_boolean_10" }, "default_cucm_sip_profile": { "type": "string", "title": "Default CUCM SIP Profile" }, "defaultTeamsCallParkPolicy": { "type": "string", "description": "Default TeamsCallParkPolicy", "title": "Default Teams Call Park Policy" }, "defaultTeamsVideoInteropServicePolicy": { "type": "string", "description": "Default TeamsVideoInteropServicePolicy", "title": "Default Teams Video Interop Service Policy" }, "defaultlinecfnrcss": { "type": "string", "title": "Default CUCM Line Call Forward Not Registered CSS" }, "defaultTeamsMeetingBroadcastPolicy": { "type": "string", "description": "Default TeamsMeetingBroadcastPolicy", "title": "Default Teams Meeting Broadcast Policy" }, "defaultTeamsAudioConferencingPolicy": { "type": "string", "description": "Default TeamsAudioConferencingPolicy", "title": "Default Audio Conferencing Policy" }, "default_cucm_rdp_dndoption": { "is_password": false, "title": "Default CUCM Renote Destination DND Option", "items": { "is_password": false }, "required": false, "choices": [ { "value": "Ringer Off", "title": "Ringer Off" }, { "value": "Call Reject", "title": "Call Reject" }, { "value": "Use Common Phone Profile Setting", "title": "Use Common Phone Profile Setting" } ], "readonly": false, "type": "string" }, "includeMsUser": { "type": "boolean", "description": "Move Microsoft users to site level using Filter Model Criteria.", "title": "Microsoft Users" }, "msTeamsDirectRouting": { "type": "boolean", "description": "MS-Teams DirectRouting disabled on PBX-side or in the SBC", "title": "MS-Teams Direct Routing" }, "additionalDevicePools": { "items": { "type": "object", "properties": { "dpName": { "description": "Device Pool to be used during Overbuild for this site.", "title": "Device Pool Name", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "device/cucm/DevicePool", "type": "string", "target": "/api/device/cucm/DevicePool/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "dpReplace": { "type": "boolean", "description": "Replace the Device Pool with the site default Device Pool", "title": "Replace With Default Device Pool" } } }, "type": "array", "description": "Choose the Device Pools to include for the move.", "title": "Additional Device Pools" }, "defaultlinept": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Line Partition", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSitePartitions.SitePT", "readonly": false, "type": "string" }, "defaultTeamsAppSetupPolicy": { "type": "string", "description": "Default TeamsAppSetupPolicy", "title": "Default App Setup Policy" }, "includeCUCUser": { "type": "boolean", "description": "Unity Connect Users associated to phones", "title": "CUC Users" }, "default_phone_subscriber_css": { "type": "string", "title": "Default CUCM Phone Subscribe CSS" }, "defaultlinecfncicss": { "type": "string", "title": "Default CUCM Line Call Forward No Coverage Internal CSS" }, "ms365UserModelFilterCriteria": { "description": "Rule to use for matching the MSOL User. This criteria will be used to check if a user should be moved to a site when the user is synced in.", "title": "MS 365 User Model Filter Criteria", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ModelFilterCriteria", "type": "string", "target": "/api/data/ModelFilterCriteria/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "default_cucm_user_presencegroup": { "is_password": false, "title": "Default CUCM User Presence Group", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "dataUserModelFilterCriteria": { "description": "Rule to use for matching the Data User.", "title": "User Model Filter Criteria", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ModelFilterCriteria", "type": "string", "target": "/api/data/ModelFilterCriteria/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "system_flag_onopen_dp": { "is_password": false, "title": "System Flag to detect On-Open.", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcuchtmlnotificationtemplate": { "type": "string", "title": "Default CUC HTML Notification Template" }, "custom_string_10": { "type": "string", "title": "custom_string_10" }, "default_user_subscriber_css": { "type": "string", "title": "Default CUCM User Subscribe CSS" }, "name": { "is_password": false, "title": "Name", "items": { "is_password": false }, "required": true, "readonly": false, "type": "string" }, "defaultcucmgroup": { "type": "string", "title": "Default CUCM Group" }, "defaultcppt": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Call Park Partition", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSitePartitions", "readonly": false, "type": "string" }, "default_rdp_rr_css": { "type": "string", "title": "Default CUCM Remote Destination Profile ReRouting CSS" }, "defaultTeamsChannelsPolicy": { "type": "string", "description": "Default TeamsChannelsPolicy", "title": "Default Channels Policy" }, "custom_boolean_5": { "type": "boolean", "title": "custom_boolean_5" }, "defaultlinecss": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Line CSS", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSiteCSS", "readonly": false, "type": "string" }, "custom_boolean_7": { "type": "boolean", "title": "custom_boolean_7" }, "custom_boolean_6": { "type": "boolean", "title": "custom_boolean_6" }, "custom_boolean_1": { "type": "boolean", "title": "custom_boolean_1" }, "default_cucm_line_presencegroup": { "is_password": false, "title": "Default CUCM Line Presence Group", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "custom_boolean_3": { "type": "boolean", "title": "custom_boolean_3" }, "custom_boolean_2": { "type": "boolean", "title": "custom_boolean_2" }, "system_flag_onopen_phone": { "is_password": false, "title": "System Flag to detect On-Open.", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultOnlineVoiceRoutingPolicy": { "type": "string", "description": "Default OnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, "custom_boolean_9": { "type": "boolean", "title": "custom_boolean_9" }, "custom_boolean_8": { "type": "boolean", "title": "custom_boolean_8" }, "default_dp_emcc_css": { "type": "string", "title": "Default CUCM Device Profile EMCC CSS" }, "defaultTeamsAppPermissionPolicy": { "type": "string", "description": "Default TeamsAppPermissionPolicy", "title": "Default App Permission Policy" }, "useNationalMaskFormat": { "type": "boolean", "title": "Use National Mask Format" }, "msTeamsUserModelFilterCriteria": { "description": "Rule to use for matching the MSOL User.", "title": "MS Teams User Model Filter Criteria", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ModelFilterCriteria", "type": "string", "target": "/api/data/ModelFilterCriteria/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "defaultuserprofile": { "type": "string", "title": "Default User Profile (for User Self Provisioning)" }, "default_cucm_dp_protocol": { "is_password": false, "title": "Default CUCM Device Profile Protocol", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultTeamsEnhancedEncryptionPolicy": { "type": "string", "description": "Default TeamsEnhancedEncryptionPolicy", "title": "Default Enhanced Encryption Policy" }, "enterpriseVoice": { "type": "boolean", "description": "MS-Teams Users provisioned with Enterprise Voice = False and OnLine Voice Routing Policy = Not Set", "title": "Enterprise Voice" }, "custom_boolean_4": { "type": "boolean", "title": "custom_boolean_4" }, "defaultLOC": { "is_password": false, "title": "Default CUCM Location", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "includePexIpUser": { "type": "boolean", "description": "PexIP Users that have a User at Site level with same username.", "title": "PexIP Users" }, "includeContactCenterAgent": { "type": "boolean", "description": "Contact Center Agents that have a User at Site level with same user ID.", "title": "Contact Center Agents" }, "default_self_service_language": { "is_password": false, "title": "Default Self-service Language ", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcucsubscribertemplate": { "type": "string", "title": "Default CUC Subscriber Template" }, "includeWebexTeamsUser": { "type": "boolean", "description": "Webex App Users that have a User at Site level with same email address.", "title": "Webex App Users" }, "defaultcuctimezone": { "type": "string", "title": "Default CUC Timezone" }, "customer_ini": { "default": "false", "type": "boolean", "description": "Creates Internal Number Inventory at Customer level when selected, else creates INIs at Site level", "title": "Create Internal Number Inventory at Customer" }, "default_cucm_phone_template": { "is_password": false, "title": "Default CUCM Phone Button Template", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcucphonesystem": { "type": "string", "title": "Default CUC Phone System" }, "default_cucm_phone_sipprofile": { "is_password": false, "title": "Default CUCM Phone SIP Profile", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "use_org_domain": { "type": "boolean", "title": "Webex App - Use Organization's Domain" }, "custom_string_9": { "type": "string", "title": "custom_string_9" }, "custom_string_8": { "type": "string", "title": "custom_string_8" }, "custom_string_1": { "type": "string", "title": "custom_string_1" }, "custom_string_3": { "type": "string", "title": "custom_string_3" }, "custom_string_2": { "type": "string", "title": "custom_string_2" }, "custom_string_5": { "type": "string", "title": "custom_string_5" }, "custom_string_4": { "type": "string", "title": "custom_string_4" }, "custom_string_7": { "type": "string", "title": "custom_string_7" }, "custom_string_6": { "type": "string", "title": "custom_string_6" }, "defaultdevicecss": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Device CSS", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSiteCSS", "readonly": false, "type": "string" }, "calling_behaviour_uc_manager_profile": { "type": "string", "title": "Webex App - UC Manager Profile" }, "defaulthppt": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Hunt Pilot Partition", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSitePartitions.SitePT", "readonly": false, "type": "string" }, "default_cucm_line_vmprofile": { "type": "string", "title": "Default CUCM Line Voicemail Profile" }, "includePhone": { "type": "boolean", "description": "Move all phones that match search-criteria, to destination site.", "title": "Phones" }, "default_cucm_dp_e164_mask": { "type": "string", "title": "Default CUCM Device Profile Line E164 Mask" }, "default_cucm_phone_commondeviceconfig": { "is_password": false, "title": "Default CUCM Phone Common Profile", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "default_cucm_phone_softkey": { "is_password": false, "title": "Default CUCM Phone Softkey Template", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultlinecfbicss": { "type": "string", "title": "Default CUCM Line Call Forward Busy Internal CSS" }, "hotdial_time_zone": { "type": "string", "title": "Default HotDial Time Zone" }, "defaultlinecfnccss": { "type": "string", "title": "Default CUCM Line Call Forward No Coverage CSS" }, "default_cucm_phone_protocol": { "is_password": false, "title": "Default CUCM Phone Protocol", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "default_cucm_dp_template": { "is_password": false, "title": "Default CUCM Device Profile Button Template", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "includeLine": { "type": "boolean", "description": "Lines associated to 1) phones, 2) device profiles, 3) RDP's.", "title": "Lines" }, "default_alternate_enterprise_pt": { "type": "string", "title": "Default CUCM Line Alternate Enterprise Partition" }, "includePRD": { "type": "boolean", "description": "Remote Destinations associated to Dual-Mode Phones", "title": "Dual-mode Remote Destinations" }, "default_cucm_phone_presencegroup": { "is_password": false, "title": "Default CUCM Phone Presence Group", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "deviceLimitYN": { "description": "Select the method of device selection", "title": "Overbuild Device Control", "default": "all", "items": { "is_password": false }, "required": false, "choices": [ { "value": "all", "title": "Move All Devices" }, { "value": "limit", "title": "Limit Moved Devices" } ], "readonly": false, "type": "string" }, "defaultlinecfnaicss": { "type": "string", "title": "Default CUCM Line Call Forward No Answer Internal CSS" }, "defaultTeamsUpdateManagementPolicy": { "type": "string", "description": "Default TeamsUpdateManagementPolicy", "title": "Default Update Management Policy" }, "deleteDataUserOnMsolUserDelete": { "type": "boolean", "description": "Delete VOSS4UC User when deleting Azure AD Online Users", "title": "Auto Delete VOSS4UC User" }, "defaultUL": { "is_password": false, "title": "Default User Locale", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "default_rdp_css": { "type": "string", "title": "Default CUCM Remote Destination Profile CSS" }, "defaultlinecfnacss": { "type": "string", "title": "Default CUCM Line Call Forward No Answer CSS" }, "default_cucm_dp_product": { "is_password": false, "title": "Default CUCM Device Profile Product", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcucsmppprovider": { "type": "string", "title": "Default CUC SMPP Provider" }, "defaultTeamsEmergencyCallingPolicy": { "type": "string", "description": "Default TeamsEmergencyCallingPolicy", "title": "Default Teams Emergency Calling Policy" }, "allowMsolUserAdd": { "type": "boolean", "description": "Allow VOSS4UC to add and delete MS O365 Users", "title": "MS O365 User can be added" }, "default_cucm_phone_e164_mask": { "type": "string", "title": "Default CUCM Phone Line E164 Mask" }, "defaultTeamsUpgradePolicy": { "type": "string", "description": "Default TeamsUpgradePolicy", "title": "Default Teams Upgrade Policy" }, "defaultlinecfacss": { "type": "string", "title": "Default CUCM Line Call Forward All CSS" }, "default_callforward_css": { "type": "string", "title": "Default CUCM Line Call Forward CSS" }, "defaultlinecfbcss": { "type": "string", "title": "Default CUCM Line Call Forward Busy CSS" }, "defaultlinecfofcss": { "type": "string", "title": "Default CUCM Line Call Forward On Failure CSS" }, "default_alternate_e164_pt": { "type": "string", "title": "Default CUCM Line Alternate E164 Partition" }, "default_cucm_rdp_e164_mask": { "type": "string", "title": "Default CUCM Remote Destination Profile Line E164 Mask" }, "default_cucm_phone_securityprofile": { "is_password": false, "title": "Default CUCM Phone Security Profile", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultCallingLineIdentity": { "type": "string", "description": "Default TeamsCallingLineIdentity", "title": "Default Calling Line Identity" }, "includeRD": { "type": "boolean", "description": "Remote Destinations associated to RDP's", "title": "Remote Destinations" }, "includeHeadset": { "type": "boolean", "description": "Move all headsets that match search-criteria, to destination site.", "title": "Headsets" }, "defaultREG": { "is_password": false, "title": "Default CUCM Region", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultTeamsOnlineVoicemailPolicy": { "type": "string", "description": "Default TeamsOnlineVoicemailPolicy", "title": "Default Online Voicemail Policy" }, "includeDP": { "type": "boolean", "description": "Move User Device Profiles down to associated User", "title": "Device Profiles" }, "includeOverbuild": { "type": "boolean", "description": "Mark this site as to be included for Overbuild", "title": "Include Site for Overbuild" }, "defaultDP": { "is_password": false, "title": "Default CUCM Device Pool", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultTeamsMeetingPolicy": { "type": "string", "description": "Default TeamsMeetingPolicy", "title": "Default Teams Meeting Policy" }, "cucmUserModelFilterCriteria": { "description": "Rule to use for matching the CUCM User. This criteria will be used to check if a user should be moved to a site when the user is synced in.", "title": "CUCM User Model Filter Criteria", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ModelFilterCriteria", "type": "string", "target": "/api/data/ModelFilterCriteria/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "defaultlinecfnricss": { "type": "string", "title": "Default CUCM Line Call Forward On Failure Internal CSS" }, "defaultTeamsEmergencyCallRoutingPolicy": { "type": "string", "description": "Default TeamsEmergencyCallRoutingPolicy", "title": "Default Teams Emergency Call Routing Policy" }, "defaultUsageLocation": { "title": "Default Usage Location", "type": "string", "description": "Default Usage Location", "choices": [ { "value": "AF", "title": "Afghanistan" }, { "value": "AX", "title": "\u00c5land Islands" }, { "value": "AL", "title": "Albania" }, { "value": "DZ", "title": "Algeria" }, { "value": "AS", "title": "American Samoa" }, { "value": "AD", "title": "Andorra" }, { "value": "AO", "title": "Angola" }, { "value": "AI", "title": "Anguilla" }, { "value": "AQ", "title": "Antarctica" }, { "value": "AG", "title": "Antigua and Barbuda" }, { "value": "AR", "title": "Argentina" }, { "value": "AM", "title": "Armenia" }, { "value": "AW", "title": "Aruba" }, { "value": "AU", "title": "Australia" }, { "value": "AT", "title": "Austria" }, { "value": "AZ", "title": "Azerbaijan" }, { "value": "BS", "title": "Bahamas, The" }, { "value": "BH", "title": "Bahrain" }, { "value": "BD", "title": "Bangladesh" }, { "value": "BB", "title": "Barbados" }, { "value": "BY", "title": "Belarus" }, { "value": "BE", "title": "Belgium" }, { "value": "BZ", "title": "Belize" }, { "value": "BJ", "title": "Benin" }, { "value": "BM", "title": "Bermuda" }, { "value": "BT", "title": "Bhutan" }, { "value": "BT", "title": "Bolivia" }, { "value": "BO", "title": "Bonaire, Saint Eustatius and Saba" }, { "value": "BA", "title": "Bosnia and Herzegovina" }, { "value": "BW", "title": "Botswana" }, { "value": "BV", "title": "Bouvet Island" }, { "value": "BR", "title": "Brazil" }, { "value": "IO", "title": "British Indian Ocean Territory" }, { "value": "IO", "title": "Brunei" }, { "value": "BG", "title": "Bulgaria" }, { "value": "BF", "title": "Burkina Faso" }, { "value": "BI", "title": "Burundi" }, { "value": "CV", "title": "Cabo Verde" }, { "value": "KH", "title": "Cambodia" }, { "value": "CM", "title": "Cameroon" }, { "value": "CA", "title": "Canada" }, { "value": "KY", "title": "Cayman Islands" }, { "value": "CF", "title": "Central African Republic" }, { "value": "TD", "title": "Chad" }, { "value": "CL", "title": "Chile" }, { "value": "CN", "title": "China" }, { "value": "CX", "title": "Christmas Island" }, { "value": "CC", "title": "Cocos (Keeling) Islands" }, { "value": "CO", "title": "Colombia" }, { "value": "KM", "title": "Comoros" }, { "value": "CG", "title": "Congo" }, { "value": "CG", "title": "Congo (DRC)" }, { "value": "CK", "title": "Cook Islands" }, { "value": "CR", "title": "Costa Rica" }, { "value": "CR", "title": "C\u00f4te d\u2019Ivoire" }, { "value": "HR", "title": "Croatia" }, { "value": "CW", "title": "Cura\u00e7ao" }, { "value": "CY", "title": "Cyprus" }, { "value": "CY", "title": "Czech Republic" }, { "value": "DK", "title": "Denmark" }, { "value": "DJ", "title": "Djibouti" }, { "value": "DM", "title": "Dominica" }, { "value": "DO", "title": "Dominican Republic" }, { "value": "EC", "title": "Ecuador" }, { "value": "EG", "title": "Egypt" }, { "value": "SV", "title": "El Salvador" }, { "value": "GQ", "title": "Equatorial Guinea" }, { "value": "ER", "title": "Eritrea" }, { "value": "EE", "title": "Estonia" }, { "value": "ET", "title": "Ethiopia" }, { "value": "ET", "title": "Falkland Islands (Islas Malvinas)" }, { "value": "FO", "title": "Faroe Islands" }, { "value": "FJ", "title": "Fiji Islands" }, { "value": "FI", "title": "Finland" }, { "value": "FR", "title": "France" }, { "value": "GF", "title": "French Guiana" }, { "value": "PF", "title": "French Polynesia" }, { "value": "PF", "title": "French Southern and Antarctic Lands" }, { "value": "GA", "title": "Gabon" }, { "value": "GM", "title": "Gambia, The" }, { "value": "GE", "title": "Georgia" }, { "value": "DE", "title": "Germany" }, { "value": "GH", "title": "Ghana" }, { "value": "GI", "title": "Gibraltar" }, { "value": "GR", "title": "Greece" }, { "value": "GL", "title": "Greenland" }, { "value": "GD", "title": "Grenada" }, { "value": "GP", "title": "Guadeloupe" }, { "value": "GU", "title": "Guam" }, { "value": "GT", "title": "Guatemala" }, { "value": "GG", "title": "Guernsey" }, { "value": "GN", "title": "Guinea" }, { "value": "GW", "title": "Guinea-Bissau" }, { "value": "GY", "title": "Guyana" }, { "value": "HT", "title": "Haiti" }, { "value": "HM", "title": "Heard Island and McDonald Islands" }, { "value": "VA", "title": "Holy See (Vatican City State)" }, { "value": "HN", "title": "Honduras" }, { "value": "HK", "title": "Hong Kong SAR" }, { "value": "HU", "title": "Hungary" }, { "value": "IS", "title": "Iceland" }, { "value": "IN", "title": "India" }, { "value": "ID", "title": "Indonesia" }, { "value": "IQ", "title": "Iraq" }, { "value": "IE", "title": "Ireland" }, { "value": "IM", "title": "Isle of Man" }, { "value": "IL", "title": "Israel" }, { "value": "IT", "title": "Italy" }, { "value": "JM", "title": "Jamaica" }, { "value": "JP", "title": "Japan" }, { "value": "JE", "title": "Jersey" }, { "value": "JO", "title": "Jordan" }, { "value": "KZ", "title": "Kazakhstan" }, { "value": "KE", "title": "Kenya" }, { "value": "KI", "title": "Kiribati" }, { "value": "KR", "title": "Korea, Republic of" }, { "value": "KW", "title": "Kuwait" }, { "value": "KG", "title": "Kyrgyzstan" }, { "value": "LA", "title": "Laos" }, { "value": "LV", "title": "Latvia" }, { "value": "LB", "title": "Lebanon" }, { "value": "LS", "title": "Lesotho" }, { "value": "LR", "title": "Liberia" }, { "value": "LY", "title": "Libya" }, { "value": "LI", "title": "Liechtenstein" }, { "value": "LT", "title": "Lithuania" }, { "value": "LU", "title": "Luxembourg" }, { "value": "MO", "title": "Macao SAR" }, { "value": "MO", "title": "Macedonia, Former Yugoslav Republic of" }, { "value": "MG", "title": "Madagascar" }, { "value": "MW", "title": "Malawi" }, { "value": "MY", "title": "Malaysia" }, { "value": "MV", "title": "Maldives" }, { "value": "ML", "title": "Mali" }, { "value": "MT", "title": "Malta" }, { "value": "MH", "title": "Marshall Islands" }, { "value": "MQ", "title": "Martinique" }, { "value": "MR", "title": "Mauritania" }, { "value": "MU", "title": "Mauritius" }, { "value": "YT", "title": "Mayotte" }, { "value": "MX", "title": "Mexico" }, { "value": "MX", "title": "Micronesia" }, { "value": "FM", "title": "Moldova" }, { "value": "MC", "title": "Monaco" }, { "value": "MN", "title": "Mongolia" }, { "value": "ME", "title": "Montenegro" }, { "value": "MS", "title": "Montserrat" }, { "value": "MA", "title": "Morocco" }, { "value": "MZ", "title": "Mozambique" }, { "value": "MM", "title": "Myanmar" }, { "value": "NA", "title": "Namibia" }, { "value": "NR", "title": "Nauru" }, { "value": "NP", "title": "Nepal" }, { "value": "NP", "title": "Netherlands" }, { "value": "NP", "title": "Netherlands Antilles (Former)" }, { "value": "NC", "title": "New Caledonia" }, { "value": "NZ", "title": "New Zealand" }, { "value": "NI", "title": "Nicaragua" }, { "value": "NE", "title": "Niger" }, { "value": "NG", "title": "Nigeria" }, { "value": "NU", "title": "Niue" }, { "value": "NF", "title": "Norfolk Island" }, { "value": "MP", "title": "Northern Mariana Islands" }, { "value": "NO", "title": "Norway" }, { "value": "OM", "title": "Oman" }, { "value": "PK", "title": "Pakistan" }, { "value": "PW", "title": "Palau" }, { "value": "PS", "title": "Palestinian Authority" }, { "value": "PA", "title": "Panama" }, { "value": "PG", "title": "Papua New Guinea" }, { "value": "PY", "title": "Paraguay" }, { "value": "PE", "title": "Peru" }, { "value": "PH", "title": "Philippines" }, { "value": "PN", "title": "Pitcairn Islands" }, { "value": "PL", "title": "Poland" }, { "value": "PT", "title": "Portugal" }, { "value": "PR", "title": "Puerto Rico" }, { "value": "QA", "title": "Qatar" }, { "value": "QA", "title": "Reunion" }, { "value": "RO", "title": "Romania" }, { "value": "RO", "title": "Russia" }, { "value": "RW", "title": "Rwanda" }, { "value": "BL", "title": "Saint Barth\u00e9lemy" }, { "value": "SH", "title": "Saint Helena, Ascension and Tristan da Cunha" }, { "value": "KN", "title": "Saint Kitts and Nevis" }, { "value": "LC", "title": "Saint Lucia" }, { "value": "LC", "title": "Saint Martin" }, { "value": "PM", "title": "Saint Pierre and Miquelon" }, { "value": "VC", "title": "Saint Vincent and the Grenadines" }, { "value": "WS", "title": "Samoa" }, { "value": "SM", "title": "San Marino" }, { "value": "ST", "title": "S\u00e3o Tom\u00e9 and Pr\u00edncipe" }, { "value": "SA", "title": "Saudi Arabia" }, { "value": "SN", "title": "Senegal" }, { "value": "RS", "title": "Serbia" }, { "value": "SC", "title": "Seychelles" }, { "value": "SL", "title": "Sierra Leone" }, { "value": "SG", "title": "Singapore" }, { "value": "SG", "title": "Sint Maarten" }, { "value": "SK", "title": "Slovakia" }, { "value": "SI", "title": "Slovenia" }, { "value": "SB", "title": "Solomon Islands" }, { "value": "SO", "title": "Somalia" }, { "value": "ZA", "title": "South Africa" }, { "value": "GS", "title": "South Georgia and the South Sandwich Islands" }, { "value": "SS", "title": "South Sudan" }, { "value": "ES", "title": "Spain" }, { "value": "LK", "title": "Sri Lanka" }, { "value": "SR", "title": "Suriname" }, { "value": "SJ", "title": "Svalbard and Jan Mayen Island" }, { "value": "SZ", "title": "Swaziland" }, { "value": "SE", "title": "Sweden" }, { "value": "CH", "title": "Switzerland" }, { "value": "SY", "title": "Taiwan" }, { "value": "TJ", "title": "Tajikistan" }, { "value": "TJ", "title": "Tanzania" }, { "value": "TH", "title": "Thailand" }, { "value": "TL", "title": "Timor-Leste" }, { "value": "TG", "title": "Togo" }, { "value": "TK", "title": "Tokelau" }, { "value": "TO", "title": "Tonga" }, { "value": "TT", "title": "Trinidad and Tobago" }, { "value": "TN", "title": "Tunisia" }, { "value": "TR", "title": "Turkey" }, { "value": "TM", "title": "Turkmenistan" }, { "value": "TC", "title": "Turks and Caicos Islands" }, { "value": "TV", "title": "Tuvalu" }, { "value": "TV", "title": "U.S. Minor Outlying Islands" }, { "value": "UG", "title": "Uganda" }, { "value": "UA", "title": "Ukraine" }, { "value": "AE", "title": "United Arab Emirates" }, { "value": "GB", "title": "United Kingdom" }, { "value": "US", "title": "United States" }, { "value": "UY", "title": "Uruguay" }, { "value": "UZ", "title": "Uzbekistan" }, { "value": "VU", "title": "Vanuatu" }, { "value": "VU", "title": "Venezuela" }, { "value": "VN", "title": "Vietnam" }, { "value": "VG", "title": "Virgin Islands, British" }, { "value": "VI", "title": "Virgin Islands, U.S." }, { "value": "WF", "title": "Wallis and Futuna" }, { "value": "EH", "title": "Western Sahara" }, { "value": "YE", "title": "Yemen" }, { "value": "ZM", "title": "Zambia" }, { "value": "ZW", "title": "Zimbabwe" } ] }, "defaultcuclanguage": { "type": "string", "title": "Default CUC Language" }, "defaultlineseccss": { "type": "string", "title": "Default CUCM Line Call Forward Secondary CSS" }, "defaultlinecfapcss": { "type": "string", "title": "Default CUCM Line Call Forward Alternate Party CSS" }, "includeRDP": { "type": "boolean", "description": "Move Remote Destination Profiles that match search-criteria, to destination site.", "title": "Remote Destination Profiles" }, "defaultmmpt": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM MeetMe Partition", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSitePartitions", "readonly": false, "type": "string" }, "defaultTeamsCallingPolicy": { "type": "string", "description": "Default TeamsCallingPolicy", "title": "Default Teams Calling Policy" }, "includeUser": { "type": "boolean", "description": "Move Users down to associated phones", "title": "Users" }, "defaultNL": { "is_password": false, "title": "Default Network Locale", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcuclanguagecallerhears": { "type": "string", "title": "Default Language That Callers Hear" }, "default_cucm_phone_product": { "is_password": false, "title": "Default CUCM Phone Product", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "defaultcpupt": { "is_password": false, "target": "data/DialPlan", "title": "Default CUCM Call Pickup Partition", "items": { "is_password": false }, "required": false, "choices": [ { "value": "y", "title": "y" } ], "target_attr": "AddSitePartitions", "readonly": false, "type": "string" }, "defaultDTG": { "is_password": false, "title": "Default CUCM Date/Time Group", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" }, "manageLicenses": { "type": "boolean", "description": "Allow VOSS4UC to manage MS licenses and allow user staging", "title": "Manage Licenses and Allow User Staging" }, "ldapUserModelFilterCriteria": { "description": "Rule to use for matching the LDAP User. This criteria will be used to check if a user should be moved to a site when the user is synced in.", "title": "LDAP User Model Filter Criteria", "format": "uri", "choices": [], "target_attr": "name", "target_model_type": "data/ModelFilterCriteria", "type": "string", "target": "/api/data/ModelFilterCriteria/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken] }, "defaultTenantDialPlan": { "type": "string", "description": "Default TenantDialPlan", "title": "Default Tenant Dial Plan" }, "default_cucm_user_serviceprofile": { "is_password": false, "title": "Default CUCM Service Profile", "items": { "is_password": false }, "required": false, "readonly": false, "type": "string" } }, "schema_version": "3.4" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/SiteDefaultsDoc/add/ |
|
The GUI Add form of data/SiteDefaultsDoc 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/SiteDefaultsDoc/ | 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/SiteDefaultsDoc/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/SiteDefaultsDoc/[pkid1]", "/api/data/SiteDefaultsDoc/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/SiteDefaultsDoc/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/SiteDefaultsDoc; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/SiteDefaultsDoc/export/ |
|
{ "hrefs":["/api/data/SiteDefaultsDoc/[pkid1]", "/api/data/SiteDefaultsDoc/[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/SiteDefaultsDoc and the JSON format can be used to import instances of data/SiteDefaultsDoc.
GET http://[host-proxy]/api/data/SiteDefaultsDoc/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/SiteDefaultsDoc | POST | /api/data/SiteDefaultsDoc/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/SiteDefaultsDoc/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/SiteDefaultsDoc/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/SiteDefaultsDoc/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/SiteDefaultsDoc/ |
|
The data/SiteDefaultsDoc schema and all instances as JSON. |
(The list will return 0 to 3 data/SiteDefaultsDoc instances)
{ "operations": [ "field_display_policy", "configuration_template", "help", "get", "export_bulkload_template", "list", "update", "remove", "move", "transform", "add", "export", "migration", "bulk_update_form" ], "pagination": { "direction": "asc", "order_by": "name", "maximum_limit": 2000, "skip": 0, "current": "/api/data/SiteDefaultsDoc/?skip=0&limit=3&order_by=name&direction=asc&traversal=default", "limit": 3, "total_limit": null, "total": 26 }, "meta": { "tags": [], "cached": true, "title": "", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "3.4", "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/SiteDefaultsDoc/add/?hierarchy=[hierarchy]", "method": "GET", "title": "Add" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SiteDefaultsDoc/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SiteDefaultsDoc/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/SiteDefaultsDoc/export_bulkload_template/?hierarchy=[hierarchy]", "method": "POST", "title": "Export Bulk Load Template" } }, { "configuration_template": { "support_async": false, "class": "config", "href": "/api/data/SiteDefaultsDoc/configuration_template/?hierarchy=[hierarchy]", "method": "GET", "title": "Configuration Template" } }, { "field_display_policy": { "support_async": false, "class": "display_policy", "href": "/api/data/SiteDefaultsDoc/field_display_policy/?hierarchy=[hierarchy]", "method": "GET", "title": "Field Display Policy" } }, { "migration": { "support_async": false, "class": "migration", "href": "/api/data/SiteDefaultsDoc/migration/?hierarchy=[hierarchy]", "method": "GET", "title": "Migration Template" } }, { "list": { "support_async": false, "class": "list", "href": "/api/data/SiteDefaultsDoc/?hierarchy=[hierarchy]", "method": "GET", "title": "List" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SiteDefaultsDoc/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } }, { "bulk_update": { "support_async": true, "class": "update", "href": "/api/data/SiteDefaultsDoc/bulk_update/?hierarchy=[hierarchy]", "method": "POST", "title": "Bulk Modify" } } ], "model_type": "data/SiteDefaultsDoc", "model_specific_actions": [ "get", "list", "add", "update", "remove", "help", "export_bulkload_template", "bulk_update", "configuration_template", "field_display_policy", "export", "migration" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "includeOverbuild", "title": "Include Site for Overbuild" }, { "name": "defaultREG", "title": "Default CUCM Region" }, { "name": "defaultNL", "title": "Default Network Locale" }, { "name": "defaultUL", "title": "Default User Locale" }, { "name": "defaultcuclanguage", "title": "Default CUC Language" }, { "name": "default_self_service_language", "title": "Default Self-service Language " }, { "name": "defaultDTG", "title": "Default CUCM Date/Time Group" }, { "name": "hotdial_time_zone", "title": "Default HotDial Time Zone" }, { "name": "defaultcucmgroup", "title": "Default CUCM Group" }, { "name": "default_cucm_user_serviceprofile", "title": "Default CUCM Service Profile" }, { "name": "defaultcucsubscribertemplate", "title": "Default CUC Subscriber Template" }, { "name": "defaultcucphonesystem", "title": "Default CUC Phone System" }, { "name": "defaultcucsmppprovider", "title": "Default CUC SMPP Provider" }, { "name": "ms365UserModelFilterCriteria", "title": "MS 365 User Model Filter Criteria" }, { "name": "ldapUserModelFilterCriteria", "title": "LDAP User Model Filter Criteria" }, { "name": "cucmUserModelFilterCriteria", "title": "CUCM User Model Filter Criteria" }, { "name": "defaultTenantDialPlan", "title": "Default Tenant Dial Plan" }, { "name": "defaultOnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "resources": [ { "pkid": "63054c57c46e74b4687bcbee", "meta": { "tags": [], "cached": true, "title": "CUSTOMER_TEMPLATE", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "3.4", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "63054c57c46e74b4687bcbee", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/" } ], "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/help", "method": "GET", "title": "Help" } } ], "model_type": "data/SiteDefaultsDoc", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "63054c57c46e74b4687bcbee" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "includeOverbuild", "title": "Include Site for Overbuild" }, { "name": "defaultREG", "title": "Default CUCM Region" }, { "name": "defaultNL", "title": "Default Network Locale" }, { "name": "defaultUL", "title": "Default User Locale" }, { "name": "defaultcuclanguage", "title": "Default CUC Language" }, { "name": "default_self_service_language", "title": "Default Self-service Language " }, { "name": "defaultDTG", "title": "Default CUCM Date/Time Group" }, { "name": "hotdial_time_zone", "title": "Default HotDial Time Zone" }, { "name": "defaultcucmgroup", "title": "Default CUCM Group" }, { "name": "default_cucm_user_serviceprofile", "title": "Default CUCM Service Profile" }, { "name": "defaultcucsubscribertemplate", "title": "Default CUC Subscriber Template" }, { "name": "defaultcucphonesystem", "title": "Default CUC Phone System" }, { "name": "defaultcucsmppprovider", "title": "Default CUC SMPP Provider" }, { "name": "ms365UserModelFilterCriteria", "title": "MS 365 User Model Filter Criteria" }, { "name": "ldapUserModelFilterCriteria", "title": "LDAP User Model Filter Criteria" }, { "name": "cucmUserModelFilterCriteria", "title": "CUCM User Model Filter Criteria" }, { "name": "defaultTenantDialPlan", "title": "Default Tenant Dial Plan" }, { "name": "defaultOnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "63054c57c46e74b4687bcbef", "hierarchy_friendly_name": "AAAGlobal (Customer)", "defaultcucmgroup": "{{ fn.cucm_select_group pwf.site_hn_fp }}", "name": "CUSTOMER_TEMPLATE", "hierarchy_path": "sys.hcs.CS-P.CS-NB.AAAGlobal" } }, { "pkid": "630556c9c46e74b4687dd3be", "meta": { "tags": [], "cached": true, "title": "CUSTOMER_TEMPLATE", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "3.4", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "630556c9c46e74b4687dd3be", "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/" } ], "parent": [ { "pkid": "630556bfc46e74b4687dd0eb", "href": "/api/data/HierarchyNode/630556bfc46e74b4687dd0eb" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/", "title": "Modify", "class": "update", "method": "PUT" } }, { "remove": { "support_async": true, "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/", "title": "Delete", "class": "delete", "method": "DELETE" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/export/", "method": "GET", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/", "title": "Get", "class": "get", "method": "GET" } }, { "help": { "support_async": false, "href": "/api/data/SiteDefaultsDoc/630556c9c46e74b4687dd3be/help", "title": "Help", "class": "help", "method": "GET" } } ], "model_type": "data/SiteDefaultsDoc", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "630556bfc46e74b4687dd0eb", "630556c9c46e74b4687dd3be" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "includeOverbuild", "title": "Include Site for Overbuild" }, { "name": "defaultREG", "title": "Default CUCM Region" }, { "name": "defaultNL", "title": "Default Network Locale" }, { "name": "defaultUL", "title": "Default User Locale" }, { "name": "defaultcuclanguage", "title": "Default CUC Language" }, { "name": "default_self_service_language", "title": "Default Self-service Language " }, { "name": "defaultDTG", "title": "Default CUCM Date/Time Group" }, { "name": "hotdial_time_zone", "title": "Default HotDial Time Zone" }, { "name": "defaultcucmgroup", "title": "Default CUCM Group" }, { "name": "default_cucm_user_serviceprofile", "title": "Default CUCM Service Profile" }, { "name": "defaultcucsubscribertemplate", "title": "Default CUC Subscriber Template" }, { "name": "defaultcucphonesystem", "title": "Default CUC Phone System" }, { "name": "defaultcucsmppprovider", "title": "Default CUC SMPP Provider" }, { "name": "ms365UserModelFilterCriteria", "title": "MS 365 User Model Filter Criteria" }, { "name": "ldapUserModelFilterCriteria", "title": "LDAP User Model Filter Criteria" }, { "name": "cucmUserModelFilterCriteria", "title": "CUCM User Model Filter Criteria" }, { "name": "defaultTenantDialPlan", "title": "Default Tenant Dial Plan" }, { "name": "defaultOnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "630556c9c46e74b4687dd3bf", "hierarchy_friendly_name": "NBIcorp (Customer)", "defaultcucmgroup": "{{ fn.cucm_select_group pwf.site_hn_fp }}", "name": "CUSTOMER_TEMPLATE", "hierarchy_path": "sys.hcs.CS-P.CS-NB.NBIcorp" } }, { "pkid": "63057767c46e74b46881c93d", "meta": { "tags": [], "cached": true, "title": "CUSTOMER_TEMPLATE", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "3.4", "summary": "false", "references": { "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "self": [ { "pkid": "63057767c46e74b46881c93d", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/" } ], "parent": [ { "pkid": "6305775dc46e74b46881c66a", "href": "/api/data/HierarchyNode/6305775dc46e74b46881c66a" } ], "foreign_key": [] }, "actions": [ { "update": { "support_async": true, "method": "PUT", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/", "class": "update", "title": "Modify" } }, { "remove": { "support_async": true, "method": "DELETE", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/", "class": "delete", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "method": "GET", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/export/", "class": "export", "view": "/api/view/ExportData/add/" } }, { "get": { "support_async": false, "method": "GET", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/", "class": "get", "title": "Get" } }, { "help": { "support_async": false, "method": "GET", "href": "/api/data/SiteDefaultsDoc/63057767c46e74b46881c93d/help", "class": "help", "title": "Help" } } ], "model_type": "data/SiteDefaultsDoc", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "6305775dc46e74b46881c66a", "63057767c46e74b46881c93d" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "includeOverbuild", "title": "Include Site for Overbuild" }, { "name": "defaultREG", "title": "Default CUCM Region" }, { "name": "defaultNL", "title": "Default Network Locale" }, { "name": "defaultUL", "title": "Default User Locale" }, { "name": "defaultcuclanguage", "title": "Default CUC Language" }, { "name": "default_self_service_language", "title": "Default Self-service Language " }, { "name": "defaultDTG", "title": "Default CUCM Date/Time Group" }, { "name": "hotdial_time_zone", "title": "Default HotDial Time Zone" }, { "name": "defaultcucmgroup", "title": "Default CUCM Group" }, { "name": "default_cucm_user_serviceprofile", "title": "Default CUCM Service Profile" }, { "name": "defaultcucsubscribertemplate", "title": "Default CUC Subscriber Template" }, { "name": "defaultcucphonesystem", "title": "Default CUC Phone System" }, { "name": "defaultcucsmppprovider", "title": "Default CUC SMPP Provider" }, { "name": "ms365UserModelFilterCriteria", "title": "MS 365 User Model Filter Criteria" }, { "name": "ldapUserModelFilterCriteria", "title": "LDAP User Model Filter Criteria" }, { "name": "cucmUserModelFilterCriteria", "title": "CUCM User Model Filter Criteria" }, { "name": "defaultTenantDialPlan", "title": "Default Tenant Dial Plan" }, { "name": "defaultOnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "63057767c46e74b46881c93e", "hierarchy_friendly_name": "Overton (Customer)", "defaultcucmgroup": "{{ fn.cucm_select_group pwf.site_hn_fp }}", "name": "CUSTOMER_TEMPLATE", "hierarchy_path": "sys.hcs.CS-P.CS-NB.Overton" } } ] }
(Show the first instance)
{ "pkid": "63054c57c46e74b4687bcbee", "meta": { "tags": [], "cached": false, "title": "CUSTOMER_TEMPLATE", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "schema_version": "3.4", "references": { "parent": [ { "pkid": "63054c4fc46e74b4687bc91b", "href": "/api/data/HierarchyNode/63054c4fc46e74b4687bc91b" } ], "self": [ { "pkid": "63054c57c46e74b4687bcbee", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/" } ], "foreign_key": [], "device": [ { "pkid": "", "href": "" } ], "owner": [ { "pkid": "" } ], "children": [] }, "actions": [ { "update": { "support_async": true, "class": "update", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/?hierarchy=[hierarchy]", "method": "PUT", "title": "Modify" } }, { "remove": { "support_async": true, "class": "delete", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/?hierarchy=[hierarchy]", "method": "DELETE", "title": "Delete" } }, { "export": { "title": "Export", "support_async": false, "submit": "payload", "class": "export", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/export/?hierarchy=[hierarchy]", "method": "GET", "view": "/api/view/ExportData/add/?auth_token=[authtoken] } }, { "get": { "support_async": false, "class": "get", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/?hierarchy=[hierarchy]", "method": "GET", "title": "Get" } }, { "help": { "support_async": false, "class": "help", "href": "/api/data/SiteDefaultsDoc/63054c57c46e74b4687bcbee/help?hierarchy=[hierarchy]", "method": "GET", "title": "Help" } } ], "model_type": "data/SiteDefaultsDoc", "path": [ "6t0ggef2c0deab00hb595101", "6305086243fcc416f18ea4ac", "63054bfdc46e74b4687bb868", "63054c3bc46e74b4687bc61b", "63054c4fc46e74b4687bc91b", "63054c57c46e74b4687bcbee" ], "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "includeOverbuild", "title": "Include Site for Overbuild" }, { "name": "defaultREG", "title": "Default CUCM Region" }, { "name": "defaultNL", "title": "Default Network Locale" }, { "name": "defaultUL", "title": "Default User Locale" }, { "name": "defaultcuclanguage", "title": "Default CUC Language" }, { "name": "default_self_service_language", "title": "Default Self-service Language " }, { "name": "defaultDTG", "title": "Default CUCM Date/Time Group" }, { "name": "hotdial_time_zone", "title": "Default HotDial Time Zone" }, { "name": "defaultcucmgroup", "title": "Default CUCM Group" }, { "name": "default_cucm_user_serviceprofile", "title": "Default CUCM Service Profile" }, { "name": "defaultcucsubscribertemplate", "title": "Default CUC Subscriber Template" }, { "name": "defaultcucphonesystem", "title": "Default CUC Phone System" }, { "name": "defaultcucsmppprovider", "title": "Default CUC SMPP Provider" }, { "name": "ms365UserModelFilterCriteria", "title": "MS 365 User Model Filter Criteria" }, { "name": "ldapUserModelFilterCriteria", "title": "LDAP User Model Filter Criteria" }, { "name": "cucmUserModelFilterCriteria", "title": "CUCM User Model Filter Criteria" }, { "name": "defaultTenantDialPlan", "title": "Default Tenant Dial Plan" }, { "name": "defaultOnlineVoiceRoutingPolicy", "title": "Default Online Voice Routing Policy" }, { "allow_filtering": true, "name": "hierarchy_friendly_name", "title": "Located At" } ], "api_version": "21.2", "tagged_versions": [] }, "data": { "pkid": "63054c57c46e74b4687bcbef", "defaultcucmgroup": "{{ fn.cucm_select_group pwf.site_hn_fp }}", "name": "CUSTOMER_TEMPLATE" } }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/SiteDefaultsDoc. | GET | /api/data/SiteDefaultsDoc/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/SiteDefaultsDoc as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/SiteDefaultsDoc/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/SiteDefaultsDoc/[pkid]/ | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/SiteDefaultsDoc; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/SiteDefaultsDoc/[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/SiteDefaultsDoc and the JSON format can be used to import instances of data/SiteDefaultsDoc.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/SiteDefaultsDoc/[pkid]/ | hierarchy=[hierarchy] | The data/SiteDefaultsDoc instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/SiteDefaultsDoc/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/SiteDefaultsDoc. |