[Index]
Data model for user dashboards.
Model ref.: data/Dashboard
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",
"type": "string",
"required": true
},
"description": {
"title": "Description",
"type": "string"
},
"readonly": {
"title": "Read Only",
"type": "boolean"
},
"hide_time_picker": {
"title": "Hide Time Picker",
"type": "boolean"
},
"default_date_range": {
"title": "Default Date Range",
"description": "Default Date Range",
"type": "object",
"properties": {
"range": {
"title": "Range",
"type": "string"
},
"_lowerTs": {
"title": "_lowerTs",
"type": "number"
},
"_upperTs": {
"title": "_upperTs",
"type": "number"
},
"fromFriendlyString": {
"title": "fromFriendlyString",
"type": "string"
},
"toFriendlyString": {
"title": "toFriendlyString",
"type": "string"
}
}
},
"hide_datasource_selector": {
"title": "Hide Datasource Selector",
"type": "boolean"
},
"reporter_resource_data": {
"title": "Reporter Resource",
"description": "Returns the reporter resource data",
"type": "string"
},
"field_grouping_data": {
"title": "Field Grouping",
"description": "Returns the dashboard field grouping",
"type": "string"
},
"color_mappings_data": {
"title": "Color Mappings",
"description": "Returns the dashboard color mappings",
"type": "string"
},
"datasource_data": {
"title": "Data Source",
"description": "Returns the dashboard datasource",
"type": "string"
},
"widgets": {
"title": "Widgets",
"description": "List of widgets.",
"type": "array",
"items": {
"type": "object",
"properties": {
"alignmentData": {
"title": "Alignment Data",
"type": "any"
},
"guid": {
"title": "ID",
"type": "string"
},
"transparent": {
"title": "Transparent",
"type": "boolean"
},
"condition": {
"title": "Condition",
"type": "string"
},
"type": {
"title": "Type",
"type": "string",
"choices": [
{
"value": "text",
"title": "Text"
},
{
"value": "links",
"title": "Links"
},
{
"value": "counters",
"title": "Counters"
},
{
"value": "saved-search",
"title": "Saved Search"
},
{
"value": "table",
"title": "Table"
},
{
"value": "line-chart",
"title": "Line Chart"
},
{
"value": "column-chart",
"title": "Column Chart"
},
{
"value": "pie-chart",
"title": "Pie Chart"
},
{
"value": "gauge-chart",
"title": "Gauge Chart"
},
{
"value": "chord-chart",
"title": "Chord Chart"
}
]
},
"modelType": {
"title": "Model Type",
"type": "string",
"format": "uri",
"target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_model_type": "",
"choices": []
},
"data": {
"title": "Widget Data",
"type": "any"
}
}
}
}
},
"schema_version": "0.8"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/data/Dashboard/add/ |
|
The GUI Add form of data/Dashboard 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/Dashboard | 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/Dashboard/ | hierarchy=[hierarchy] | {"hrefs":["/api/data/Dashboard/[pkid1]", "/api/data/Dashboard/[pkid2]", ...]} |
GET http://[host-proxy]/api/data/Dashboard/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of data/Dashboard; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | POST | /api/data/Dashboard/export/ |
|
{ "hrefs":["/api/data/Dashboard/[pkid1]", "/api/data/Dashboard/[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/Dashboard and the JSON format can be used to import instances of data/Dashboard.
GET http://[host-proxy]/api/data/Dashboard/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for data/Dashboard | POST | /api/data/Dashboard/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Dashboard/+tag/ |
|
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/data/Dashboard/ |
|
The data/Dashboard schema and all instances as JSON. |
(The list will return 0 to 3 data/Dashboard instances)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 143,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Dashboard/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"remove",
"move",
"get",
"add",
"list",
"export",
"bulk_update_form",
"transform",
"export_bulkload_template",
"configuration_template",
"help",
"migration",
"update",
"field_display_policy"
],
"meta": {
"model_type": "data/Dashboard",
"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": [
"get",
"add",
"remove",
"update",
"list",
"clone",
"export",
"export_bulkload_template",
"help",
"import",
"tag"
],
"schema_version": "0.8",
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/data/Dashboard/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"export": {
"method": "POST",
"class": "export",
"href": "/api/data/Dashboard/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/Dashboard/export_bulkload_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export Bulk Load Template"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/data/Dashboard/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"resources": [
{
"data": {
"name": "admin_dashboard",
"widgets": [
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 10,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Network Management",
"links": [
{
"link_text": "Manage Cisco Call Managers",
"display": "list",
"type": "data/CallManager",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Cisco Unity Connection",
"display": "list",
"type": "data/UnityConnection",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 5,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Dialplan Management",
"links": [
{
"link_text": "Manage Partitions",
"display": "list",
"type": "device/cucm/RoutePartition",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Calling Search Spaces",
"display": "list",
"type": "device/cucm/Css",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 0,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Site Management",
"links": [
{
"link_text": "Manage Subscribers",
"icon": "people",
"display": "list",
"type": "device/cucm/User",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Users",
"icon": "people",
"display": "list",
"type": "data/User",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
}
],
"pkid": "6699f02f67bc66b53e40b8e9",
"hierarchy_friendly_name": "sys (System)",
"hierarchy_path": "sys"
},
"meta": {
"model_type": "data/Dashboard",
"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",
"dashboard"
],
"title": "admin_dashboard",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/",
"pkid": "6699f02f67bc66b53e40b8e8"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"6699f02f67bc66b53e40b8e8"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "6699f02f67bc66b53e40b8e8"
},
{
"data": {
"name": "Automate Default",
"description": "Main Dashboard for Default Provider Admins",
"default_date_range": {
"range": "Last 7 Days",
"_lowerTs": 1744347600,
"_upperTs": 1744984581,
"fromFriendlyString": "Apr 11 2025 12:00:00 am",
"toFriendlyString": "Apr 18 2025 08:56:21 am"
},
"widgets": [
{
"alignmentData": {
"cols": 10,
"rows": 4,
"x": 10,
"y": 1
},
"type": "chart-column",
"modelType": "data/DashboardWidgetChartColumn",
"data": {
"title": "Licensed Users by Top 5 Customers",
"resource": "Multivendor Subscriber View",
"datasource": "LXT0",
"allowDatasourceSelection": true,
"_lowerTs": 1744898176,
"_upperTs": 1744984576,
"_outputType": "highcharts",
"_groupingLimit": "5",
"interval": 3,
"type": 1,
"fields": [
{
"guid": "4bfb7114",
"ruleName": "username",
"headerName": "User Count",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Count"
},
{
"guid": "1b6437479",
"ruleName": "Customer",
"headerName": "Customer",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Grouping Count"
},
{
"guid": "472e76f5",
"ruleName": "license_audit_details_status",
"headerName": "License Audit Details Status",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Grouping Count"
}
],
"filters": [
{
"guid": "d2151124",
"ruleName": "license_audit_details_status",
"operation": "=",
"filterValue": "Licensed"
}
],
"sorts": [],
"settings": {
"stackType": null,
"isHorizontal": true,
"showLabels": true,
"showLegend": true,
"legendPlacement": "bottom"
},
"drilldowns": {
"filterOption": "IN",
"drilldownOption": 0,
"drilldownFields": []
},
"timezone": "America/Chicago",
"_limit": 0,
"_offset": 0,
"hierarchy": "6t0ggef2c0deab00hb595101",
"automate_table_resource": {
"filter_options": []
},
"description": "Displays Licensed Users per Customer"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 4,
"x": 5,
"y": 1
},
"type": "chart-column",
"modelType": "data/DashboardWidgetChartColumn",
"data": {
"title": "Available Numbers by Top 10 Sites",
"resource": "Number Inventory",
"datasource": "LXT0",
"_lowerTs": 1744898176,
"_upperTs": 1744984576,
"_outputType": "highcharts",
"_groupingLimit": "10",
"interval": 3,
"type": 1,
"fields": [
{
"guid": "23f2e0fa6",
"ruleName": "status",
"headerName": "Status",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Count"
},
{
"guid": "bcb3fe2e",
"ruleName": "Site",
"headerName": "Site",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Grouping Count"
}
],
"filters": [
{
"guid": "21857343",
"ruleName": "status",
"operation": "=",
"filterValue": "Available"
}
],
"sorts": [],
"settings": {
"stackType": 0,
"axisXType": 0,
"numericPrecision": 0,
"is3d": false,
"showLabels": true,
"showLegend": true,
"legendPlacement": "bottom"
},
"drilldowns": {
"filterOption": "IN",
"drilldownOption": 0,
"drilldownFields": []
},
"timezone": "America/Chicago",
"hierarchy": "6t0ggef2c0deab00hb595101",
"_limit": 0,
"_offset": 0
}
},
{
"alignmentData": {
"cols": 5,
"rows": 6,
"x": 5,
"y": 5
},
"type": "chart-pie",
"modelType": "data/DashboardWidgetChartPie",
"data": {
"title": "Total System Number Allocation",
"resource": "Number Inventory",
"datasource": "LXT0",
"_lowerTs": 1744898176,
"_upperTs": 1744984576,
"_outputType": "highcharts",
"_groupingLimit": "0",
"type": 2,
"fields": [
{
"guid": "1806d94bf",
"ruleName": "status",
"headerName": "Status",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Grouping Count"
}
],
"filters": [],
"sorts": [],
"settings": {
"showLabels": true,
"legendPlacement": "bottom",
"showNumbers": true
},
"drilldowns": {
"filterOption": "IN",
"drilldownOption": 0,
"drilldownFields": []
},
"timezone": "America/Chicago",
"hierarchy": "6t0ggef2c0deab00hb595101",
"_limit": 0,
"_offset": 0
}
},
{
"alignmentData": {
"cols": 10,
"rows": 6,
"x": 10,
"y": 5
},
"type": "chart-pie",
"modelType": "data/DashboardWidgetChartPie",
"data": {
"title": "Top 10 Actions",
"description": "Shows a split of the top 10 actions performed",
"resource": "Transactions",
"datasource": "LXT0",
"_lowerTs": 1744898176,
"_upperTs": 1744984576,
"_outputType": "highcharts",
"_groupingLimit": "10",
"type": 2,
"fields": [
{
"guid": "5b144e4b",
"ruleName": "action",
"headerName": "Action",
"ruleTypeString": "Text",
"ruleType": 0,
"valueType": 0,
"operation": "Grouping Count"
}
],
"filters": [
{
"guid": "e11c5247",
"ruleName": "parent",
"operation": "="
},
{
"guid": "19074b576",
"ruleName": "action",
"operation": "!=",
"filterValue": "Execute Event"
},
{
"guid": "30381975",
"ruleName": "action",
"operation": "!=",
"filterValue": "Execute Schedule"
},
{
"guid": "400e9b6b",
"ruleName": "user_username",
"operation": "!=",
"filterValue": "system"
}
],
"sorts": [],
"settings": {
"showLabels": true,
"legendPlacement": "bottom",
"showNumbers": true
},
"drilldowns": {
"filterOption": "IN",
"drilldownOption": 0,
"drilldownFields": []
},
"timezone": "America/Chicago",
"hierarchy": "6t0ggef2c0deab00hb595101",
"_limit": 0,
"_offset": 0
}
},
{
"alignmentData": {
"cols": 20,
"rows": 1,
"x": 0,
"y": 0
},
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": " Customers",
"datasource": "Automate",
"default": "highcharts",
"type": 16,
"automate_counters": [
{
"title": "Customers",
"icon": "account_balance",
"type": "relation/HcsCustomerREL",
"filter_options": [],
"configurable_options": []
},
{
"title": "Sites",
"icon": "business",
"type": "relation/HcsSiteREL",
"filter_options": [],
"configurable_options": []
},
{
"title": "Subscribers",
"icon": "people",
"type": "relation/MultiVendorSubscribers",
"filter_options": [],
"configurable_options": []
},
{
"title": "Numbers in Use",
"icon": "phone",
"type": "relation/NumberInventoryREL",
"filter_options": [
{
"filter_by": "status",
"operation": "notequal",
"filterValue": "Available"
}
],
"configurable_options": []
}
],
"_upperTs": 1744984576,
"_lowerTs": 1744898176,
"timezone": "America/Chicago",
"filters": [],
"fields": [],
"sorts": [],
"settings": {
"renderers": []
},
"drilldowns": {
"drilldownFields": []
}
}
},
{
"alignmentData": {
"cols": 5,
"rows": 6,
"x": 0,
"y": 5
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Transaction Logs",
"icon": "call_to_action",
"display": "list",
"type": "tool/Transaction",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Import",
"icon": "arrow_upward",
"display": "form",
"type": "tool/DataImport",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Bulk Load",
"icon": "backup",
"display": "form",
"type": "tool/BulkLoad",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Customer Record Counts",
"icon": "format_list_numbered",
"display": "form",
"type": "view/OverbuildOverview",
"filter_options": [],
"configurable_options": []
}
],
"title": "General Tools",
"_upperTs": 1744984576,
"_lowerTs": 1744898176,
"timezone": "America/Chicago"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 4,
"x": 0,
"y": 1
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Onboard User",
"description": "This is the generic Add Subscriber from Profile",
"icon": "add_to_queue",
"display": "form",
"type": "view/AddSubscriberFromProfile",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Admins",
"icon": "supervisor_account",
"condition": "",
"display": "list",
"type": "relation/User",
"filter_options": [
{
"filter_by": "user_type",
"operation": "contains",
"filterValue": "admin",
"ignore_case": true
}
],
"configurable_options": []
},
{
"link_text": "Reset Passwords & PINs",
"icon": "refresh",
"display": "form",
"type": "view/ResetUCPasswordPinVIEW",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Call Groups",
"icon": "group_work",
"display": "dashboard",
"dashboard": "Automate Default - Subscribers & Services - Call Groups",
"filter_options": [],
"configurable_options": [],
"pkid": "68013c3ca643f80282d59ab3"
},
{
"link_text": "Number Management",
"icon": "plus_one",
"display": "dashboard",
"dashboard": "Automate Default - Number Management",
"filter_options": [],
"configurable_options": [],
"pkid": "67c190458504ccffc6c9d06b"
},
{
"link_text": "Transaction Overview",
"icon": "playlist_add",
"display": "dashboard",
"dashboard": "Transaction Overview",
"filter_options": [],
"configurable_options": [],
"pkid": "68013c3ca643f80282d59abf"
}
],
"title": "Quick Actions",
"_upperTs": 1744984576,
"_lowerTs": 1744898176,
"timezone": "America/Chicago"
}
}
],
"pkid": "682e94255c69e65974785904",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/Dashboard",
"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_CommonOverlay"
],
"title": "Automate Default",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/682e94255c69e65974785903/",
"pkid": "682e94255c69e65974785903"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"682e94255c69e65974785903"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/682e94255c69e65974785903/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/682e94255c69e65974785903/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/682e94255c69e65974785903/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/682e94255c69e65974785903/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/682e94255c69e65974785903/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/682e94255c69e65974785903/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/682e94255c69e65974785903/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/682e94255c69e65974785903/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "682e94255c69e65974785903"
},
{
"data": {
"name": "Automate Default - Additional Admin Functions - Admin Tools",
"description": "General tools, file access and information",
"widgets": [
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 0,
"y": 3
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Overbuild Overview Tool",
"icon": "view_comfy",
"display": "form",
"type": "view/OverbuildOverview",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Site Defaults",
"icon": "business_center",
"display": "list",
"type": "data/SiteDefaultsDoc",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Run Overbuild",
"icon": "play_arrow",
"display": "form",
"type": "view/EasyOverbuild",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Run Analogue Gateway Overbuild",
"icon": "play_arrow",
"condition": "\t{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/GS_AGW_overbuild_VIEW",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Run Dial-Plan Overbuild",
"icon": "play_arrow",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/MKI_DialPlan_Overbuild_View",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Dial-Plan Overbuild Search Queries",
"icon": "question_answer",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/BrownField",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "Overbuild_Search_Queries",
"ignore_case": true
}
],
"configurable_options": []
},
{
"link_text": "Fix User Phone Associate Tool",
"icon": "build",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/FixUserAssociateDevices",
"filter_options": [],
"configurable_options": []
}
],
"title": "Overbuild Tools",
"_upperTs": 1746768690,
"_lowerTs": 1746079200,
"timezone": "America/Denver"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 0,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"_lowerTs": 1746079200,
"_upperTs": 1746768690,
"links": [
{
"display": "list",
"icon": "format_list_numbered",
"link_text": "Transaction Log",
"type": "tool/Transaction"
},
{
"description": "Update the system settings ",
"display": "form",
"icon": "settings_applications",
"link_text": "Transactions Log Level Configuration",
"type": "view/DataSettings"
},
{
"display": "form",
"icon": "cloud_upload",
"link_text": "Bulk Load",
"type": "tool/BulkLoad"
},
{
"display": "list",
"icon": "warning",
"link_text": "Alerts",
"type": "data/Alert"
},
{
"display": "form",
"icon": "arrow_upward",
"link_text": "Import",
"type": "tool/DataImport"
}
],
"timezone": "America/Denver",
"title": "General Tools"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 10,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"_lowerTs": 1746079200,
"_upperTs": 1746768690,
"links": [
{
"display": "list",
"icon": "file_upload",
"link_text": "File Management",
"type": "data/File"
},
{
"display": "list",
"field_display_policy": "CertFDP",
"icon": "verified_user",
"link_text": "Certificate Management",
"type": "data/Certificate"
},
{
"display": "list",
"icon": "message",
"link_text": "User Management logs",
"type": "data/HcsUserManagementLogDAT"
},
{
"display": "form",
"icon": "report",
"link_text": "Create Model Report",
"type": "view/ModelReportVIEW"
},
{
"display": "list",
"icon": "bug_report",
"link_text": "Model Report Results",
"type": "data/ModelReport"
}
],
"timezone": "America/Denver",
"title": "Files and Logs"
}
}
],
"pkid": "682e94235c69e659747858dc",
"hierarchy_friendly_name": "hcs (Hcs)",
"hierarchy_path": "sys.hcs"
},
"meta": {
"model_type": "data/Dashboard",
"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_CommonOverlay"
],
"title": "Automate Default - Additional Admin Functions - Admin Tools",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5da4c643ce894e0012225c90",
"href": "/api/data/HierarchyNode/5da4c643ce894e0012225c90"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/682e94235c69e659747858db/",
"pkid": "682e94235c69e659747858db"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5da4c643ce894e0012225c90",
"682e94235c69e659747858db"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/682e94235c69e659747858db/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/682e94235c69e659747858db/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/682e94235c69e659747858db/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/682e94235c69e659747858db/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/682e94235c69e659747858db/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/682e94235c69e659747858db/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/682e94235c69e659747858db/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/682e94235c69e659747858db/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "682e94235c69e659747858db"
}
]
}
(Show the first instance)
{
"data": {
"name": "admin_dashboard",
"widgets": [
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 10,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Network Management",
"links": [
{
"link_text": "Manage Cisco Call Managers",
"display": "list",
"type": "data/CallManager",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Cisco Unity Connection",
"display": "list",
"type": "data/UnityConnection",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 5,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Dialplan Management",
"links": [
{
"link_text": "Manage Partitions",
"display": "list",
"type": "device/cucm/RoutePartition",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Calling Search Spaces",
"display": "list",
"type": "device/cucm/Css",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
},
{
"alignmentData": {
"cols": 5,
"rows": 5,
"x": 0,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"title": "Site Management",
"links": [
{
"link_text": "Manage Subscribers",
"icon": "people",
"display": "list",
"type": "device/cucm/User",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Manage Users",
"icon": "people",
"display": "list",
"type": "data/User",
"filter_options": [],
"configurable_options": []
}
],
"timezone": "Africa/Johannesburg"
}
}
],
"pkid": "6699f02f67bc66b53e40b8e9"
},
"meta": {
"model_type": "data/Dashboard",
"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",
"dashboard"
],
"title": "admin_dashboard",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": false,
"references": {
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"children": [],
"self": [
{
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/",
"pkid": "6699f02f67bc66b53e40b8e8"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"6699f02f67bc66b53e40b8e8"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/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/Dashboard/6699f02f67bc66b53e40b8e8/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/6699f02f67bc66b53e40b8e8/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "6699f02f67bc66b53e40b8e8"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for data/Dashboard. | GET | /api/data/Dashboard/help | hierarchy=[hierarchy] | On-line help of Model ref.: data/Dashboard as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Modify | PUT | /api/data/Dashboard/[pkid] | hierarchy=[hierarchy] | (For payload specification) |
For Bulk modification, refer to the Bulk Modify section.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Delete | DELETE | /api/data/Dashboard/[pkid] | hierarchy=[hierarchy] |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Clone instance with [pkid]. The schema rules are applied. | GET | /api/data/Dashboard/[pkid]/clone/?schema=&schema_rules=true |
|
A JSON payload with:
|
GET http://[host-proxy]/api/data/Dashboard/?hierarchy=[hierarchy]&format=json
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Import | POST | /api/data/Dashboard/[pkid]/import | 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/Dashboard; optionally with tag_version at [version] and Configuration Template as [configtemplate]. | GET | /api/data/Dashboard/[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/Dashboard and the JSON format can be used to import instances of data/Dashboard.
For Bulk Export, refer to the Bulk Export section.
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/data/Dashboard/[pkid]/+tag | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/data/Dashboard/[pkid] | hierarchy=[hierarchy] | The data/Dashboard instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/data/Dashboard/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for data/Dashboard. |