[Index]
Defines the Business Administration Portal model.
Model ref.: data/InterfaceBusinessAdminPortal
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": {
"contact_center": {
"default": "true",
"type": "boolean",
"description": "Turn Contact Center Express feature on/off.",
"title": "Contact Center Express"
},
"number_management": {
"default": "true",
"type": "boolean",
"description": "Turn Number Management feature on/off.",
"title": "Number Management"
},
"site": {
"default": "true",
"type": "boolean",
"description": "Turn Site Management feature on/off.",
"title": "Site Management"
},
"webex_teams_config": {
"type": "object",
"properties": {
"webex_teams_user_fdp": {
"default": "BusinessAdminWebexTeamsUserFDP",
"type": "string",
"title": "Webex Teams User Display Policy"
},
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Webex Teams",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Webex Teams"
},
"tools": {
"default": "true",
"type": "boolean",
"description": "Turn Tools feature on/off.",
"title": "Tools"
},
"webex_teams": {
"default": "true",
"type": "boolean",
"description": "Turn Webex Teams feature on/off.",
"title": "Webex Teams"
},
"tools_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Tools",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Tools"
},
"phone_config": {
"type": "object",
"properties": {
"phone_fdp": {
"default": "BusinessAdminPhoneFDP",
"type": "string",
"title": "Phone Display Policy"
},
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Phones",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Phones"
},
"contact_center_config": {
"type": "object",
"properties": {
"team_fdp": {
"default": "BusinessAdminUccxTeamFDP",
"type": "string",
"title": "Team Display Policy"
},
"agent_fdp": {
"default": "BusinessAdminUccxAgentFDP",
"type": "string",
"title": "Agent Display Policy"
},
"csq_fdp": {
"default": "BusinessAdminUccxContactServiceQueueFDP",
"type": "string",
"title": "Contact Service Queue Display Policy"
},
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Contact Center Express",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Contact Center Express"
},
"subscriber_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Subscribers",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Subscribers"
},
"subscriber": {
"default": "true",
"type": "boolean",
"description": "Turn Subscribers feature on/off.",
"title": "Subscribers"
},
"custom_features": {
"items": {
"type": "object",
"properties": {
"field_display_policy": {
"target": "/api/data/FieldDisplayPolicy/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Field Display Policy",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/FieldDisplayPolicy",
"type": "string",
"description": "The selected Field Display Policy that is associated with the custom feature."
},
"configuration_template": {
"target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"title": "Configuration Template",
"format": "uri",
"choices": [],
"target_attr": "name",
"target_model_type": "data/ConfigurationTemplate",
"type": "string",
"description": "The selected Configuration Template that is associated with the custom feature."
},
"feature_area": {
"title": "Feature Area",
"type": "string",
"target": "",
"description": "The Business Admin Portal feature area this custom feature will apear in."
},
"title": {
"description": "The title of this custom feature. This is the text that will appear in the custom feature link.",
"title": "Title",
"required": false,
"displayable": true,
"readonly": false,
"type": "string"
},
"type": {
"description": "The model type associated with the custom feature for e.g. view/QuickSubscriber.",
"format": "uri",
"title": "Type",
"required": false,
"choices": [],
"readonly": false,
"target_model_type": "",
"type": "string",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"icon": {
"title": "Icon",
"type": "string",
"description": "The icon to be used for this custom feature. This icon will appear in the custom feature link.",
"choices": [
{
"value": "3d_rotation",
"title": "3D Rotation"
},
{
"value": "ac_unit",
"title": "Ac Unit"
},
{
"value": "access_alarm",
"title": "Access Alarm"
},
{
"value": "access_alarms",
"title": "Access Alarms"
},
{
"value": "access_time",
"title": "Access Time"
},
{
"value": "accessibility",
"title": "Accessibility"
},
{
"value": "accessible",
"title": "Accessible"
},
{
"value": "account_balance",
"title": "Account Balance"
},
{
"value": "account_balance_wallet",
"title": "Account Balance Wallet"
},
{
"value": "account_box",
"title": "Account Box"
},
{
"value": "account_circle",
"title": "Account Circle"
},
{
"value": "add",
"title": "Add"
},
{
"value": "add_a_photo",
"title": "Add A Photo"
},
{
"value": "add_alarm",
"title": "Add Alarm"
},
{
"value": "add_alert",
"title": "Add Alert"
},
{
"value": "add_box",
"title": "Add Box"
},
{
"value": "add_circle",
"title": "Add Circle"
},
{
"value": "add_circle_outline",
"title": "Add Circle Outline"
},
{
"value": "add_location",
"title": "Add Location"
},
{
"value": "add_shopping_cart",
"title": "Add Shopping Cart"
},
{
"value": "add_to_photos",
"title": "Add To Photos"
},
{
"value": "add_to_queue",
"title": "Add To Queue"
},
{
"value": "adjust",
"title": "Adjust"
},
{
"value": "airline_seat_flat",
"title": "Airline Seat Flat"
},
{
"value": "airline_seat_flat_angled",
"title": "Airline Seat Flat Angled"
},
{
"value": "airline_seat_individual_suite",
"title": "Airline Seat Individual Suite"
},
{
"value": "airline_seat_legroom_extra",
"title": "Airline Seat Legroom Extra"
},
{
"value": "airline_seat_legroom_normal",
"title": "Airline Seat Legroom Normal"
},
{
"value": "airline_seat_legroom_reduced",
"title": "Airline Seat Legroom Reduced"
},
{
"value": "airline_seat_recline_extra",
"title": "Airline Seat Recline Extra"
},
{
"value": "airline_seat_recline_normal",
"title": "Airline Seat Recline Normal"
},
{
"value": "airplanemode_active",
"title": "Airplanemode Active"
},
{
"value": "airplanemode_inactive",
"title": "Airplanemode Inactive"
},
{
"value": "airplay",
"title": "Airplay"
},
{
"value": "airport_shuttle",
"title": "Airport Shuttle"
},
{
"value": "alarm",
"title": "Alarm"
},
{
"value": "alarm_add",
"title": "Alarm Add"
},
{
"value": "alarm_off",
"title": "Alarm Off"
},
{
"value": "alarm_on",
"title": "Alarm On"
},
{
"value": "album",
"title": "Album"
},
{
"value": "all_inclusive",
"title": "All Inclusive"
},
{
"value": "all_out",
"title": "All Out"
},
{
"value": "android",
"title": "Android"
},
{
"value": "announcement",
"title": "Announcement"
},
{
"value": "apps",
"title": "Apps"
},
{
"value": "archive",
"title": "Archive"
},
{
"value": "arrow_back",
"title": "Arrow Back"
},
{
"value": "arrow_downward",
"title": "Arrow Downward"
},
{
"value": "arrow_drop_down",
"title": "Arrow Drop Down"
},
{
"value": "arrow_drop_down_circle",
"title": "Arrow Drop Down Circle"
},
{
"value": "arrow_drop_up",
"title": "Arrow Drop Up"
},
{
"value": "arrow_forward",
"title": "Arrow Forward"
},
{
"value": "arrow_upward",
"title": "Arrow Upward"
},
{
"value": "art_track",
"title": "Art Track"
},
{
"value": "aspect_ratio",
"title": "Aspect Ratio"
},
{
"value": "assessment",
"title": "Assessment"
},
{
"value": "assignment",
"title": "Assignment"
},
{
"value": "assignment_ind",
"title": "Assignment Ind"
},
{
"value": "assignment_late",
"title": "Assignment Late"
},
{
"value": "assignment_return",
"title": "Assignment Return"
},
{
"value": "assignment_returned",
"title": "Assignment Returned"
},
{
"value": "assignment_turned_in",
"title": "Assignment Turned In"
},
{
"value": "assistant",
"title": "Assistant"
},
{
"value": "assistant_photo",
"title": "Assistant Photo"
},
{
"value": "attach_file",
"title": "Attach File"
},
{
"value": "attach_money",
"title": "Attach Money"
},
{
"value": "attachment",
"title": "Attachment"
},
{
"value": "audiotrack",
"title": "Audiotrack"
},
{
"value": "autorenew",
"title": "Autorenew"
},
{
"value": "av_timer",
"title": "Av Timer"
},
{
"value": "backspace",
"title": "Backspace"
},
{
"value": "backup",
"title": "Backup"
},
{
"value": "battery_alert",
"title": "Battery Alert"
},
{
"value": "battery_charging_full",
"title": "Battery Charging Full"
},
{
"value": "battery_full",
"title": "Battery Full"
},
{
"value": "battery_std",
"title": "Battery Std"
},
{
"value": "battery_unknown",
"title": "Battery Unknown"
},
{
"value": "beach_access",
"title": "Beach Access"
},
{
"value": "beenhere",
"title": "Beenhere"
},
{
"value": "block",
"title": "Block"
},
{
"value": "bluetooth",
"title": "Bluetooth"
},
{
"value": "bluetooth_audio",
"title": "Bluetooth Audio"
},
{
"value": "bluetooth_connected",
"title": "Bluetooth Connected"
},
{
"value": "bluetooth_disabled",
"title": "Bluetooth Disabled"
},
{
"value": "bluetooth_searching",
"title": "Bluetooth Searching"
},
{
"value": "blur_circular",
"title": "Blur Circular"
},
{
"value": "blur_linear",
"title": "Blur Linear"
},
{
"value": "blur_off",
"title": "Blur Off"
},
{
"value": "blur_on",
"title": "Blur On"
},
{
"value": "book",
"title": "Book"
},
{
"value": "bookmark",
"title": "Bookmark"
},
{
"value": "bookmark_border",
"title": "Bookmark Border"
},
{
"value": "border_all",
"title": "Border All"
},
{
"value": "border_bottom",
"title": "Border Bottom"
},
{
"value": "border_clear",
"title": "Border Clear"
},
{
"value": "border_color",
"title": "Border Color"
},
{
"value": "border_horizontal",
"title": "Border Horizontal"
},
{
"value": "border_inner",
"title": "Border Inner"
},
{
"value": "border_left",
"title": "Border Left"
},
{
"value": "border_outer",
"title": "Border Outer"
},
{
"value": "border_right",
"title": "Border Right"
},
{
"value": "border_style",
"title": "Border Style"
},
{
"value": "border_top",
"title": "Border Top"
},
{
"value": "border_vertical",
"title": "Border Vertical"
},
{
"value": "branding_watermark",
"title": "Branding Watermark"
},
{
"value": "brightness_1",
"title": "Brightness 1"
},
{
"value": "brightness_2",
"title": "Brightness 2"
},
{
"value": "brightness_3",
"title": "Brightness 3"
},
{
"value": "brightness_4",
"title": "Brightness 4"
},
{
"value": "brightness_5",
"title": "Brightness 5"
},
{
"value": "brightness_6",
"title": "Brightness 6"
},
{
"value": "brightness_7",
"title": "Brightness 7"
},
{
"value": "brightness_auto",
"title": "Brightness Auto"
},
{
"value": "brightness_high",
"title": "Brightness High"
},
{
"value": "brightness_low",
"title": "Brightness Low"
},
{
"value": "brightness_medium",
"title": "Brightness Medium"
},
{
"value": "broken_image",
"title": "Broken Image"
},
{
"value": "brush",
"title": "Brush"
},
{
"value": "bubble_chart",
"title": "Bubble Chart"
},
{
"value": "bug_report",
"title": "Bug Report"
},
{
"value": "build",
"title": "Build"
},
{
"value": "burst_mode",
"title": "Burst Mode"
},
{
"value": "business",
"title": "Business"
},
{
"value": "business_center",
"title": "Business Center"
},
{
"value": "cached",
"title": "Cached"
},
{
"value": "cake",
"title": "Cake"
},
{
"value": "call",
"title": "Call"
},
{
"value": "call_end",
"title": "Call End"
},
{
"value": "call_made",
"title": "Call Made"
},
{
"value": "call_merge",
"title": "Call Merge"
},
{
"value": "call_missed",
"title": "Call Missed"
},
{
"value": "call_missed_outgoing",
"title": "Call Missed Outgoing"
},
{
"value": "call_received",
"title": "Call Received"
},
{
"value": "call_split",
"title": "Call Split"
},
{
"value": "call_to_action",
"title": "Call To Action"
},
{
"value": "camera",
"title": "Camera"
},
{
"value": "camera_alt",
"title": "Camera Alt"
},
{
"value": "camera_enhance",
"title": "Camera Enhance"
},
{
"value": "camera_front",
"title": "Camera Front"
},
{
"value": "camera_rear",
"title": "Camera Rear"
},
{
"value": "camera_roll",
"title": "Camera Roll"
},
{
"value": "cancel",
"title": "Cancel"
},
{
"value": "card_giftcard",
"title": "Card Giftcard"
},
{
"value": "card_membership",
"title": "Card Membership"
},
{
"value": "card_travel",
"title": "Card Travel"
},
{
"value": "casino",
"title": "Casino"
},
{
"value": "cast",
"title": "Cast"
},
{
"value": "cast_connected",
"title": "Cast Connected"
},
{
"value": "center_focus_strong",
"title": "Center Focus Strong"
},
{
"value": "center_focus_weak",
"title": "Center Focus Weak"
},
{
"value": "change_history",
"title": "Change History"
},
{
"value": "chat",
"title": "Chat"
},
{
"value": "chat_bubble",
"title": "Chat Bubble"
},
{
"value": "chat_bubble_outline",
"title": "Chat Bubble Outline"
},
{
"value": "check",
"title": "Check"
},
{
"value": "check_box",
"title": "Check Box"
},
{
"value": "check_box_outline_blank",
"title": "Check Box Outline Blank"
},
{
"value": "check_circle",
"title": "Check Circle"
},
{
"value": "chevron_left",
"title": "Chevron Left"
},
{
"value": "chevron_right",
"title": "Chevron Right"
},
{
"value": "child_care",
"title": "Child Care"
},
{
"value": "child_friendly",
"title": "Child Friendly"
},
{
"value": "chrome_reader_mode",
"title": "Chrome Reader Mode"
},
{
"value": "class",
"title": "Class"
},
{
"value": "clear",
"title": "Clear"
},
{
"value": "clear_all",
"title": "Clear All"
},
{
"value": "close",
"title": "Close"
},
{
"value": "closed_caption",
"title": "Closed Caption"
},
{
"value": "cloud",
"title": "Cloud"
},
{
"value": "cloud_circle",
"title": "Cloud Circle"
},
{
"value": "cloud_done",
"title": "Cloud Done"
},
{
"value": "cloud_download",
"title": "Cloud Download"
},
{
"value": "cloud_off",
"title": "Cloud Off"
},
{
"value": "cloud_queue",
"title": "Cloud Queue"
},
{
"value": "cloud_upload",
"title": "Cloud Upload"
},
{
"value": "code",
"title": "Code"
},
{
"value": "collections",
"title": "Collections"
},
{
"value": "collections_bookmark",
"title": "Collections Bookmark"
},
{
"value": "color_lens",
"title": "Color Lens"
},
{
"value": "colorize",
"title": "Colorize"
},
{
"value": "comment",
"title": "Comment"
},
{
"value": "compare",
"title": "Compare"
},
{
"value": "compare_arrows",
"title": "Compare Arrows"
},
{
"value": "computer",
"title": "Computer"
},
{
"value": "confirmation_number",
"title": "Confirmation Number"
},
{
"value": "contact_mail",
"title": "Contact Mail"
},
{
"value": "contact_phone",
"title": "Contact Phone"
},
{
"value": "contacts",
"title": "Contacts"
},
{
"value": "content_copy",
"title": "Content Copy"
},
{
"value": "content_cut",
"title": "Content Cut"
},
{
"value": "content_paste",
"title": "Content Paste"
},
{
"value": "control_point",
"title": "Control Point"
},
{
"value": "control_point_duplicate",
"title": "Control Point Duplicate"
},
{
"value": "copyright",
"title": "Copyright"
},
{
"value": "create",
"title": "Create"
},
{
"value": "create_new_folder",
"title": "Create New Folder"
},
{
"value": "credit_card",
"title": "Credit Card"
},
{
"value": "crop",
"title": "Crop"
},
{
"value": "crop_16_9",
"title": "Crop 16 9"
},
{
"value": "crop_3_2",
"title": "Crop 3 2"
},
{
"value": "crop_5_4",
"title": "Crop 5 4"
},
{
"value": "crop_7_5",
"title": "Crop 7 5"
},
{
"value": "crop_din",
"title": "Crop Din"
},
{
"value": "crop_free",
"title": "Crop Free"
},
{
"value": "crop_landscape",
"title": "Crop Landscape"
},
{
"value": "crop_original",
"title": "Crop Original"
},
{
"value": "crop_portrait",
"title": "Crop Portrait"
},
{
"value": "crop_rotate",
"title": "Crop Rotate"
},
{
"value": "crop_square",
"title": "Crop Square"
},
{
"value": "dashboard",
"title": "Dashboard"
},
{
"value": "data_usage",
"title": "Data Usage"
},
{
"value": "date_range",
"title": "Date Range"
},
{
"value": "dehaze",
"title": "Dehaze"
},
{
"value": "delete",
"title": "Delete"
},
{
"value": "delete_forever",
"title": "Delete Forever"
},
{
"value": "delete_sweep",
"title": "Delete Sweep"
},
{
"value": "description",
"title": "Description"
},
{
"value": "desktop_mac",
"title": "Desktop Mac"
},
{
"value": "desktop_windows",
"title": "Desktop Windows"
},
{
"value": "details",
"title": "Details"
},
{
"value": "developer_board",
"title": "Developer Board"
},
{
"value": "developer_mode",
"title": "Developer Mode"
},
{
"value": "device_hub",
"title": "Device Hub"
},
{
"value": "devices",
"title": "Devices"
},
{
"value": "devices_other",
"title": "Devices Other"
},
{
"value": "dialer_sip",
"title": "Dialer Sip"
},
{
"value": "dialpad",
"title": "Dialpad"
},
{
"value": "directions",
"title": "Directions"
},
{
"value": "directions_bike",
"title": "Directions Bike"
},
{
"value": "directions_boat",
"title": "Directions Boat"
},
{
"value": "directions_bus",
"title": "Directions Bus"
},
{
"value": "directions_car",
"title": "Directions Car"
},
{
"value": "directions_railway",
"title": "Directions Railway"
},
{
"value": "directions_run",
"title": "Directions Run"
},
{
"value": "directions_subway",
"title": "Directions Subway"
},
{
"value": "directions_transit",
"title": "Directions Transit"
},
{
"value": "directions_walk",
"title": "Directions Walk"
},
{
"value": "disc_full",
"title": "Disc Full"
},
{
"value": "dns",
"title": "Dns"
},
{
"value": "do_not_disturb",
"title": "Do Not Disturb"
},
{
"value": "do_not_disturb_alt",
"title": "Do Not Disturb Alt"
},
{
"value": "do_not_disturb_off",
"title": "Do Not Disturb Off"
},
{
"value": "do_not_disturb_on",
"title": "Do Not Disturb On"
},
{
"value": "dock",
"title": "Dock"
},
{
"value": "domain",
"title": "Domain"
},
{
"value": "done",
"title": "Done"
},
{
"value": "done_all",
"title": "Done All"
},
{
"value": "donut_large",
"title": "Donut Large"
},
{
"value": "donut_small",
"title": "Donut Small"
},
{
"value": "drafts",
"title": "Drafts"
},
{
"value": "drag_handle",
"title": "Drag Handle"
},
{
"value": "drive_eta",
"title": "Drive Eta"
},
{
"value": "dvr",
"title": "Dvr"
},
{
"value": "edit",
"title": "Edit"
},
{
"value": "edit_location",
"title": "Edit Location"
},
{
"value": "eject",
"title": "Eject"
},
{
"value": "email",
"title": "Email"
},
{
"value": "enhanced_encryption",
"title": "Enhanced Encryption"
},
{
"value": "equalizer",
"title": "Equalizer"
},
{
"value": "error",
"title": "Error"
},
{
"value": "error_outline",
"title": "Error Outline"
},
{
"value": "euro_symbol",
"title": "Euro Symbol"
},
{
"value": "ev_station",
"title": "Ev Station"
},
{
"value": "event",
"title": "Event"
},
{
"value": "event_available",
"title": "Event Available"
},
{
"value": "event_busy",
"title": "Event Busy"
},
{
"value": "event_note",
"title": "Event Note"
},
{
"value": "event_seat",
"title": "Event Seat"
},
{
"value": "exit_to_app",
"title": "Exit To App"
},
{
"value": "expand_less",
"title": "Expand Less"
},
{
"value": "expand_more",
"title": "Expand More"
},
{
"value": "explicit",
"title": "Explicit"
},
{
"value": "explore",
"title": "Explore"
},
{
"value": "exposure",
"title": "Exposure"
},
{
"value": "exposure_neg_1",
"title": "Exposure Neg 1"
},
{
"value": "exposure_neg_2",
"title": "Exposure Neg 2"
},
{
"value": "exposure_plus_1",
"title": "Exposure Plus 1"
},
{
"value": "exposure_plus_2",
"title": "Exposure Plus 2"
},
{
"value": "exposure_zero",
"title": "Exposure Zero"
},
{
"value": "extension",
"title": "Extension"
},
{
"value": "face",
"title": "Face"
},
{
"value": "fast_forward",
"title": "Fast Forward"
},
{
"value": "fast_rewind",
"title": "Fast Rewind"
},
{
"value": "favorite",
"title": "Favorite"
},
{
"value": "favorite_border",
"title": "Favorite Border"
},
{
"value": "featured_play_list",
"title": "Featured Play List"
},
{
"value": "featured_video",
"title": "Featured Video"
},
{
"value": "feedback",
"title": "Feedback"
},
{
"value": "fiber_dvr",
"title": "Fiber Dvr"
},
{
"value": "fiber_manual_record",
"title": "Fiber Manual Record"
},
{
"value": "fiber_new",
"title": "Fiber New"
},
{
"value": "fiber_pin",
"title": "Fiber Pin"
},
{
"value": "fiber_smart_record",
"title": "Fiber Smart Record"
},
{
"value": "file_download",
"title": "File Download"
},
{
"value": "file_upload",
"title": "File Upload"
},
{
"value": "filter",
"title": "Filter"
},
{
"value": "filter_1",
"title": "Filter 1"
},
{
"value": "filter_2",
"title": "Filter 2"
},
{
"value": "filter_3",
"title": "Filter 3"
},
{
"value": "filter_4",
"title": "Filter 4"
},
{
"value": "filter_5",
"title": "Filter 5"
},
{
"value": "filter_6",
"title": "Filter 6"
},
{
"value": "filter_7",
"title": "Filter 7"
},
{
"value": "filter_8",
"title": "Filter 8"
},
{
"value": "filter_9",
"title": "Filter 9"
},
{
"value": "filter_9_plus",
"title": "Filter 9 Plus"
},
{
"value": "filter_b_and_w",
"title": "Filter B And W"
},
{
"value": "filter_center_focus",
"title": "Filter Center Focus"
},
{
"value": "filter_drama",
"title": "Filter Drama"
},
{
"value": "filter_frames",
"title": "Filter Frames"
},
{
"value": "filter_hdr",
"title": "Filter Hdr"
},
{
"value": "filter_list",
"title": "Filter List"
},
{
"value": "filter_none",
"title": "Filter None"
},
{
"value": "filter_tilt_shift",
"title": "Filter Tilt Shift"
},
{
"value": "filter_vintage",
"title": "Filter Vintage"
},
{
"value": "find_in_page",
"title": "Find In Page"
},
{
"value": "find_replace",
"title": "Find Replace"
},
{
"value": "fingerprint",
"title": "Fingerprint"
},
{
"value": "first_page",
"title": "First Page"
},
{
"value": "fitness_center",
"title": "Fitness Center"
},
{
"value": "flag",
"title": "Flag"
},
{
"value": "flare",
"title": "Flare"
},
{
"value": "flash_auto",
"title": "Flash Auto"
},
{
"value": "flash_off",
"title": "Flash Off"
},
{
"value": "flash_on",
"title": "Flash On"
},
{
"value": "flight",
"title": "Flight"
},
{
"value": "flight_land",
"title": "Flight Land"
},
{
"value": "flight_takeoff",
"title": "Flight Takeoff"
},
{
"value": "flip",
"title": "Flip"
},
{
"value": "flip_to_back",
"title": "Flip To Back"
},
{
"value": "flip_to_front",
"title": "Flip To Front"
},
{
"value": "folder",
"title": "Folder"
},
{
"value": "folder_open",
"title": "Folder Open"
},
{
"value": "folder_shared",
"title": "Folder Shared"
},
{
"value": "folder_special",
"title": "Folder Special"
},
{
"value": "font_download",
"title": "Font Download"
},
{
"value": "format_align_center",
"title": "Format Align Center"
},
{
"value": "format_align_justify",
"title": "Format Align Justify"
},
{
"value": "format_align_left",
"title": "Format Align Left"
},
{
"value": "format_align_right",
"title": "Format Align Right"
},
{
"value": "format_bold",
"title": "Format Bold"
},
{
"value": "format_clear",
"title": "Format Clear"
},
{
"value": "format_color_fill",
"title": "Format Color Fill"
},
{
"value": "format_color_reset",
"title": "Format Color Reset"
},
{
"value": "format_color_text",
"title": "Format Color Text"
},
{
"value": "format_indent_decrease",
"title": "Format Indent Decrease"
},
{
"value": "format_indent_increase",
"title": "Format Indent Increase"
},
{
"value": "format_italic",
"title": "Format Italic"
},
{
"value": "format_line_spacing",
"title": "Format Line Spacing"
},
{
"value": "format_list_bulleted",
"title": "Format List Bulleted"
},
{
"value": "format_list_numbered",
"title": "Format List Numbered"
},
{
"value": "format_paint",
"title": "Format Paint"
},
{
"value": "format_quote",
"title": "Format Quote"
},
{
"value": "format_shapes",
"title": "Format Shapes"
},
{
"value": "format_size",
"title": "Format Size"
},
{
"value": "format_strikethrough",
"title": "Format Strikethrough"
},
{
"value": "format_textdirection_l_to_r",
"title": "Format Textdirection L To R"
},
{
"value": "format_textdirection_r_to_l",
"title": "Format Textdirection R To L"
},
{
"value": "format_underlined",
"title": "Format Underlined"
},
{
"value": "forum",
"title": "Forum"
},
{
"value": "forward",
"title": "Forward"
},
{
"value": "forward_10",
"title": "Forward 10"
},
{
"value": "forward_30",
"title": "Forward 30"
},
{
"value": "forward_5",
"title": "Forward 5"
},
{
"value": "free_breakfast",
"title": "Free Breakfast"
},
{
"value": "fullscreen",
"title": "Fullscreen"
},
{
"value": "fullscreen_exit",
"title": "Fullscreen Exit"
},
{
"value": "functions",
"title": "Functions"
},
{
"value": "g_translate",
"title": "G Translate"
},
{
"value": "gamepad",
"title": "Gamepad"
},
{
"value": "games",
"title": "Games"
},
{
"value": "gavel",
"title": "Gavel"
},
{
"value": "gesture",
"title": "Gesture"
},
{
"value": "get_app",
"title": "Get App"
},
{
"value": "gif",
"title": "Gif"
},
{
"value": "golf_course",
"title": "Golf Course"
},
{
"value": "gps_fixed",
"title": "Gps Fixed"
},
{
"value": "gps_not_fixed",
"title": "Gps Not Fixed"
},
{
"value": "gps_off",
"title": "Gps Off"
},
{
"value": "grade",
"title": "Grade"
},
{
"value": "gradient",
"title": "Gradient"
},
{
"value": "grain",
"title": "Grain"
},
{
"value": "graphic_eq",
"title": "Graphic Eq"
},
{
"value": "grid_off",
"title": "Grid Off"
},
{
"value": "grid_on",
"title": "Grid On"
},
{
"value": "group",
"title": "Group"
},
{
"value": "group_add",
"title": "Group Add"
},
{
"value": "group_work",
"title": "Group Work"
},
{
"value": "hd",
"title": "Hd"
},
{
"value": "hdr_off",
"title": "Hdr Off"
},
{
"value": "hdr_on",
"title": "Hdr On"
},
{
"value": "hdr_strong",
"title": "Hdr Strong"
},
{
"value": "hdr_weak",
"title": "Hdr Weak"
},
{
"value": "headset",
"title": "Headset"
},
{
"value": "headset_mic",
"title": "Headset Mic"
},
{
"value": "healing",
"title": "Healing"
},
{
"value": "hearing",
"title": "Hearing"
},
{
"value": "help",
"title": "Help"
},
{
"value": "help_outline",
"title": "Help Outline"
},
{
"value": "high_quality",
"title": "High Quality"
},
{
"value": "highlight",
"title": "Highlight"
},
{
"value": "highlight_off",
"title": "Highlight Off"
},
{
"value": "history",
"title": "History"
},
{
"value": "home",
"title": "Home"
},
{
"value": "hot_tub",
"title": "Hot Tub"
},
{
"value": "hotel",
"title": "Hotel"
},
{
"value": "hourglass_empty",
"title": "Hourglass Empty"
},
{
"value": "hourglass_full",
"title": "Hourglass Full"
},
{
"value": "http",
"title": "Http"
},
{
"value": "https",
"title": "Https"
},
{
"value": "image",
"title": "Image"
},
{
"value": "image_aspect_ratio",
"title": "Image Aspect Ratio"
},
{
"value": "import_contacts",
"title": "Import Contacts"
},
{
"value": "import_export",
"title": "Import Export"
},
{
"value": "important_devices",
"title": "Important Devices"
},
{
"value": "inbox",
"title": "Inbox"
},
{
"value": "indeterminate_check_box",
"title": "Indeterminate Check Box"
},
{
"value": "info",
"title": "Info"
},
{
"value": "info_outline",
"title": "Info Outline"
},
{
"value": "input",
"title": "Input"
},
{
"value": "insert_chart",
"title": "Insert Chart"
},
{
"value": "insert_comment",
"title": "Insert Comment"
},
{
"value": "insert_drive_file",
"title": "Insert Drive File"
},
{
"value": "insert_emoticon",
"title": "Insert Emoticon"
},
{
"value": "insert_invitation",
"title": "Insert Invitation"
},
{
"value": "insert_link",
"title": "Insert Link"
},
{
"value": "insert_photo",
"title": "Insert Photo"
},
{
"value": "invert_colors",
"title": "Invert Colors"
},
{
"value": "invert_colors_off",
"title": "Invert Colors Off"
},
{
"value": "iso",
"title": "Iso"
},
{
"value": "keyboard",
"title": "Keyboard"
},
{
"value": "keyboard_arrow_down",
"title": "Keyboard Arrow Down"
},
{
"value": "keyboard_arrow_left",
"title": "Keyboard Arrow Left"
},
{
"value": "keyboard_arrow_right",
"title": "Keyboard Arrow Right"
},
{
"value": "keyboard_arrow_up",
"title": "Keyboard Arrow Up"
},
{
"value": "keyboard_backspace",
"title": "Keyboard Backspace"
},
{
"value": "keyboard_capslock",
"title": "Keyboard Capslock"
},
{
"value": "keyboard_hide",
"title": "Keyboard Hide"
},
{
"value": "keyboard_return",
"title": "Keyboard Return"
},
{
"value": "keyboard_tab",
"title": "Keyboard Tab"
},
{
"value": "keyboard_voice",
"title": "Keyboard Voice"
},
{
"value": "kitchen",
"title": "Kitchen"
},
{
"value": "label",
"title": "Label"
},
{
"value": "label_outline",
"title": "Label Outline"
},
{
"value": "landscape",
"title": "Landscape"
},
{
"value": "language",
"title": "Language"
},
{
"value": "laptop",
"title": "Laptop"
},
{
"value": "laptop_chromebook",
"title": "Laptop Chromebook"
},
{
"value": "laptop_mac",
"title": "Laptop Mac"
},
{
"value": "laptop_windows",
"title": "Laptop Windows"
},
{
"value": "last_page",
"title": "Last Page"
},
{
"value": "launch",
"title": "Launch"
},
{
"value": "layers",
"title": "Layers"
},
{
"value": "layers_clear",
"title": "Layers Clear"
},
{
"value": "leak_add",
"title": "Leak Add"
},
{
"value": "leak_remove",
"title": "Leak Remove"
},
{
"value": "lens",
"title": "Lens"
},
{
"value": "library_add",
"title": "Library Add"
},
{
"value": "library_books",
"title": "Library Books"
},
{
"value": "library_music",
"title": "Library Music"
},
{
"value": "lightbulb_outline",
"title": "Lightbulb Outline"
},
{
"value": "line_style",
"title": "Line Style"
},
{
"value": "line_weight",
"title": "Line Weight"
},
{
"value": "linear_scale",
"title": "Linear Scale"
},
{
"value": "link",
"title": "Link"
},
{
"value": "linked_camera",
"title": "Linked Camera"
},
{
"value": "list",
"title": "List"
},
{
"value": "live_help",
"title": "Live Help"
},
{
"value": "live_tv",
"title": "Live Tv"
},
{
"value": "local_activity",
"title": "Local Activity"
},
{
"value": "local_airport",
"title": "Local Airport"
},
{
"value": "local_atm",
"title": "Local Atm"
},
{
"value": "local_bar",
"title": "Local Bar"
},
{
"value": "local_cafe",
"title": "Local Cafe"
},
{
"value": "local_car_wash",
"title": "Local Car Wash"
},
{
"value": "local_convenience_store",
"title": "Local Convenience Store"
},
{
"value": "local_dining",
"title": "Local Dining"
},
{
"value": "local_drink",
"title": "Local Drink"
},
{
"value": "local_florist",
"title": "Local Florist"
},
{
"value": "local_gas_station",
"title": "Local Gas Station"
},
{
"value": "local_grocery_store",
"title": "Local Grocery Store"
},
{
"value": "local_hospital",
"title": "Local Hospital"
},
{
"value": "local_hotel",
"title": "Local Hotel"
},
{
"value": "local_laundry_service",
"title": "Local Laundry Service"
},
{
"value": "local_library",
"title": "Local Library"
},
{
"value": "local_mall",
"title": "Local Mall"
},
{
"value": "local_movies",
"title": "Local Movies"
},
{
"value": "local_offer",
"title": "Local Offer"
},
{
"value": "local_parking",
"title": "Local Parking"
},
{
"value": "local_pharmacy",
"title": "Local Pharmacy"
},
{
"value": "local_phone",
"title": "Local Phone"
},
{
"value": "local_pizza",
"title": "Local Pizza"
},
{
"value": "local_play",
"title": "Local Play"
},
{
"value": "local_post_office",
"title": "Local Post Office"
},
{
"value": "local_printshop",
"title": "Local Printshop"
},
{
"value": "local_see",
"title": "Local See"
},
{
"value": "local_shipping",
"title": "Local Shipping"
},
{
"value": "local_taxi",
"title": "Local Taxi"
},
{
"value": "location_city",
"title": "Location City"
},
{
"value": "location_disabled",
"title": "Location Disabled"
},
{
"value": "location_off",
"title": "Location Off"
},
{
"value": "location_on",
"title": "Location On"
},
{
"value": "location_searching",
"title": "Location Searching"
},
{
"value": "lock",
"title": "Lock"
},
{
"value": "lock_open",
"title": "Lock Open"
},
{
"value": "lock_outline",
"title": "Lock Outline"
},
{
"value": "looks",
"title": "Looks"
},
{
"value": "looks_3",
"title": "Looks 3"
},
{
"value": "looks_4",
"title": "Looks 4"
},
{
"value": "looks_5",
"title": "Looks 5"
},
{
"value": "looks_6",
"title": "Looks 6"
},
{
"value": "looks_one",
"title": "Looks One"
},
{
"value": "looks_two",
"title": "Looks Two"
},
{
"value": "loop",
"title": "Loop"
},
{
"value": "loupe",
"title": "Loupe"
},
{
"value": "low_priority",
"title": "Low Priority"
},
{
"value": "loyalty",
"title": "Loyalty"
},
{
"value": "mail",
"title": "Mail"
},
{
"value": "mail_outline",
"title": "Mail Outline"
},
{
"value": "map",
"title": "Map"
},
{
"value": "markunread",
"title": "Markunread"
},
{
"value": "markunread_mailbox",
"title": "Markunread Mailbox"
},
{
"value": "memory",
"title": "Memory"
},
{
"value": "menu",
"title": "Menu"
},
{
"value": "merge_type",
"title": "Merge Type"
},
{
"value": "message",
"title": "Message"
},
{
"value": "mic",
"title": "Mic"
},
{
"value": "mic_none",
"title": "Mic None"
},
{
"value": "mic_off",
"title": "Mic Off"
},
{
"value": "mms",
"title": "Mms"
},
{
"value": "mode_comment",
"title": "Mode Comment"
},
{
"value": "mode_edit",
"title": "Mode Edit"
},
{
"value": "monetization_on",
"title": "Monetization On"
},
{
"value": "money_off",
"title": "Money Off"
},
{
"value": "monochrome_photos",
"title": "Monochrome Photos"
},
{
"value": "mood",
"title": "Mood"
},
{
"value": "mood_bad",
"title": "Mood Bad"
},
{
"value": "more",
"title": "More"
},
{
"value": "more_horiz",
"title": "More Horiz"
},
{
"value": "more_vert",
"title": "More Vert"
},
{
"value": "motorcycle",
"title": "Motorcycle"
},
{
"value": "mouse",
"title": "Mouse"
},
{
"value": "move_to_inbox",
"title": "Move To Inbox"
},
{
"value": "movie",
"title": "Movie"
},
{
"value": "movie_creation",
"title": "Movie Creation"
},
{
"value": "movie_filter",
"title": "Movie Filter"
},
{
"value": "multiline_chart",
"title": "Multiline Chart"
},
{
"value": "music_note",
"title": "Music Note"
},
{
"value": "music_video",
"title": "Music Video"
},
{
"value": "my_location",
"title": "My Location"
},
{
"value": "nature",
"title": "Nature"
},
{
"value": "nature_people",
"title": "Nature People"
},
{
"value": "navigate_before",
"title": "Navigate Before"
},
{
"value": "navigate_next",
"title": "Navigate Next"
},
{
"value": "navigation",
"title": "Navigation"
},
{
"value": "near_me",
"title": "Near Me"
},
{
"value": "network_cell",
"title": "Network Cell"
},
{
"value": "network_check",
"title": "Network Check"
},
{
"value": "network_locked",
"title": "Network Locked"
},
{
"value": "network_wifi",
"title": "Network Wifi"
},
{
"value": "new_releases",
"title": "New Releases"
},
{
"value": "next_week",
"title": "Next Week"
},
{
"value": "nfc",
"title": "Nfc"
},
{
"value": "no_encryption",
"title": "No Encryption"
},
{
"value": "no_sim",
"title": "No Sim"
},
{
"value": "not_interested",
"title": "Not Interested"
},
{
"value": "note",
"title": "Note"
},
{
"value": "note_add",
"title": "Note Add"
},
{
"value": "notifications",
"title": "Notifications"
},
{
"value": "notifications_active",
"title": "Notifications Active"
},
{
"value": "notifications_none",
"title": "Notifications None"
},
{
"value": "notifications_off",
"title": "Notifications Off"
},
{
"value": "notifications_paused",
"title": "Notifications Paused"
},
{
"value": "offline_pin",
"title": "Offline Pin"
},
{
"value": "ondemand_video",
"title": "Ondemand Video"
},
{
"value": "opacity",
"title": "Opacity"
},
{
"value": "open_in_browser",
"title": "Open In Browser"
},
{
"value": "open_in_new",
"title": "Open In New"
},
{
"value": "open_with",
"title": "Open With"
},
{
"value": "pages",
"title": "Pages"
},
{
"value": "pageview",
"title": "Pageview"
},
{
"value": "palette",
"title": "Palette"
},
{
"value": "pan_tool",
"title": "Pan Tool"
},
{
"value": "panorama",
"title": "Panorama"
},
{
"value": "panorama_fish_eye",
"title": "Panorama Fish Eye"
},
{
"value": "panorama_horizontal",
"title": "Panorama Horizontal"
},
{
"value": "panorama_vertical",
"title": "Panorama Vertical"
},
{
"value": "panorama_wide_angle",
"title": "Panorama Wide Angle"
},
{
"value": "party_mode",
"title": "Party Mode"
},
{
"value": "pause",
"title": "Pause"
},
{
"value": "pause_circle_filled",
"title": "Pause Circle Filled"
},
{
"value": "pause_circle_outline",
"title": "Pause Circle Outline"
},
{
"value": "payment",
"title": "Payment"
},
{
"value": "people",
"title": "People"
},
{
"value": "people_outline",
"title": "People Outline"
},
{
"value": "perm_camera_mic",
"title": "Perm Camera Mic"
},
{
"value": "perm_contact_calendar",
"title": "Perm Contact Calendar"
},
{
"value": "perm_data_setting",
"title": "Perm Data Setting"
},
{
"value": "perm_device_information",
"title": "Perm Device Information"
},
{
"value": "perm_identity",
"title": "Perm Identity"
},
{
"value": "perm_media",
"title": "Perm Media"
},
{
"value": "perm_phone_msg",
"title": "Perm Phone Msg"
},
{
"value": "perm_scan_wifi",
"title": "Perm Scan Wifi"
},
{
"value": "person",
"title": "Person"
},
{
"value": "person_add",
"title": "Person Add"
},
{
"value": "person_outline",
"title": "Person Outline"
},
{
"value": "person_pin",
"title": "Person Pin"
},
{
"value": "person_pin_circle",
"title": "Person Pin Circle"
},
{
"value": "personal_video",
"title": "Personal Video"
},
{
"value": "pets",
"title": "Pets"
},
{
"value": "phone",
"title": "Phone"
},
{
"value": "phone_android",
"title": "Phone Android"
},
{
"value": "phone_bluetooth_speaker",
"title": "Phone Bluetooth Speaker"
},
{
"value": "phone_forwarded",
"title": "Phone Forwarded"
},
{
"value": "phone_in_talk",
"title": "Phone In Talk"
},
{
"value": "phone_iphone",
"title": "Phone Iphone"
},
{
"value": "phone_locked",
"title": "Phone Locked"
},
{
"value": "phone_missed",
"title": "Phone Missed"
},
{
"value": "phone_paused",
"title": "Phone Paused"
},
{
"value": "phonelink",
"title": "Phonelink"
},
{
"value": "phonelink_erase",
"title": "Phonelink Erase"
},
{
"value": "phonelink_lock",
"title": "Phonelink Lock"
},
{
"value": "phonelink_off",
"title": "Phonelink Off"
},
{
"value": "phonelink_ring",
"title": "Phonelink Ring"
},
{
"value": "phonelink_setup",
"title": "Phonelink Setup"
},
{
"value": "photo",
"title": "Photo"
},
{
"value": "photo_album",
"title": "Photo Album"
},
{
"value": "photo_camera",
"title": "Photo Camera"
},
{
"value": "photo_filter",
"title": "Photo Filter"
},
{
"value": "photo_library",
"title": "Photo Library"
},
{
"value": "photo_size_select_actual",
"title": "Photo Size Select Actual"
},
{
"value": "photo_size_select_large",
"title": "Photo Size Select Large"
},
{
"value": "photo_size_select_small",
"title": "Photo Size Select Small"
},
{
"value": "picture_as_pdf",
"title": "Picture As Pdf"
},
{
"value": "picture_in_picture",
"title": "Picture In Picture"
},
{
"value": "picture_in_picture_alt",
"title": "Picture In Picture Alt"
},
{
"value": "pie_chart",
"title": "Pie Chart"
},
{
"value": "pie_chart_outlined",
"title": "Pie Chart Outlined"
},
{
"value": "pin_drop",
"title": "Pin Drop"
},
{
"value": "place",
"title": "Place"
},
{
"value": "play_arrow",
"title": "Play Arrow"
},
{
"value": "play_circle_filled",
"title": "Play Circle Filled"
},
{
"value": "play_circle_outline",
"title": "Play Circle Outline"
},
{
"value": "play_for_work",
"title": "Play For Work"
},
{
"value": "playlist_add",
"title": "Playlist Add"
},
{
"value": "playlist_add_check",
"title": "Playlist Add Check"
},
{
"value": "playlist_play",
"title": "Playlist Play"
},
{
"value": "plus_one",
"title": "Plus One"
},
{
"value": "poll",
"title": "Poll"
},
{
"value": "polymer",
"title": "Polymer"
},
{
"value": "pool",
"title": "Pool"
},
{
"value": "portable_wifi_off",
"title": "Portable Wifi Off"
},
{
"value": "portrait",
"title": "Portrait"
},
{
"value": "power",
"title": "Power"
},
{
"value": "power_input",
"title": "Power Input"
},
{
"value": "power_settings_new",
"title": "Power Settings New"
},
{
"value": "pregnant_woman",
"title": "Pregnant Woman"
},
{
"value": "present_to_all",
"title": "Present To All"
},
{
"value": "print",
"title": "Print"
},
{
"value": "priority_high",
"title": "Priority High"
},
{
"value": "public",
"title": "Public"
},
{
"value": "publish",
"title": "Publish"
},
{
"value": "query_builder",
"title": "Query Builder"
},
{
"value": "question_answer",
"title": "Question Answer"
},
{
"value": "queue",
"title": "Queue"
},
{
"value": "queue_music",
"title": "Queue Music"
},
{
"value": "queue_play_next",
"title": "Queue Play Next"
},
{
"value": "radio",
"title": "Radio"
},
{
"value": "radio_button_checked",
"title": "Radio Button Checked"
},
{
"value": "radio_button_unchecked",
"title": "Radio Button Unchecked"
},
{
"value": "rate_review",
"title": "Rate Review"
},
{
"value": "receipt",
"title": "Receipt"
},
{
"value": "recent_actors",
"title": "Recent Actors"
},
{
"value": "record_voice_over",
"title": "Record Voice Over"
},
{
"value": "redeem",
"title": "Redeem"
},
{
"value": "redo",
"title": "Redo"
},
{
"value": "refresh",
"title": "Refresh"
},
{
"value": "remove",
"title": "Remove"
},
{
"value": "remove_circle",
"title": "Remove Circle"
},
{
"value": "remove_circle_outline",
"title": "Remove Circle Outline"
},
{
"value": "remove_from_queue",
"title": "Remove From Queue"
},
{
"value": "remove_red_eye",
"title": "Remove Red Eye"
},
{
"value": "remove_shopping_cart",
"title": "Remove Shopping Cart"
},
{
"value": "reorder",
"title": "Reorder"
},
{
"value": "repeat",
"title": "Repeat"
},
{
"value": "repeat_one",
"title": "Repeat One"
},
{
"value": "replay",
"title": "Replay"
},
{
"value": "replay_10",
"title": "Replay 10"
},
{
"value": "replay_30",
"title": "Replay 30"
},
{
"value": "replay_5",
"title": "Replay 5"
},
{
"value": "reply",
"title": "Reply"
},
{
"value": "reply_all",
"title": "Reply All"
},
{
"value": "report",
"title": "Report"
},
{
"value": "report_problem",
"title": "Report Problem"
},
{
"value": "restaurant",
"title": "Restaurant"
},
{
"value": "restaurant_menu",
"title": "Restaurant Menu"
},
{
"value": "restore",
"title": "Restore"
},
{
"value": "restore_page",
"title": "Restore Page"
},
{
"value": "ring_volume",
"title": "Ring Volume"
},
{
"value": "room",
"title": "Room"
},
{
"value": "room_service",
"title": "Room Service"
},
{
"value": "rotate_90_degrees_ccw",
"title": "Rotate 90 Degrees Ccw"
},
{
"value": "rotate_left",
"title": "Rotate Left"
},
{
"value": "rotate_right",
"title": "Rotate Right"
},
{
"value": "rounded_corner",
"title": "Rounded Corner"
},
{
"value": "router",
"title": "Router"
},
{
"value": "rowing",
"title": "Rowing"
},
{
"value": "rss_feed",
"title": "Rss Feed"
},
{
"value": "rv_hookup",
"title": "Rv Hookup"
},
{
"value": "satellite",
"title": "Satellite"
},
{
"value": "save",
"title": "Save"
},
{
"value": "scanner",
"title": "Scanner"
},
{
"value": "schedule",
"title": "Schedule"
},
{
"value": "school",
"title": "School"
},
{
"value": "screen_lock_landscape",
"title": "Screen Lock Landscape"
},
{
"value": "screen_lock_portrait",
"title": "Screen Lock Portrait"
},
{
"value": "screen_lock_rotation",
"title": "Screen Lock Rotation"
},
{
"value": "screen_rotation",
"title": "Screen Rotation"
},
{
"value": "screen_share",
"title": "Screen Share"
},
{
"value": "sd_card",
"title": "Sd Card"
},
{
"value": "sd_storage",
"title": "Sd Storage"
},
{
"value": "search",
"title": "Search"
},
{
"value": "security",
"title": "Security"
},
{
"value": "select_all",
"title": "Select All"
},
{
"value": "send",
"title": "Send"
},
{
"value": "sentiment_dissatisfied",
"title": "Sentiment Dissatisfied"
},
{
"value": "sentiment_neutral",
"title": "Sentiment Neutral"
},
{
"value": "sentiment_satisfied",
"title": "Sentiment Satisfied"
},
{
"value": "sentiment_very_dissatisfied",
"title": "Sentiment Very Dissatisfied"
},
{
"value": "sentiment_very_satisfied",
"title": "Sentiment Very Satisfied"
},
{
"value": "settings",
"title": "Settings"
},
{
"value": "settings_applications",
"title": "Settings Applications"
},
{
"value": "settings_backup_restore",
"title": "Settings Backup Restore"
},
{
"value": "settings_bluetooth",
"title": "Settings Bluetooth"
},
{
"value": "settings_brightness",
"title": "Settings Brightness"
},
{
"value": "settings_cell",
"title": "Settings Cell"
},
{
"value": "settings_ethernet",
"title": "Settings Ethernet"
},
{
"value": "settings_input_antenna",
"title": "Settings Input Antenna"
},
{
"value": "settings_input_component",
"title": "Settings Input Component"
},
{
"value": "settings_input_composite",
"title": "Settings Input Composite"
},
{
"value": "settings_input_hdmi",
"title": "Settings Input Hdmi"
},
{
"value": "settings_input_svideo",
"title": "Settings Input Svideo"
},
{
"value": "settings_overscan",
"title": "Settings Overscan"
},
{
"value": "settings_phone",
"title": "Settings Phone"
},
{
"value": "settings_power",
"title": "Settings Power"
},
{
"value": "settings_remote",
"title": "Settings Remote"
},
{
"value": "settings_system_daydream",
"title": "Settings System Daydream"
},
{
"value": "settings_voice",
"title": "Settings Voice"
},
{
"value": "share",
"title": "Share"
},
{
"value": "shop",
"title": "Shop"
},
{
"value": "shop_two",
"title": "Shop Two"
},
{
"value": "shopping_basket",
"title": "Shopping Basket"
},
{
"value": "shopping_cart",
"title": "Shopping Cart"
},
{
"value": "short_text",
"title": "Short Text"
},
{
"value": "show_chart",
"title": "Show Chart"
},
{
"value": "shuffle",
"title": "Shuffle"
},
{
"value": "signal_cellular_4_bar",
"title": "Signal Cellular 4 Bar"
},
{
"value": "signal_cellular_connected_no_internet_4_bar",
"title": "Signal Cellular Connected No Internet 4 Bar"
},
{
"value": "signal_cellular_no_sim",
"title": "Signal Cellular No Sim"
},
{
"value": "signal_cellular_null",
"title": "Signal Cellular Null"
},
{
"value": "signal_cellular_off",
"title": "Signal Cellular Off"
},
{
"value": "signal_wifi_4_bar",
"title": "Signal Wifi 4 Bar"
},
{
"value": "signal_wifi_4_bar_lock",
"title": "Signal Wifi 4 Bar Lock"
},
{
"value": "signal_wifi_off",
"title": "Signal Wifi Off"
},
{
"value": "sim_card",
"title": "Sim Card"
},
{
"value": "sim_card_alert",
"title": "Sim Card Alert"
},
{
"value": "skip_next",
"title": "Skip Next"
},
{
"value": "skip_previous",
"title": "Skip Previous"
},
{
"value": "slideshow",
"title": "Slideshow"
},
{
"value": "slow_motion_video",
"title": "Slow Motion Video"
},
{
"value": "smartphone",
"title": "Smartphone"
},
{
"value": "smoke_free",
"title": "Smoke Free"
},
{
"value": "smoking_rooms",
"title": "Smoking Rooms"
},
{
"value": "sms",
"title": "Sms"
},
{
"value": "sms_failed",
"title": "Sms Failed"
},
{
"value": "snooze",
"title": "Snooze"
},
{
"value": "sort",
"title": "Sort"
},
{
"value": "sort_by_alpha",
"title": "Sort By Alpha"
},
{
"value": "spa",
"title": "Spa"
},
{
"value": "space_bar",
"title": "Space Bar"
},
{
"value": "speaker",
"title": "Speaker"
},
{
"value": "speaker_group",
"title": "Speaker Group"
},
{
"value": "speaker_notes",
"title": "Speaker Notes"
},
{
"value": "speaker_notes_off",
"title": "Speaker Notes Off"
},
{
"value": "speaker_phone",
"title": "Speaker Phone"
},
{
"value": "spellcheck",
"title": "Spellcheck"
},
{
"value": "star",
"title": "Star"
},
{
"value": "star_border",
"title": "Star Border"
},
{
"value": "star_half",
"title": "Star Half"
},
{
"value": "stars",
"title": "Stars"
},
{
"value": "stay_current_landscape",
"title": "Stay Current Landscape"
},
{
"value": "stay_current_portrait",
"title": "Stay Current Portrait"
},
{
"value": "stay_primary_landscape",
"title": "Stay Primary Landscape"
},
{
"value": "stay_primary_portrait",
"title": "Stay Primary Portrait"
},
{
"value": "stop",
"title": "Stop"
},
{
"value": "stop_screen_share",
"title": "Stop Screen Share"
},
{
"value": "storage",
"title": "Storage"
},
{
"value": "store",
"title": "Store"
},
{
"value": "store_mall_directory",
"title": "Store Mall Directory"
},
{
"value": "straighten",
"title": "Straighten"
},
{
"value": "streetview",
"title": "Streetview"
},
{
"value": "strikethrough_s",
"title": "Strikethrough S"
},
{
"value": "style",
"title": "Style"
},
{
"value": "subdirectory_arrow_left",
"title": "Subdirectory Arrow Left"
},
{
"value": "subdirectory_arrow_right",
"title": "Subdirectory Arrow Right"
},
{
"value": "subject",
"title": "Subject"
},
{
"value": "subscriptions",
"title": "Subscriptions"
},
{
"value": "subtitles",
"title": "Subtitles"
},
{
"value": "subway",
"title": "Subway"
},
{
"value": "supervisor_account",
"title": "Supervisor Account"
},
{
"value": "surround_sound",
"title": "Surround Sound"
},
{
"value": "swap_calls",
"title": "Swap Calls"
},
{
"value": "swap_horiz",
"title": "Swap Horiz"
},
{
"value": "swap_vert",
"title": "Swap Vert"
},
{
"value": "swap_vertical_circle",
"title": "Swap Vertical Circle"
},
{
"value": "switch_camera",
"title": "Switch Camera"
},
{
"value": "switch_video",
"title": "Switch Video"
},
{
"value": "sync",
"title": "Sync"
},
{
"value": "sync_disabled",
"title": "Sync Disabled"
},
{
"value": "sync_problem",
"title": "Sync Problem"
},
{
"value": "system_update",
"title": "System Update"
},
{
"value": "system_update_alt",
"title": "System Update Alt"
},
{
"value": "tab",
"title": "Tab"
},
{
"value": "tab_unselected",
"title": "Tab Unselected"
},
{
"value": "tablet",
"title": "Tablet"
},
{
"value": "tablet_android",
"title": "Tablet Android"
},
{
"value": "tablet_mac",
"title": "Tablet Mac"
},
{
"value": "tag_faces",
"title": "Tag Faces"
},
{
"value": "tap_and_play",
"title": "Tap And Play"
},
{
"value": "terrain",
"title": "Terrain"
},
{
"value": "text_fields",
"title": "Text Fields"
},
{
"value": "text_format",
"title": "Text Format"
},
{
"value": "textsms",
"title": "Textsms"
},
{
"value": "texture",
"title": "Texture"
},
{
"value": "theaters",
"title": "Theaters"
},
{
"value": "thumb_down",
"title": "Thumb Down"
},
{
"value": "thumb_up",
"title": "Thumb Up"
},
{
"value": "thumbs_up_down",
"title": "Thumbs Up Down"
},
{
"value": "time_to_leave",
"title": "Time To Leave"
},
{
"value": "timelapse",
"title": "Timelapse"
},
{
"value": "timeline",
"title": "Timeline"
},
{
"value": "timer",
"title": "Timer"
},
{
"value": "timer_10",
"title": "Timer 10"
},
{
"value": "timer_3",
"title": "Timer 3"
},
{
"value": "timer_off",
"title": "Timer Off"
},
{
"value": "title",
"title": "Title"
},
{
"value": "toc",
"title": "Toc"
},
{
"value": "today",
"title": "Today"
},
{
"value": "toll",
"title": "Toll"
},
{
"value": "tonality",
"title": "Tonality"
},
{
"value": "touch_app",
"title": "Touch App"
},
{
"value": "toys",
"title": "Toys"
},
{
"value": "track_changes",
"title": "Track Changes"
},
{
"value": "traffic",
"title": "Traffic"
},
{
"value": "train",
"title": "Train"
},
{
"value": "tram",
"title": "Tram"
},
{
"value": "transfer_within_a_station",
"title": "Transfer Within A Station"
},
{
"value": "transform",
"title": "Transform"
},
{
"value": "translate",
"title": "Translate"
},
{
"value": "trending_down",
"title": "Trending Down"
},
{
"value": "trending_flat",
"title": "Trending Flat"
},
{
"value": "trending_up",
"title": "Trending Up"
},
{
"value": "tune",
"title": "Tune"
},
{
"value": "turned_in",
"title": "Turned In"
},
{
"value": "turned_in_not",
"title": "Turned In Not"
},
{
"value": "tv",
"title": "Tv"
},
{
"value": "unarchive",
"title": "Unarchive"
},
{
"value": "undo",
"title": "Undo"
},
{
"value": "unfold_less",
"title": "Unfold Less"
},
{
"value": "unfold_more",
"title": "Unfold More"
},
{
"value": "update",
"title": "Update"
},
{
"value": "usb",
"title": "Usb"
},
{
"value": "verified_user",
"title": "Verified User"
},
{
"value": "vertical_align_bottom",
"title": "Vertical Align Bottom"
},
{
"value": "vertical_align_center",
"title": "Vertical Align Center"
},
{
"value": "vertical_align_top",
"title": "Vertical Align Top"
},
{
"value": "vibration",
"title": "Vibration"
},
{
"value": "video_call",
"title": "Video Call"
},
{
"value": "video_label",
"title": "Video Label"
},
{
"value": "video_library",
"title": "Video Library"
},
{
"value": "videocam",
"title": "Videocam"
},
{
"value": "videocam_off",
"title": "Videocam Off"
},
{
"value": "videogame_asset",
"title": "Videogame Asset"
},
{
"value": "view_agenda",
"title": "View Agenda"
},
{
"value": "view_array",
"title": "View Array"
},
{
"value": "view_carousel",
"title": "View Carousel"
},
{
"value": "view_column",
"title": "View Column"
},
{
"value": "view_comfy",
"title": "View Comfy"
},
{
"value": "view_compact",
"title": "View Compact"
},
{
"value": "view_day",
"title": "View Day"
},
{
"value": "view_headline",
"title": "View Headline"
},
{
"value": "view_list",
"title": "View List"
},
{
"value": "view_module",
"title": "View Module"
},
{
"value": "view_quilt",
"title": "View Quilt"
},
{
"value": "view_stream",
"title": "View Stream"
},
{
"value": "view_week",
"title": "View Week"
},
{
"value": "vignette",
"title": "Vignette"
},
{
"value": "visibility",
"title": "Visibility"
},
{
"value": "visibility_off",
"title": "Visibility Off"
},
{
"value": "voice_chat",
"title": "Voice Chat"
},
{
"value": "voicemail",
"title": "Voicemail"
},
{
"value": "volume_down",
"title": "Volume Down"
},
{
"value": "volume_mute",
"title": "Volume Mute"
},
{
"value": "volume_off",
"title": "Volume Off"
},
{
"value": "volume_up",
"title": "Volume Up"
},
{
"value": "vpn_key",
"title": "Vpn Key"
},
{
"value": "vpn_lock",
"title": "Vpn Lock"
},
{
"value": "wallpaper",
"title": "Wallpaper"
},
{
"value": "warning",
"title": "Warning"
},
{
"value": "watch",
"title": "Watch"
},
{
"value": "watch_later",
"title": "Watch Later"
},
{
"value": "wb_auto",
"title": "Wb Auto"
},
{
"value": "wb_cloudy",
"title": "Wb Cloudy"
},
{
"value": "wb_incandescent",
"title": "Wb Incandescent"
},
{
"value": "wb_iridescent",
"title": "Wb Iridescent"
},
{
"value": "wb_sunny",
"title": "Wb Sunny"
},
{
"value": "wc",
"title": "Wc"
},
{
"value": "web",
"title": "Web"
},
{
"value": "web_asset",
"title": "Web Asset"
},
{
"value": "weekend",
"title": "Weekend"
},
{
"value": "whatshot",
"title": "Whatshot"
},
{
"value": "widgets",
"title": "Widgets"
},
{
"value": "wifi",
"title": "Wifi"
},
{
"value": "wifi_lock",
"title": "Wifi Lock"
},
{
"value": "wifi_tethering",
"title": "Wifi Tethering"
},
{
"value": "work",
"title": "Work"
},
{
"value": "wrap_text",
"title": "Wrap Text"
},
{
"value": "youtube_searched_for",
"title": "Youtube Searched For"
},
{
"value": "zoom_in",
"title": "Zoom In"
},
{
"value": "zoom_out",
"title": "Zoom Out"
}
]
}
}
},
"type": "array",
"description": "A list of custom features to display for the corresponding feature areas.",
"title": "Custom Features"
},
"description": {
"type": "string",
"description": "Description of the interface.",
"title": "Description"
},
"phone": {
"default": "true",
"type": "boolean",
"description": "Turn Phones feature on/off.",
"title": "Phones"
},
"call_pickup_group": {
"default": "true",
"type": "boolean",
"description": "Turn Call Pickup Groups feature on/off.",
"title": "Call Pickup Groups"
},
"number_management_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"line_fdp": {
"default": "BusinessAdminLineFDP",
"type": "string",
"title": "Line Display Policy"
},
"title": {
"default": "Number Management",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Number Management"
},
"site_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Site Management",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Site Management"
},
"name": {
"required": true,
"type": "string",
"description": "Name of the Business Admin Portal Interface instance, it is unique per hierarchy.",
"title": "Name"
},
"hunt_group": {
"default": "true",
"type": "boolean",
"description": "Turn Hunt Groups feature on/off.",
"title": "Hunt Groups"
},
"voicemail": {
"default": "true",
"type": "boolean",
"description": "Turn Voicemail feature on/off.",
"title": "Voicemail"
},
"misc_config": {
"type": "object",
"properties": {
"transaction_log_actions": {
"items": {
"type": "string",
"choices": [
{
"value": "cancel",
"title": "Cancel"
},
{
"value": "export_tree",
"title": "Export"
},
{
"value": "replay",
"title": "Replay"
},
{
"value": "edit_replay",
"title": "Edit and Replay"
}
]
},
"type": "array",
"description": "This list controls the transaction log actions available to a user with this profile.",
"title": "Transaction Log Actions"
},
"allow_about": {
"type": "boolean",
"description": "This flag controls whether a user with this profile will see the About (system version) information in their setting dropdown menu in the top bar.",
"title": "Display About Information"
},
"transaction_log_display_policy": {
"items": {
"type": "string",
"choices": [
{
"value": "Priority",
"title": "Priority"
},
{
"value": "Started Time",
"title": "Started Time"
},
{
"value": "Completed Time",
"title": "Completed Time"
},
{
"value": "Submitted on Node",
"title": "Submitted on Node"
},
{
"value": "Processed on Node",
"title": "Processed on Node"
},
{
"value": "Sub Transactions",
"title": "Sub Transactions"
},
{
"value": "Logs",
"title": "Logs"
}
]
},
"type": "array",
"description": "This list controls the fields that are visible to a user with this profile.",
"title": "Transaction Log Display Fields"
},
"allow_export": {
"type": "boolean",
"description": "This flag controls whether a user with this profile is allowed to export data as JSON or Excel files from the system.",
"title": "Allow Data Export"
}
},
"title": "Miscellaneous"
},
"enabled": {
"default": "true",
"type": "boolean",
"description": "Toggle access to the Business Admin portal.",
"title": "Enable Business Admin"
},
"dashboard_config": {
"type": "object",
"properties": {
"landing_page": {
"description": "Landing page to use for Quick Actions links and Quick Searches",
"format": "uri",
"title": "Landing Page",
"required": false,
"choices": [],
"target_attr": "name",
"target_model_type": "data/LandingPage",
"type": "string",
"target": "/api/data/LandingPage/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"title": {
"default": "Business Administration",
"required": true,
"type": "string",
"title": "Dashboard title"
}
},
"title": "Dashboard"
},
"voicemail_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"voicemail_fdp": {
"default": "BusinessAdminVoicemailFDP",
"type": "string",
"title": "Voicemail Display Policy"
},
"title": {
"default": "Voicemail",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Voicemail"
},
"call_pickup_group_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"call_pickup_group_fdp": {
"default": "BusinessAdminCallPickupGroupFDP",
"type": "string",
"title": "Call Pickup Group Display Policy"
},
"title": {
"default": "Call Pickup Groups",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Call Pickup Groups"
},
"hunt_group_config": {
"type": "object",
"properties": {
"features": {
"items": {
"type": "string",
"choices": [
{
"value": "",
"title": ""
}
]
},
"type": "array",
"title": "Allowed Features"
},
"hunt_group_fdp": {
"default": "BusinessAdminHuntGroupFDP",
"type": "string",
"title": "Hunt Group Display Policy"
},
"title": {
"default": "Hunt Groups",
"required": true,
"type": "string",
"title": "Feature title"
}
},
"title": "Hunt Groups"
}
},
"schema_version": "2.1.0"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/InterfaceBusinessAdminPortal/add/ |
|
The GUI Add form of data/InterfaceBusinessAdminPortal 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/InterfaceBusinessAdminPortal/ | 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/InterfaceBusinessAdminPortal/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/InterfaceBusinessAdminPortal/[pkid1]", "/api/data/InterfaceBusinessAdminPortal/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Bulk Modify | GET | /api/data/InterfaceBusinessAdminPortal/bulk_update/?schema=&schema_rules=true |
|
|
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Bulk Modify | POST | /api/data/InterfaceBusinessAdminPortal/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/InterfaceBusinessAdminPortal/[pkid1]", "/api/v0/data/InterfaceBusinessAdminPortal/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move the instance with [pkid] to [target_hierarchy] | POST | /api/tool/DataMove/?model_type=data/InterfaceBusinessAdminPortal |
|
{"hrefs": ["/api/data/InterfaceBusinessAdminPortal/[pkid]"]} |
| Bulk Move | POST | /api/tool/DataMove/?model_type=data/InterfaceBusinessAdminPortal |
|
{"hrefs": ["/api/data/InterfaceBusinessAdminPortal/[pkid1]", "/api/data/InterfaceBusinessAdminPortal/[pkid2]",...]} |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/InterfaceBusinessAdminPortal; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/InterfaceBusinessAdminPortal/export/ |
|
{ "hrefs":["/api/data/InterfaceBusinessAdminPortal/[pkid1]", "/api/data/InterfaceBusinessAdminPortal/[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/InterfaceBusinessAdminPortal and the JSON format can be used to import instances of data/InterfaceBusinessAdminPortal.
GET http://[host-proxy]/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/InterfaceBusinessAdminPortal | POST | /api/data/InterfaceBusinessAdminPortal/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/InterfaceBusinessAdminPortal/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/data/InterfaceBusinessAdminPortal/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Migration Template | GET | /api/data/InterfaceBusinessAdminPortal/migration/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/InterfaceBusinessAdminPortal/ |
|
The data/InterfaceBusinessAdminPortal schema and all instances as JSON. |
(The list will return 0 to 3 data/InterfaceBusinessAdminPortal 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/InterfaceBusinessAdminPortal/?skip=0&limit=3&order_by=name&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 4
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.1.0",
"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/InterfaceBusinessAdminPortal/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"bulk_update_form": {
"support_async": false,
"class": "update",
"href": "/api/data/InterfaceBusinessAdminPortal/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Bulk Modify"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=data/InterfaceBusinessAdminPortal",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/InterfaceBusinessAdminPortal/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/InterfaceBusinessAdminPortal/export_bulkload_template/?hierarchy=[hierarchy]",
"method": "POST",
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/data/InterfaceBusinessAdminPortal/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/data/InterfaceBusinessAdminPortal/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"migration": {
"support_async": false,
"class": "migration",
"href": "/api/data/InterfaceBusinessAdminPortal/migration/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Migration Template"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/InterfaceBusinessAdminPortal/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
},
{
"transform": {
"support_async": false,
"class": "transform",
"href": "/api/data/InterfaceBusinessAdminPortal/transform/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Transform Template"
}
}
],
"model_type": "data/InterfaceBusinessAdminPortal",
"model_specific_actions": [
"add",
"bulk_update_form",
"clone",
"configuration_template",
"export",
"export_bulkload_template",
"field_display_policy",
"get",
"help",
"list",
"migration",
"transform",
"remove",
"tag",
"tag_version",
"update",
"move"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enable Business Admin"
},
{
"name": "site",
"title": "Site Management"
},
{
"name": "number_management",
"title": "Number Management"
},
{
"name": "subscriber",
"title": "Subscribers"
},
{
"name": "phone",
"title": "Phones"
},
{
"name": "voicemail",
"title": "Voicemail"
},
{
"name": "webex_teams",
"title": "Webex Teams"
},
{
"name": "contact_center",
"title": "Contact Center Express"
},
{
"name": "hunt_group",
"title": "Hunt Groups"
},
{
"name": "call_pickup_group",
"title": "Call Pickup Groups"
},
{
"name": "tools",
"title": "Tools"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"resources": [
{
"pkid": "5e8373fece894e00152519f6",
"meta": {
"tags": [
"bap",
"V4UC",
"ba_CommonOverlay"
],
"cached": true,
"title": "default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.1.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8373fece894e00152519f6",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"version_tag": "0.1.0",
"model_type": "data/InterfaceBusinessAdminPortal",
"path": [
"6t0ggef2c0deab00hb595101",
"5e8373fece894e00152519f6"
],
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/clone/?schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8373fece894e00152519f6/?model_type=data/InterfaceBusinessAdminPortal",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/help",
"method": "GET",
"title": "Help"
}
}
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enable Business Admin"
},
{
"name": "site",
"title": "Site Management"
},
{
"name": "number_management",
"title": "Number Management"
},
{
"name": "subscriber",
"title": "Subscribers"
},
{
"name": "phone",
"title": "Phones"
},
{
"name": "voicemail",
"title": "Voicemail"
},
{
"name": "webex_teams",
"title": "Webex Teams"
},
{
"name": "contact_center",
"title": "Contact Center Express"
},
{
"name": "hunt_group",
"title": "Hunt Groups"
},
{
"name": "call_pickup_group",
"title": "Call Pickup Groups"
},
{
"name": "tools",
"title": "Tools"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": [
{
"pkid": "5e8373fece894e00152519f8",
"version": "0.1.0",
"href": "/api/v0/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/?cached=5e8373fece894e00152519f8"
}
]
},
"data": {
"contact_center": true,
"number_management": true,
"site": false,
"webex_teams_config": {
"webex_teams_user_fdp": "BusinessAdminWebexTeamsUserFDP",
"features": [
"License Usage",
"User Count",
"View Users"
],
"title": "Webex Teams"
},
"hierarchy_friendly_name": "sys (System)",
"tools": false,
"webex_teams": true,
"hierarchy_path": "sys",
"tools_config": {
"title": "Tools"
},
"phone_config": {
"phone_fdp": "BusinessAdminPhoneFDP",
"features": [
"Phone Count",
"View Phones"
],
"title": "Phones"
},
"contact_center_config": {
"team_fdp": "BusinessAdminUccxTeamFDP",
"agent_fdp": "BusinessAdminUccxAgentFDP",
"csq_fdp": "BusinessAdminUccxContactServiceQueueFDP",
"features": [
"Agent Count",
"Agent Stats",
"Contact Service Queue Count",
"Resource Group Count",
"Team Count",
"View Agent Profiles",
"View Agents",
"View Contact Service Queues",
"View Resource Groups",
"View Skills",
"View Teams"
],
"title": "Contact Center Express"
},
"subscriber_config": {
"features": [
"Subscriber Count",
"Phone Count",
"Subscriber Search",
"Extension Mobility Count",
"View Subscribers",
"Voicemail Count",
"Directory Synced User Count",
"Local User Count",
"Webex Teams User Count",
"View Subscriber Profiles"
],
"title": "Subscribers"
},
"subscriber": true,
"misc_config": {
"transaction_log_actions": [
"cancel",
"export_tree",
"replay",
"edit_replay"
],
"allow_about": true,
"transaction_log_display_policy": [
"Priority",
"Started Time",
"Completed Time",
"Submitted on Node",
"Processed on Node",
"Sub Transactions",
"Logs"
],
"allow_export": true
},
"description": "Default System-level Business Admin Portal profile. This profile will be used for all admin users unless overriden at a lower hierarchy level or the user has a specific profiles associated with their role.",
"pkid": "5e8373fece894e00152519f7",
"phone": true,
"call_pickup_group": true,
"number_management_config": {
"line_fdp": "BusinessAdminLineFDP",
"features": [
"Internal Inventory Count",
"Available Internal Inventory Count",
"Line Count",
"External Inventory Count",
"View Internal Inventory",
"View Lines",
"View External Inventory"
],
"title": "Number Inventory"
},
"hunt_group_config": {
"features": [
"Hunt Group Count",
"Hunt Pilot Count",
"View Hunt Groups"
],
"hunt_group_fdp": "BusinessAdminHuntGroupFDP",
"title": "Hunt Groups"
},
"name": "default",
"hunt_group": true,
"voicemail": true,
"enabled": true,
"dashboard_config": {
"landing_page": "",
"features": [
"User Count",
"Phone Count",
"Usage Growth Chart"
],
"title": "Business Administration"
},
"voicemail_config": {
"voicemail_fdp": "BusinessAdminVoicemailFDP",
"features": [
"View Voicemail Boxes",
"Voicemail Box Count"
],
"title": "Voicemail"
},
"call_pickup_group_config": {
"call_pickup_group_fdp": "BusinessAdminCallPickupGroupFDP",
"features": [
"Call Pickup Group Count",
"View Call Pickup Groups"
],
"title": "Call Pickup Groups"
},
"site_config": {
"title": "Site Management"
}
}
},
{
"pkid": "5e8a8c7dce894e001674b4cc",
"meta": {
"tags": [],
"cached": true,
"title": "Disabled",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.1.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e8a8c7dce894e001674b4cc",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/",
"title": "Modify",
"class": "update",
"method": "PUT"
}
},
{
"remove": {
"support_async": true,
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/",
"title": "Delete",
"class": "delete",
"method": "DELETE"
}
},
{
"clone": {
"support_async": false,
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/clone/?schema=&schema_rules=true",
"title": "Clone",
"class": "clone",
"method": "GET"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8a8c7dce894e001674b4cc/?model_type=data/InterfaceBusinessAdminPortal",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/",
"title": "Get",
"class": "get",
"method": "GET"
}
},
{
"help": {
"support_async": false,
"href": "/api/data/InterfaceBusinessAdminPortal/5e8a8c7dce894e001674b4cc/help",
"title": "Help",
"class": "help",
"method": "GET"
}
}
],
"model_type": "data/InterfaceBusinessAdminPortal",
"path": [
"6t0ggef2c0deab00hb595101",
"5e8a8c7dce894e001674b4cc"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enable Business Admin"
},
{
"name": "site",
"title": "Site Management"
},
{
"name": "number_management",
"title": "Number Management"
},
{
"name": "subscriber",
"title": "Subscribers"
},
{
"name": "phone",
"title": "Phones"
},
{
"name": "voicemail",
"title": "Voicemail"
},
{
"name": "webex_teams",
"title": "Webex Teams"
},
{
"name": "contact_center",
"title": "Contact Center Express"
},
{
"name": "hunt_group",
"title": "Hunt Groups"
},
{
"name": "call_pickup_group",
"title": "Call Pickup Groups"
},
{
"name": "tools",
"title": "Tools"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"contact_center": true,
"number_management": true,
"site": true,
"webex_teams_config": {
"webex_teams_user_fdp": "BusinessAdminWebexTeamsUserFDP",
"title": "Webex Teams"
},
"hierarchy_friendly_name": "sys (System)",
"tools": true,
"webex_teams": true,
"hierarchy_path": "sys",
"phone_config": {
"phone_fdp": "BusinessAdminPhoneFDP",
"title": "Phones"
},
"contact_center_config": {
"team_fdp": "BusinessAdminUccxTeamFDP",
"agent_fdp": "BusinessAdminUccxAgentFDP",
"csq_fdp": "BusinessAdminUccxContactServiceQueueFDP",
"title": "Contact Center Express"
},
"subscriber_config": {
"title": "Subscribers"
},
"subscriber": true,
"pkid": "5e8a8c7dce894e001674b4cd",
"phone": true,
"call_pickup_group": true,
"voicemail_config": {
"voicemail_fdp": "BusinessAdminVoicemailFDP",
"title": "Voicemail"
},
"site_config": {
"title": "Site Management"
},
"name": "Disabled",
"hunt_group": true,
"voicemail": true,
"enabled": false,
"dashboard_config": {
"title": "Business Administration"
},
"number_management_config": {
"line_fdp": "BusinessAdminLineFDP",
"title": "Number Management"
},
"call_pickup_group_config": {
"call_pickup_group_fdp": "BusinessAdminCallPickupGroupFDP",
"title": "Call Pickup Groups"
},
"hunt_group_config": {
"hunt_group_fdp": "BusinessAdminHuntGroupFDP",
"title": "Hunt Groups"
}
}
},
{
"pkid": "5e839e49ce894e0015b9d3f4",
"meta": {
"tags": [
"bap",
"V4UC",
"ba_CommonOverlay"
],
"cached": true,
"title": "Full Access",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.1.0",
"summary": "false",
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"pkid": "5e839e49ce894e0015b9d3f4",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/"
}
],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"update": {
"support_async": true,
"method": "PUT",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/",
"class": "update",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"method": "DELETE",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/",
"class": "delete",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"method": "GET",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/clone/?schema=&schema_rules=true",
"class": "clone",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e839e49ce894e0015b9d3f4/?model_type=data/InterfaceBusinessAdminPortal",
"method": "POST",
"view": "/api/tool/DataMove/"
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/export/",
"method": "GET",
"view": "/api/view/ExportData/add/"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/+tag/",
"class": "tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/+tag_version/",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/"
}
},
{
"get": {
"support_async": false,
"method": "GET",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/",
"class": "get",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"method": "GET",
"href": "/api/data/InterfaceBusinessAdminPortal/5e839e49ce894e0015b9d3f4/help",
"class": "help",
"title": "Help"
}
}
],
"model_type": "data/InterfaceBusinessAdminPortal",
"path": [
"6t0ggef2c0deab00hb595101",
"5e839e49ce894e0015b9d3f4"
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enable Business Admin"
},
{
"name": "site",
"title": "Site Management"
},
{
"name": "number_management",
"title": "Number Management"
},
{
"name": "subscriber",
"title": "Subscribers"
},
{
"name": "phone",
"title": "Phones"
},
{
"name": "voicemail",
"title": "Voicemail"
},
{
"name": "webex_teams",
"title": "Webex Teams"
},
{
"name": "contact_center",
"title": "Contact Center Express"
},
{
"name": "hunt_group",
"title": "Hunt Groups"
},
{
"name": "call_pickup_group",
"title": "Call Pickup Groups"
},
{
"name": "tools",
"title": "Tools"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": []
},
"data": {
"contact_center": true,
"number_management": true,
"site": true,
"webex_teams_config": {
"webex_teams_user_fdp": "BusinessAdminWebexTeamsUserFDP",
"features": [
"Delete User",
"License Usage",
"Sync Licenses",
"Sync Users",
"Update User",
"User Count",
"View Users",
"Add User"
],
"title": "Webex Teams"
},
"hierarchy_friendly_name": "sys (System)",
"tools": true,
"webex_teams": true,
"hierarchy_path": "sys",
"tools_config": {
"features": [
"Bulk Load",
"Themes"
],
"title": "Tools"
},
"phone_config": {
"phone_fdp": "BusinessAdminPhoneFDP",
"features": [
"Phone Count",
"Login User",
"Logout User",
"Replace Phone",
"Reset Phone",
"Restart Phone",
"Update Phone",
"View Phones",
"Add Phone",
"Delete Phone"
],
"title": "Phones"
},
"contact_center_config": {
"team_fdp": "BusinessAdminUccxTeamFDP",
"agent_fdp": "BusinessAdminUccxAgentFDP",
"csq_fdp": "BusinessAdminUccxContactServiceQueueFDP",
"features": [
"Add Agent",
"Add Contact Service Queue",
"Add Resource Group",
"Add Skill",
"Add Team",
"Agent Count",
"Agent Stats",
"Contact Service Queue Count",
"Delete Agent",
"Delete Contact Service Queue",
"Delete Resource Group",
"Delete Skill",
"Delete Team",
"Re-skill Agents",
"Resource Group Count",
"Team Count",
"Update Agent",
"Update Contact Service Queue",
"Update Resource Group",
"Update Skill",
"Update Team",
"View Agent Profiles",
"View Agents",
"View Contact Service Queues",
"View Resource Groups",
"View Skills",
"View Teams"
],
"title": "Contact Center Express"
},
"subscriber_config": {
"features": [
"Login Phone",
"Logout Phones",
"Subscriber Count",
"Phone Count",
"Subscriber Search",
"Extension Mobility Count",
"Move Subscriber",
"Re-assign Services",
"Replace Phone",
"Reset Phone",
"Add Phone",
"Add Jabber",
"Add Extension Mobility Profile",
"Update Subscriber",
"View Subscribers",
"Voicemail Count",
"Delete Subscriber",
"Delete Voicemail",
"Delete Webex Teams",
"Add Subscriber",
"Add Voicemail",
"Add Webex Teams User",
"Delete Single Number Reach",
"Delete Contact Center Express Agent",
"Delete Extension Mobility",
"Delete Phone",
"Add Contact Center Express Agent",
"Add Single Number Reach",
"Update Single Number Reach",
"Directory Synced User Count",
"Local User Count",
"Webex Teams User Count",
"Add Subscriber Profile",
"Delete Subscriber Profile",
"Update Subscriber Profile",
"View Subscriber Profiles",
"Reset Pin / Password",
"Delete All Services",
"Add To Hunt Group",
"Add To Call Pickup Group",
"Remove from all Hunt Groups",
"Remove from all Call Pickup Groups",
"Lock / Unlock Voicemail Account"
],
"title": "Subscribers"
},
"subscriber": true,
"misc_config": {
"transaction_log_actions": [
"cancel",
"export_tree",
"replay",
"edit_replay"
],
"allow_about": true,
"transaction_log_display_policy": [
"Priority",
"Started Time",
"Completed Time",
"Submitted on Node",
"Processed on Node",
"Sub Transactions",
"Logs"
],
"allow_export": true
},
"description": "This profile allows full access to all Business Admin Portal features when applied to a user's role.",
"pkid": "5e839e49ce894e0015b9d3f5",
"phone": true,
"call_pickup_group": true,
"number_management_config": {
"features": [
"Internal Inventory Count",
"Available Internal Inventory Count",
"Line Count",
"Delete External Inventory",
"Delete Internal Inventory",
"Delete Line",
"External Inventory Count",
"View Internal Inventory",
"Add Internal Inventory",
"View Lines",
"Add Line",
"Update Internal Inventory",
"Associate Internal / External Inventory (Many-to-many)",
"Associate Internal / External Inventory (One-to-many)",
"Update Line",
"View External Inventory",
"Add External Inventory"
],
"line_fdp": "BusinessAdminLineFDP",
"title": "Number Inventory"
},
"site_config": {
"features": [
"Site Count",
"Update Site",
"Update Site Defaults",
"View Site Defaults",
"View Sites",
"Add Site",
"Delete Site"
],
"title": "Site Management"
},
"name": "Full Access",
"hunt_group": true,
"voicemail": true,
"enabled": true,
"dashboard_config": {
"landing_page": "",
"features": [
"Login User / Phone",
"Logout Phone",
"Site Count",
"User Count",
"Phone Count",
"Usage Growth Chart"
],
"title": "Business Administration"
},
"voicemail_config": {
"features": [
"View Voicemail Boxes",
"Add Voicemail Box",
"Voicemail Box Count",
"Delete Voicemail Box",
"Update Voicemail Box"
],
"voicemail_fdp": "BusinessAdminVoicemailFDP",
"title": "Voicemail"
},
"call_pickup_group_config": {
"features": [
"Call Pickup Group Count",
"Delete Call Pickup Group",
"Manage Call Pickup Group User Membership",
"Update Call Pickup Group",
"View Call Pickup Groups",
"Add Call Pickup Group"
],
"call_pickup_group_fdp": "BusinessAdminCallPickupGroupFDP",
"title": "Call Pickup Groups"
},
"hunt_group_config": {
"features": [
"Hunt Group Count",
"Hunt Pilot Count",
"Manage Hunt Group User Membership",
"Update Hunt Group",
"View Hunt Groups",
"Add Hunt Group",
"Delete Hunt Group"
],
"hunt_group_fdp": "BusinessAdminHuntGroupFDP",
"title": "Hunt Groups"
}
}
}
]
}
(Show the first instance)
{
"pkid": "5e8373fece894e00152519f6",
"meta": {
"tags": [
"bap",
"V4UC",
"ba_CommonOverlay"
],
"cached": false,
"title": "default",
"business_key": {
"hierarchy": true,
"unique": [
"name"
]
},
"schema_version": "2.1.0",
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"self": [
{
"pkid": "5e8373fece894e00152519f6",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/"
}
],
"foreign_key": [],
"device": [
{
"pkid": "",
"href": ""
}
],
"owner": [
{
"pkid": ""
}
],
"children": []
},
"version_tag": "0.1.0",
"model_type": "data/InterfaceBusinessAdminPortal",
"path": [
"6t0ggef2c0deab00hb595101",
"5e8373fece894e00152519f6"
],
"actions": [
{
"update": {
"support_async": true,
"class": "update",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/?hierarchy=[hierarchy]",
"method": "PUT",
"title": "Modify"
}
},
{
"remove": {
"support_async": true,
"class": "delete",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/?hierarchy=[hierarchy]",
"method": "DELETE",
"title": "Delete"
}
},
{
"clone": {
"support_async": false,
"class": "clone",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"method": "GET",
"title": "Clone"
}
},
{
"move": {
"title": "Move",
"support_async": true,
"class": "move",
"href": "/api/tool/DataMove/5e8373fece894e00152519f6/?hierarchy=[hierarchy]&model_type=data/InterfaceBusinessAdminPortal",
"method": "POST",
"view": "/api/tool/DataMove/?auth_token=[authtoken]
}
},
{
"export": {
"title": "Export",
"support_async": false,
"submit": "payload",
"class": "export",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/export/?hierarchy=[hierarchy]",
"method": "GET",
"view": "/api/view/ExportData/add/?auth_token=[authtoken]
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"tag_version": {
"title": "Tag Version",
"support_async": true,
"method": "PATCH",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/+tag_version/?hierarchy=[hierarchy]",
"class": "tag_version",
"view": "/api/view/TagVersionForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"support_async": false,
"class": "get",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Get"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"summary_attrs": [
{
"name": "name",
"title": "Name"
},
{
"name": "description",
"title": "Description"
},
{
"name": "enabled",
"title": "Enable Business Admin"
},
{
"name": "site",
"title": "Site Management"
},
{
"name": "number_management",
"title": "Number Management"
},
{
"name": "subscriber",
"title": "Subscribers"
},
{
"name": "phone",
"title": "Phones"
},
{
"name": "voicemail",
"title": "Voicemail"
},
{
"name": "webex_teams",
"title": "Webex Teams"
},
{
"name": "contact_center",
"title": "Contact Center Express"
},
{
"name": "hunt_group",
"title": "Hunt Groups"
},
{
"name": "call_pickup_group",
"title": "Call Pickup Groups"
},
{
"name": "tools",
"title": "Tools"
},
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "20.1.1",
"tagged_versions": [
{
"pkid": "5e8373fece894e00152519f8",
"version": "0.1.0",
"href": "/api/v0/data/InterfaceBusinessAdminPortal/5e8373fece894e00152519f6/?cached=5e8373fece894e00152519f8"
}
]
},
"data": {
"contact_center": true,
"number_management": true,
"site": false,
"webex_teams_config": {
"title": "Webex Teams",
"features": [
"License Usage",
"User Count",
"View Users"
],
"webex_teams_user_fdp": "BusinessAdminWebexTeamsUserFDP"
},
"tools": false,
"webex_teams": true,
"tools_config": {
"title": "Tools"
},
"phone_config": {
"phone_fdp": "BusinessAdminPhoneFDP",
"features": [
"Phone Count",
"View Phones"
],
"title": "Phones"
},
"dashboard_config": {
"landing_page": "",
"features": [
"User Count",
"Phone Count",
"Usage Growth Chart"
],
"title": "Business Administration"
},
"contact_center_config": {
"team_fdp": "BusinessAdminUccxTeamFDP",
"agent_fdp": "BusinessAdminUccxAgentFDP",
"csq_fdp": "BusinessAdminUccxContactServiceQueueFDP",
"features": [
"Agent Count",
"Agent Stats",
"Contact Service Queue Count",
"Resource Group Count",
"Team Count",
"View Agent Profiles",
"View Agents",
"View Contact Service Queues",
"View Resource Groups",
"View Skills",
"View Teams"
],
"title": "Contact Center Express"
},
"subscriber_config": {
"features": [
"Subscriber Count",
"Phone Count",
"Subscriber Search",
"Extension Mobility Count",
"View Subscribers",
"Voicemail Count",
"Directory Synced User Count",
"Local User Count",
"Webex Teams User Count",
"View Subscriber Profiles"
],
"title": "Subscribers"
},
"subscriber": true,
"misc_config": {
"allow_export": true,
"allow_about": true,
"transaction_log_display_policy": [
"Priority",
"Started Time",
"Completed Time",
"Submitted on Node",
"Processed on Node",
"Sub Transactions",
"Logs"
],
"transaction_log_actions": [
"cancel",
"export_tree",
"replay",
"edit_replay"
]
},
"description": "Default System-level Business Admin Portal profile. This profile will be used for all admin users unless overriden at a lower hierarchy level or the user has a specific profiles associated with their role.",
"phone": true,
"call_pickup_group": true,
"number_management_config": {
"title": "Number Inventory",
"features": [
"Internal Inventory Count",
"Available Internal Inventory Count",
"Line Count",
"External Inventory Count",
"View Internal Inventory",
"View Lines",
"View External Inventory"
],
"line_fdp": "BusinessAdminLineFDP"
},
"site_config": {
"title": "Site Management"
},
"name": "default",
"hunt_group": true,
"voicemail": true,
"enabled": true,
"pkid": "5e8373fece894e00152519f7",
"voicemail_config": {
"title": "Voicemail",
"features": [
"View Voicemail Boxes",
"Voicemail Box Count"
],
"voicemail_fdp": "BusinessAdminVoicemailFDP"
},
"call_pickup_group_config": {
"title": "Call Pickup Groups",
"features": [
"Call Pickup Group Count",
"View Call Pickup Groups"
],
"call_pickup_group_fdp": "BusinessAdminCallPickupGroupFDP"
},
"hunt_group_config": {
"features": [
"Hunt Group Count",
"Hunt Pilot Count",
"View Hunt Groups"
],
"hunt_group_fdp": "BusinessAdminHuntGroupFDP",
"title": "Hunt Groups"
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/InterfaceBusinessAdminPortal. | GET | /api/data/InterfaceBusinessAdminPortal/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/InterfaceBusinessAdminPortal as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/InterfaceBusinessAdminPortal/[pkid]/ | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/InterfaceBusinessAdminPortal/[pkid]/ | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/InterfaceBusinessAdminPortal/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/InterfaceBusinessAdminPortal/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Move | POST | /api/tool/DataMove/[pkid]/?model_type=data/InterfaceBusinessAdminPortal | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and a single instance with [pkid] of data/InterfaceBusinessAdminPortal; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/InterfaceBusinessAdminPortal/[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/InterfaceBusinessAdminPortal and the JSON format can be used to import instances of data/InterfaceBusinessAdminPortal.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/InterfaceBusinessAdminPortal/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/InterfaceBusinessAdminPortal/[pkid]/ | hierarchy=[hierarchy] | The data/InterfaceBusinessAdminPortal instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/InterfaceBusinessAdminPortal/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/InterfaceBusinessAdminPortal. |