[Index]
Landing page displayed to end user
Model ref.: data/LandingPage
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{ "$schema": "http://json-schema.org/draft-03/schema", "type": "object", "properties": { "name": { "title": "Name", "description": "The name that is given to the Landing Page", "type": "string", "required": true }, "description": { "title": "Description", "description": "A description of the Landing Page.", "type": "string", "required": false, "readonly": false }, "welcome": { "title": "Welcome Header", "description": "Text for the welcome section.", "type": "object", "displayable": false, "items": { "attr_props": [ { "name": "header", "title": "Header Text", "type": "string", "required": false, "displayable": true }, { "name": "line", "title": "Line Text", "type": "string", "required": false, "displayable": true } ] }, "properties": { "header": { "title": "Header Text", "description": "A single line static welcome test displayed on top of the landing page.", "type": "string", "required": false, "displayable": true }, "line": { "title": "Line Text", "description": "Text for the welcome line displayed under the header. Use [userrole] as a placeholder to insert the current user's role.", "type": "string", "required": false } } }, "counters": { "title": "Counters", "description": "The list of counters for the Landing Page dashboard", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "is_password": false, "properties": { "title": { "title": "Title", "description": "The title to be displayed for this counter.", "type": "string", "required": true, "displayable": true, "is_password": false }, "icon": { "title": "Icon", "description": "The icon to be used for this counter.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/Icons/choices/?choice_title=icon_name&field=icon_value&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "icon_value", "target_title": "icon_name", "target_model_type": "data/Icons", "choices": [] }, "type": { "title": "Type", "description": "The selected model type from the Type drop-down list to associate with the Title.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "choices": [] }, "field_display_policy": { "title": "Field Display Policy", "description": "The selected Field Display Policy that is associated with the counter.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/FieldDisplayPolicy/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "data/FieldDisplayPolicy", "choices": [] }, "condition": { "title": "Condition", "description": "Only show this counter if this condition evaluates to true.", "type": "string", "required": false, "readonly": false, "displayable": true }, "configuration_template": { "title": "Configuration Template", "description": "The selected Configuration Template that is associated with the counter.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "choices": [] }, "filter_options": { "title": "Hidden Filters", "description": "Filters that can't be removed by end user.", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "properties": { "filter_by": { "title": "Filter By", "type": "string", "required": false, "readonly": false }, "filter_type": { "title": "Filter Type", "type": "string", "required": false, "readonly": false, "choices": [ { "value": "contains", "title": "Contains" }, { "value": "notcontain", "title": "Does Not Contain" }, { "value": "startswith", "title": "Starts With" }, { "value": "endswith", "title": "Ends With" }, { "value": "equals", "title": "Equals" }, { "value": "notequal", "title": "Not Equal" } ] }, "filter_string": { "title": "Filter String", "type": "string", "required": false, "readonly": false }, "ignore_case": { "title": "Ignore Case", "type": "boolean", "required": false, "readonly": false } } } }, "configurable_options": { "title": "Visible Filters", "description": "Filters suggested to end users and my be cleared.", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "properties": { "filter_by": { "title": "Filter By", "type": "string", "required": false, "readonly": false }, "filter_type": { "title": "Filter Type", "type": "string", "required": false, "readonly": false, "choices": [ { "value": "contains", "title": "Contains" }, { "value": "notcontain", "title": "Does Not Contain" }, { "value": "startswith", "title": "Starts With" }, { "value": "endswith", "title": "Ends With" }, { "value": "equals", "title": "Equals" }, { "value": "notequal", "title": "Not Equal" } ] }, "filter_string": { "title": "Filter String", "type": "string", "required": false, "readonly": false }, "ignore_case": { "title": "Ignore Case", "type": "boolean", "required": false, "readonly": false } } } } } } }, "sections": { "title": "Sections", "description": "The list of section items that belong to the Landing Page.", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "is_password": false, "properties": { "title": { "title": "Title", "description": "The section title as it will show on the Landing page.", "type": "string", "required": true, "displayable": true, "is_password": false }, "image": { "title": "Image URL", "description": "Optional URL to image to be displayed as section image.", "type": "string", "required": false, "choices": [ { "value": "www/img/landingPageIcons/Accounting.png", "title": "Accounting" }, { "value": "www/img/landingPageIcons/Arrows.png", "title": "Arrows" }, { "value": "www/img/landingPageIcons/Charting.png", "title": "Charting" }, { "value": "www/img/landingPageIcons/Configuration.png", "title": "Configuration" }, { "value": "www/img/landingPageIcons/Deployment.png", "title": "Deployment" }, { "value": "www/img/landingPageIcons/Detail.png", "title": "Detail" }, { "value": "www/img/landingPageIcons/Feedback.png", "title": "Feedback" }, { "value": "www/img/landingPageIcons/Global.png", "title": "Global" }, { "value": "www/img/landingPageIcons/Like.png", "title": "Like" }, { "value": "www/img/landingPageIcons/Migration.png", "title": "Migration" }, { "value": "www/img/landingPageIcons/Network2.png", "title": "Network2" }, { "value": "www/img/landingPageIcons/Network.png", "title": "Network" }, { "value": "www/img/landingPageIcons/News.png", "title": "News" }, { "value": "www/img/landingPageIcons/Options.png", "title": "Options" }, { "value": "www/img/landingPageIcons/Permissions.png", "title": "Permissions" }, { "value": "www/img/landingPageIcons/Reconciliation.png", "title": "Reconciliation" }, { "value": "www/img/landingPageIcons/Reports.png", "title": "Reports" }, { "value": "www/img/landingPageIcons/Roles.png", "title": "Roles" }, { "value": "www/img/landingPageIcons/Search.png", "title": "Search" }, { "value": "www/img/landingPageIcons/Security.png", "title": "Security" }, { "value": "www/img/landingPageIcons/Settings.png", "title": "Settings" }, { "value": "www/img/landingPageIcons/Terminals.png", "title": "Terminals" }, { "value": "www/img/landingPageIcons/User.png", "title": "User" } ] }, "condition": { "title": "Condition", "description": "Only show this section if this condition evaluates to true.", "type": "string", "required": false, "readonly": false, "displayable": true }, "links": { "title": "Links", "description": "List of links that belong to section.", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "properties": { "icon": { "title": "Icon", "description": "The icon to be used for this link.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/Icons/choices/?field=icon_value&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "icon_value", "target_model_type": "data/Icons", "choices": [] }, "link_text": { "title": "Link Text", "description": "Text for the link", "type": "string", "required": false, "readonly": false, "displayable": true }, "description": { "title": "Description", "description": "A description of the Link.", "type": "string", "required": false, "readonly": false }, "condition": { "title": "Condition", "description": "Only show this link if this condition evaluates to true.", "type": "string", "required": false, "readonly": false, "displayable": true }, "display": { "title": "Display As", "description": "Select the display format of the model types of the menu item. The format can be a Form for a single instance, or a List for more than one instance.", "type": "string", "required": false, "readonly": false, "default": "list", "choices": [ { "value": "form", "title": "Form" }, { "value": "inlinelist", "title": "Inline List" }, { "value": "list", "title": "List" }, { "value": "externalLink", "title": "External Link" } ] }, "type": { "title": "Type", "description": "The selected model type from the Type drop-down list to associate with the Title.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "choices": [] }, "href": { "title": "Href", "description": "If a direct reference to a model type is used for the menu item, the specified path.", "type": "string", "required": false, "readonly": false }, "field_display_policy": { "title": "Field Display Policy", "description": "The selected Field Display Policy that is associated with the Menu Item.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/FieldDisplayPolicy/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "data/FieldDisplayPolicy", "choices": [] }, "configuration_template": { "title": "Configuration Template", "description": "The selected Configuration Template that is associated with the Menu Item.", "type": "string", "format": "uri", "required": false, "readonly": false, "target": "/api/data/ConfigurationTemplate/template_choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], "target_attr": "name", "target_model_type": "data/ConfigurationTemplate", "choices": [] }, "default_model_type": { "title": "Set as default Model Type", "description": "Use this menu entry configuration as the default for this model type. The selected Field Display Policy and Configuration Template will be used for the corresponding model in cases like search, when not navigating from a menu or landing page.", "type": "boolean", "required": false, "readonly": false }, "filter_options": { "title": "Fixed Filters", "description": "Filters that can't be removed by end user. Applicable to display as = 'list'", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "properties": { "filter_by": { "title": "Filter By", "type": "string", "required": false, "readonly": false }, "filter_type": { "title": "Filter Type", "type": "string", "required": false, "readonly": false, "choices": [ { "value": "contains", "title": "Contains" }, { "value": "notcontain", "title": "Does Not Contain" }, { "value": "startswith", "title": "Starts With" }, { "value": "endswith", "title": "Ends With" }, { "value": "equals", "title": "Equals" }, { "value": "notequal", "title": "Not Equal" } ] }, "filter_string": { "title": "Filter String", "type": "string", "required": false, "readonly": false }, "ignore_case": { "title": "Ignore Case", "type": "boolean", "required": false, "readonly": false } } } }, "configurable_options": { "title": "Configurable Filters", "description": "Filters suggested to end users and my be cleared. Applicable to display as = 'list'", "type": "array", "required": false, "readonly": false, "items": { "type": "object", "properties": { "filter_by": { "title": "Filter By", "type": "string", "required": false, "readonly": false }, "filter_type": { "title": "Filter Type", "type": "string", "required": false, "readonly": false, "choices": [ { "value": "contains", "title": "Contains" }, { "value": "notcontain", "title": "Does Not Contain" }, { "value": "startswith", "title": "Starts With" }, { "value": "endswith", "title": "Ends With" }, { "value": "equals", "title": "Equals" }, { "value": "notequal", "title": "Not Equal" } ] }, "filter_string": { "title": "Filter String", "type": "string", "required": false, "readonly": false }, "ignore_case": { "title": "Ignore Case", "type": "boolean", "required": false, "readonly": false } } } } } } } } } }, "widgets": { "title": "Widgets", "type": "array", "items": { "type": "string", "choices": [ { "value": "Headset Summary By Model", "title": "Headset Summary By Model" }, { "value": "Number Inventory Chart", "title": "Number Inventory Chart" }, { "value": "UCCX Agent Stats Chart", "title": "UCCX Agent Stats Chart" }, { "value": "Usage Growth Chart", "title": "Usage Growth Chart" }, { "value": "Webex Teams License Chart", "title": "Webex Teams License Chart" } ] } } }, "schema_version": "0.7.0" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the GUI Add form. | GET | /api/data/LandingPage/add/ |
|
The GUI Add form of data/LandingPage 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/LandingPage | 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/LandingPage/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/LandingPage/[pkid1]", "/api/data/LandingPage/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/LandingPage/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Bulk Modify | GET | /api/data/LandingPage/bulk_update/?schema=&schema_rules=true |
|
|
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Bulk Modify | POST | /api/data/LandingPage/bulk_update/ |
|
For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/data/LandingPage/[pkid1]", "/api/v0/data/LandingPage/[pkid2]",...]}} |
GET http://[host-proxy]/api/data/LandingPage/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/LandingPage; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/LandingPage/export/ |
|
{ "hrefs":["/api/data/LandingPage/[pkid1]", "/api/data/LandingPage/[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/LandingPage and the JSON format can be used to import instances of data/LandingPage.
GET http://[host-proxy]/api/data/LandingPage/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a compressed format of the Bulk Load spreadsheet template for data/LandingPage | POST | /api/data/LandingPage/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag | PATCH | /api/data/LandingPage/+tag/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Tag Version | PATCH | /api/data/LandingPage/+tag_version/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Configuration Template | GET | /api/data/LandingPage/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Field Display Policy | GET | /api/data/LandingPage/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Migration Template | GET | /api/data/LandingPage/migration/ |
|
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
List | GET | /api/data/LandingPage/ |
|
The data/LandingPage schema and all instances as JSON. |
(The list will return 0 to 3 data/LandingPage instances)
{ "pagination": { "skip": 0, "limit": 3, "maximum_limit": 2000, "total": 88, "total_limit": null, "order_by": "name", "direction": "asc", "current": "/api/data/LandingPage/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree" }, "operations": [ "field_display_policy", "update", "help", "remove", "add", "export", "list", "configuration_template", "get", "bulk_update_form", "migration", "transform", "export_bulkload_template" ], "meta": { "model_type": "data/LandingPage", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [], "title": "", "business_key": { "unique": [ "name" ], "hierarchy": true }, "api_version": "21.2", "cached": true, "references": { "children": [], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "device": [ { "href": "", "pkid": "" } ], "foreign_key": [] }, "model_specific_actions": [ "add", "bulk_update_form", "clone", "configuration_template", "export", "export_bulkload_template", "field_display_policy", "get", "help", "list", "migration", "remove", "tag", "tag_version", "update" ], "schema_version": "0.7.0", "actions": [ { "add": { "method": "GET", "class": "add", "href": "/api/data/LandingPage/add/?hierarchy=[hierarchy]", "support_async": false, "title": "Add" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/LandingPage/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "bulk_update_form": { "method": "GET", "class": "update", "href": "/api/data/LandingPage/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Bulk Modify" } }, { "export": { "method": "POST", "class": "export", "href": "/api/data/LandingPage/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "export_bulkload_template": { "method": "POST", "class": "bulkload_template", "href": "/api/data/LandingPage/export_bulkload_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Export Bulk Load Template" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/LandingPage/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/LandingPage/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "configuration_template": { "method": "GET", "class": "config", "href": "/api/data/LandingPage/configuration_template/?hierarchy=[hierarchy]", "support_async": false, "title": "Configuration Template" } }, { "field_display_policy": { "method": "GET", "class": "display_policy", "href": "/api/data/LandingPage/field_display_policy/?hierarchy=[hierarchy]", "support_async": false, "title": "Field Display Policy" } }, { "migration": { "method": "GET", "class": "migration", "href": "/api/data/LandingPage/migration/?hierarchy=[hierarchy]", "support_async": false, "title": "Migration Template" } }, { "list": { "method": "GET", "class": "list", "href": "/api/data/LandingPage/?hierarchy=[hierarchy]", "support_async": false, "title": "List" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/LandingPage/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "resources": [ { "data": { "name": "admin_page", "sections": [ { "image": "www/img/landingPageIcons/Global.png", "links": [ { "link_text": "Manage Subscribers", "type": "device/cucm/User", "display": "list" }, { "link_text": "Manage Users", "type": "data/User", "display": "list" } ], "title": "Site Management" }, { "image": "www/img/landingPageIcons/Migration.png", "links": [ { "link_text": "Manage Partitions", "type": "device/cuc/Partition", "display": "list" }, { "link_text": "Manage Calling Search Spaces", "type": "device/cucm/Css", "display": "list" } ], "title": "DialPlan Management" }, { "image": "www/img/landingPageIcons/Network.png", "links": [ { "link_text": "Manage Cisco Call Managers", "type": "data/CallManager", "display": "list" }, { "link_text": "Manage Cisco Unity Connection", "type": "data/UnityConnection", "display": "list" } ], "title": "Network Management" } ], "pkid": "5abb946faffa931ce72a747d", "hierarchy_friendly_name": "sys (System)", "hierarchy_path": "sys" }, "meta": { "model_type": "data/LandingPage", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "base", "core" ], "title": "admin_page", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "6t0ggef2c0deab00hb595101", "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101" } ], "foreign_key": [], "self": [ { "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/", "pkid": "5abb946faffa931ce72a747c" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5abb946faffa931ce72a747c" ], "system_resource": true, "schema_version": "0.7.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "5abb946faffa931ce72a747c" }, { "data": { "pkid": "650fe55e84eaf2a1ce63b2d7", "sections": [ { "links": [ { "field_display_policy": "BusinessAdminHuntGroupFDP", "description": "View any existing Cisco Hunt Pilots, Hunt Lists or Line Groups displayed as connected Hunt Groups", "link_text": "View Hunt Groups", "type": "relation/HuntGroupRelation", "display": "list", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "group_work" }, { "field_display_policy": "BusinessAdminCallPickupGroupFDP", "description": "View any existing Cisco Call Pickup Groups", "link_text": "View Call Pickup Groups", "type": "relation/CallPickupGroups", "display": "list", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "contact_phone" }, { "field_display_policy": "BusinessAdminHuntGroupFDP", "description": "Add a Cisco Hunt Pilot / Hunt Lists / Line Group combination to form a Hunt Group", "link_text": "Add Hunt Group", "type": "relation/HuntGroupRelation", "display": "form", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "add" }, { "field_display_policy": "BusinessAdminCallPickupGroupFDP", "description": "Add a Cisco Call Pickup Group", "link_text": "Add Call Pickup Group", "type": "relation/CallPickupGroups", "display": "form", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "add_box" }, { "description": "View any existing Microsoft Auto Attendants", "link_text": "View MS Auto Attendants", "type": "device/msteamsonline/CsAutoAttendant", "display": "list", "condition": "{{ macro.is_microsoft_enabled }}", "icon": "call_split" }, { "description": "View any existing Microsoft Call Queues", "link_text": "View Call Queues", "type": "device/msteamsonline/CsCallQueue", "display": "list", "condition": "{{ macro.is_microsoft_enabled }}", "icon": "call" }, { "description": "Add a Microsoft Auto Attendant", "link_text": "Add MS Auto Attendant", "type": "device/msteamsonline/CsAutoAttendant", "display": "form", "condition": "{{ macro.is_microsoft_enabled }}", "icon": "add_circle_outline" }, { "description": "Add a Microsoft Call Queue", "link_text": "Add Call Queue", "type": "device/msteamsonline/CsCallQueue", "display": "form", "condition": "{{ macro.is_microsoft_enabled }}", "icon": "add_circle" }, { "description": "Cisco Auto Attendant", "link_text": "View Cisco Auto Attendant", "filter_options": [ { "filter_string": "false", "filter_type": "equals", "filter_by": "IsPrimary" } ], "type": "relation/CallhandlerREL", "display": "list", "condition": "{{ macro.is_cisco_cucx_enabled }}", "icon": "call_split" }, { "description": "View Recorded Audio Files for Greetings and Prompts", "link_text": "View Files", "type": "data/File", "display": "list", "icon": "folder_open" }, { "description": "Add Cisco Auto Attendant", "link_text": "Add Cisco Auto Attendant", "type": "relation/CallhandlerREL", "display": "form", "condition": "{{ macro.is_cisco_cucx_enabled }}", "icon": "add_circle" }, { "description": "Upload Recorded Audio File for Greetings and Prompts", "link_text": "File Upload", "type": "data/File", "display": "form", "icon": "file_upload" }, { "description": "Cisco Auto Attendant Schedule Management", "link_text": "Cisco Auto Attendant Schedule", "filter_options": [ { "filter_string": "Sync Schedule", "filter_type": "notequal", "filter_by": "DisplayName" } ], "type": "relation/CucScheduleREL", "display": "list", "condition": "{{ macro.is_cisco_cucx_enabled }}", "icon": "schedule" } ], "title": "Quick Actions" } ], "name": "Dashboard Call Groups", "counters": [ { "field_display_policy": "BusinessAdminHuntGroupFDP", "icon": "group_work", "type": "relation/HuntGroupRelation", "condition": "{{ macro.is_cisco_cucm_enabled }}", "title": "Cisco Hunt Groups" }, { "field_display_policy": "BusinessAdminCallPickupGroupFDP", "icon": "contact_phone", "type": "relation/CallPickupGroups", "condition": "{{ macro.is_cisco_cucm_enabled }}", "title": "Cisco Call Pickup Groups" }, { "filter_options": [ { "filter_string": "false", "filter_type": "equals", "filter_by": "IsPrimary" } ], "icon": "call_split", "type": "relation/CallhandlerREL", "condition": "{{ macro.is_cisco_cucm_enabled }}", "title": "Cisco Auto Attendants" }, { "icon": "group_work", "type": "device/msteamsonline/CsAutoAttendant", "condition": "{{ macro.is_microsoft_enabled }}", "title": "Microsoft Auto Attendants" }, { "icon": "phone_forwarded", "type": "device/msteamsonline/CsCallQueue", "condition": "{{ macro.is_microsoft_enabled }}", "title": "Microsoft Call Queues" }, { "icon": "airline_seat_recline_extra", "type": "device/msteamsonline/Holiday", "condition": "{{ macro.is_microsoft_enabled }}", "title": "Holidays" }, { "icon": "restore", "type": "device/msteamsonline/CsOnlineApplicationInstance", "condition": "{{ macro.is_microsoft_enabled }}", "title": "Resource Accounts" } ], "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/LandingPage", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "Dashboard", "bap", "V4UC", "ba_ProviderOverlay" ], "title": "Dashboard Call Groups", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [ { "path": "counters.0.field_display_policy", "model_type": "data/FieldDisplayPolicy" }, { "path": "counters.1.field_display_policy", "model_type": "data/FieldDisplayPolicy" }, { "path": "sections.0.links.0.field_display_policy", "model_type": "data/FieldDisplayPolicy" }, { "path": "sections.0.links.1.field_display_policy", "model_type": "data/FieldDisplayPolicy" }, { "path": "sections.0.links.2.field_display_policy", "model_type": "data/FieldDisplayPolicy" }, { "path": "sections.0.links.3.field_display_policy", "model_type": "data/FieldDisplayPolicy" } ], "self": [ { "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/", "pkid": "650fe55e84eaf2a1ce63b2d6" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "650fe55e84eaf2a1ce63b2d6" ], "system_resource": false, "schema_version": "0.7.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2d6/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "650fe55e84eaf2a1ce63b2d6" }, { "data": { "pkid": "650fe55e84eaf2a1ce63b2e3", "sections": [ { "links": [ { "description": "View any existing Cisco Hunt Pilots, Hunt Lists or Line Groups displayed as connected Hunt Groups", "link_text": "View Hunt Groups", "type": "relation/HuntGroupRelation", "display": "list", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "group_work" }, { "description": "Add a Cisco Hunt Pilot / Hunt Lists / Line Group combination to form a Hunt Group", "link_text": "Add Hunt Group", "type": "relation/HuntGroupRelation", "display": "form", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "add" }, { "description": "View any existing Cisco Call Pickup Groups", "link_text": "View Call Pickup Groups", "type": "relation/CallPickupGroups", "display": "list", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "contact_phone" }, { "description": "Add a Cisco Call Pickup Group", "link_text": "Add Call Pickup Group", "type": "relation/CallPickupGroups", "display": "form", "condition": "{{ macro.is_cisco_cucm_enabled }}", "icon": "add_box" } ], "title": "Quick Actions" } ], "name": "Dashboard Cisco Call Groups", "counters": [ { "icon": "group_work", "type": "relation/HuntGroupRelation", "title": "Cisco Hunt Groups" }, { "icon": "contact_phone", "type": "relation/CallPickupGroups", "title": "Cisco Call Pickup Groups" } ], "hierarchy_friendly_name": "hcs (Hcs)", "hierarchy_path": "sys.hcs" }, "meta": { "model_type": "data/LandingPage", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "V4UC", "ba_ProviderOverlay" ], "title": "Dashboard Cisco Call Groups", "business_key": { "hierarchy": true, "unique": [ "name" ] }, "api_version": "21.2", "cached": true, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "pkid": "5ad5bacbaffa9343e4d93e01", "href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01" } ], "foreign_key": [], "self": [ { "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/", "pkid": "650fe55e84eaf2a1ce63b2e2" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5ad5bacbaffa9343e4d93e01", "650fe55e84eaf2a1ce63b2e2" ], "schema_version": "0.7.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/clone/?schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/export/", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/", "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/+tag/", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/" } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/+tag_version/", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/" } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/LandingPage/650fe55e84eaf2a1ce63b2e2/help", "support_async": false, "title": "Help" } } ], "summary": "false" }, "pkid": "650fe55e84eaf2a1ce63b2e2" } ] }
(Show the first instance)
{ "data": { "name": "admin_page", "sections": [ { "image": "www/img/landingPageIcons/Global.png", "links": [ { "link_text": "Manage Subscribers", "type": "device/cucm/User", "display": "list" }, { "link_text": "Manage Users", "type": "data/User", "display": "list" } ], "title": "Site Management" }, { "image": "www/img/landingPageIcons/Migration.png", "links": [ { "link_text": "Manage Partitions", "type": "device/cuc/Partition", "display": "list" }, { "link_text": "Manage Calling Search Spaces", "type": "device/cucm/Css", "display": "list" } ], "title": "DialPlan Management" }, { "image": "www/img/landingPageIcons/Network.png", "links": [ { "link_text": "Manage Cisco Call Managers", "type": "data/CallManager", "display": "list" }, { "link_text": "Manage Cisco Unity Connection", "type": "data/UnityConnection", "display": "list" } ], "title": "Network Management" } ], "pkid": "5abb946faffa931ce72a747d" }, "meta": { "model_type": "data/LandingPage", "summary_attrs": [ { "name": "name", "title": "Name" }, { "name": "description", "title": "Description" }, { "name": "hierarchy_friendly_name", "title": "Located At", "allow_filtering": true } ], "tagged_versions": [], "tags": [ "base", "core" ], "title": "admin_page", "business_key": { "unique": [ "name" ], "hierarchy": true }, "api_version": "21.2", "cached": false, "references": { "device": [ { "href": "", "pkid": "" } ], "owner": [ { "pkid": "" } ], "parent": [ { "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101", "pkid": "6t0ggef2c0deab00hb595101" } ], "foreign_key": [], "children": [], "self": [ { "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/", "pkid": "5abb946faffa931ce72a747c" } ] }, "path": [ "6t0ggef2c0deab00hb595101", "5abb946faffa931ce72a747c" ], "system_resource": true, "schema_version": "0.7.0", "actions": [ { "update": { "method": "PUT", "class": "update", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/?hierarchy=[hierarchy]", "support_async": true, "title": "Modify" } }, { "remove": { "method": "DELETE", "class": "delete", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/?hierarchy=[hierarchy]", "support_async": true, "title": "Delete" } }, { "clone": { "method": "GET", "class": "clone", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true", "support_async": false, "title": "Clone" } }, { "export": { "method": "GET", "class": "export", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/export/?hierarchy=[hierarchy]", "support_async": false, "title": "Export", "view": "/api/view/ExportData/add/?auth_token=[authtoken], "submit": "payload" } }, { "tag": { "method": "PATCH", "class": "tag", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/+tag/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag", "view": "/api/view/TagNameForm/add/?auth_token=[authtoken] } }, { "tag_version": { "method": "PATCH", "class": "tag_version", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/+tag_version/?hierarchy=[hierarchy]", "support_async": true, "title": "Tag Version", "view": "/api/view/TagVersionForm/add/?auth_token=[authtoken] } }, { "get": { "method": "GET", "class": "get", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/?hierarchy=[hierarchy]", "support_async": false, "title": "Get" } }, { "help": { "method": "GET", "class": "help", "href": "/api/data/LandingPage/5abb946faffa931ce72a747c/help?hierarchy=[hierarchy]", "support_async": false, "title": "Help" } } ] }, "pkid": "5abb946faffa931ce72a747c" }
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get the on-line Help for data/LandingPage. | GET | /api/data/LandingPage/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/LandingPage as HTML |
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Modify | PUT | /api/data/LandingPage/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Delete | DELETE | /api/data/LandingPage/[pkid] | hierarchy=[hierarchy] |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/LandingPage/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/LandingPage/?hierarchy=[hierarchy]&format=json
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get a selected [export_format] of the schema and a single instance with [pkid] of data/LandingPage; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/LandingPage/[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/LandingPage and the JSON format can be used to import instances of data/LandingPage.
For Bulk Export, refer to the Bulk Export section.
Task | Call | URL | Parameters | Payload |
---|---|---|---|---|
Tag | PATCH | /api/data/LandingPage/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Get | GET | /api/data/LandingPage/[pkid] | hierarchy=[hierarchy] | The data/LandingPage instance with [pkid]. |
Task | Call | URL | Parameters | Response |
---|---|---|---|---|
Help | GET | /api/data/LandingPage/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/LandingPage. |