[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"
},
"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"
}
]
},
"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.2"
}
| 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 |
|---|---|---|---|---|
| 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": 94,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Dashboard/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"field_display_policy",
"update",
"help",
"remove",
"move",
"add",
"export",
"list",
"configuration_template",
"get",
"bulk_update_form",
"migration",
"transform",
"export_bulkload_template"
],
"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"
],
"schema_version": "0.2",
"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"
}
},
{
"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": "66787662fa938def246293e7",
"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/66787662fa938def246293e6/",
"pkid": "66787662fa938def246293e6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"66787662fa938def246293e6"
],
"schema_version": "0.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66787662fa938def246293e6/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66787662fa938def246293e6/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66787662fa938def246293e6/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66787662fa938def246293e6/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66787662fa938def246293e6/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/66787662fa938def246293e6/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66787662fa938def246293e6/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "66787662fa938def246293e6"
},
{
"data": {
"name": "Dashboard Call Groups",
"description": "",
"widgets": [
{
"alignmentData": {
"cols": 20,
"rows": 2
},
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": " ",
"datasource": "Automate",
"default": "highcharts",
"type": 16,
"automate_counters": [
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"field_display_policy": "BusinessAdminHuntGroupFDP",
"icon": "group_work",
"title": "Cisco Hunt Groups",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"field_display_policy": "BusinessAdminCallPickupGroupFDP",
"icon": "contact_phone",
"title": "Cisco Call Pickup Groups",
"type": "relation/CallPickupGroups"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"filter_options": [
{
"filter_by": "IsPrimary",
"filterValue": "false",
"operation": "equals"
}
],
"icon": "call_split",
"title": "Cisco Auto Attendants",
"type": "relation/CallhandlerREL"
}
]
}
},
{
"alignmentData": {
"cols": 20,
"rows": 2
},
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": " ",
"datasource": "Automate",
"default": "highcharts",
"type": 16,
"automate_counters": [
{
"condition": "{{ macro.is_microsoft_enabled }}",
"icon": "group_work",
"title": "Microsoft Auto Attendants",
"type": "device/msteamsonline/CsAutoAttendant"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"icon": "phone_forwarded",
"title": "Microsoft Call Queues",
"type": "device/msteamsonline/CsCallQueue"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"icon": "airline_seat_recline_extra",
"title": "Holidays",
"type": "device/msteamsonline/Holiday"
}
]
}
},
{
"alignmentData": {
"cols": 20,
"rows": 2
},
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": " ",
"datasource": "Automate",
"default": "highcharts",
"type": 16,
"automate_counters": [
{
"condition": "{{ macro.is_microsoft_enabled }}",
"icon": "restore",
"title": "Resource Accounts",
"type": "device/msteamsonline/CsOnlineApplicationInstance"
}
]
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "View any existing Cisco Hunt Pilots, Hunt Lists or Line Groups displayed as connected Hunt Groups",
"display": "list",
"field_display_policy": "BusinessAdminHuntGroupFDP",
"icon": "group_work",
"link_text": "View Hunt Groups",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "View any existing Cisco Call Pickup Groups",
"display": "list",
"field_display_policy": "BusinessAdminCallPickupGroupFDP",
"icon": "contact_phone",
"link_text": "View Call Pickup Groups",
"type": "relation/CallPickupGroups"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "Add a Cisco Hunt Pilot / Hunt Lists / Line Group combination to form a Hunt Group",
"display": "form",
"field_display_policy": "BusinessAdminHuntGroupFDP",
"icon": "add",
"link_text": "Add Hunt Group",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "Add a Cisco Call Pickup Group",
"display": "form",
"field_display_policy": "BusinessAdminCallPickupGroupFDP",
"icon": "add_box",
"link_text": "Add Call Pickup Group",
"type": "relation/CallPickupGroups"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"description": "View any existing Microsoft Auto Attendants",
"display": "list",
"icon": "call_split",
"link_text": "View MS Auto Attendants",
"type": "device/msteamsonline/CsAutoAttendant"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"description": "View any existing Microsoft Call Queues",
"display": "list",
"icon": "call",
"link_text": "View Call Queues",
"type": "device/msteamsonline/CsCallQueue"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"description": "Add a Microsoft Auto Attendant",
"display": "form",
"icon": "add_circle_outline",
"link_text": "Add MS Auto Attendant",
"type": "device/msteamsonline/CsAutoAttendant"
},
{
"condition": "{{ macro.is_microsoft_enabled }}",
"description": "Add a Microsoft Call Queue",
"display": "form",
"icon": "add_circle",
"link_text": "Add Call Queue",
"type": "device/msteamsonline/CsCallQueue"
},
{
"condition": "{{ macro.is_cisco_cucx_enabled }}",
"description": "Cisco Auto Attendant",
"display": "list",
"filter_options": [
{
"filter_by": "IsPrimary",
"filterValue": "false",
"operation": "equals"
}
],
"icon": "call_split",
"link_text": "View Cisco Auto Attendant",
"type": "relation/CallhandlerREL"
},
{
"description": "View Recorded Audio Files for Greetings and Prompts",
"display": "list",
"icon": "folder_open",
"link_text": "View Files",
"type": "data/File"
},
{
"condition": "{{ macro.is_cisco_cucx_enabled }}",
"description": "Add Cisco Auto Attendant",
"display": "form",
"icon": "add_circle",
"link_text": "Add Cisco Auto Attendant",
"type": "relation/CallhandlerREL"
},
{
"description": "Upload Recorded Audio File for Greetings and Prompts",
"display": "form",
"icon": "file_upload",
"link_text": "File Upload",
"type": "data/File"
},
{
"condition": "{{ macro.is_cisco_cucx_enabled }}",
"description": "Cisco Auto Attendant Schedule Management",
"display": "list",
"filter_options": [
{
"filter_by": "DisplayName",
"filterValue": "Sync Schedule",
"operation": "notequal"
}
],
"icon": "schedule",
"link_text": "Cisco Auto Attendant Schedule",
"type": "relation/CucScheduleREL"
}
],
"title": "Quick Actions"
}
}
],
"pkid": "66787bbdfa938def2462c1d7",
"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": "Dashboard Call Groups",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/",
"pkid": "66787bbdfa938def2462c1d6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"66787bbdfa938def2462c1d6"
],
"schema_version": "0.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66787bbdfa938def2462c1d6/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "66787bbdfa938def2462c1d6"
},
{
"data": {
"name": "Dashboard Cisco Call Groups",
"description": "",
"widgets": [
{
"alignmentData": {
"cols": 20,
"rows": 2
},
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": " ",
"datasource": "Automate",
"default": "highcharts",
"type": 16,
"automate_counters": [
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"icon": "group_work",
"title": "Cisco Hunt Groups",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"icon": "contact_phone",
"title": "Cisco Call Pickup Groups",
"type": "relation/CallPickupGroups"
}
]
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "View any existing Cisco Hunt Pilots, Hunt Lists or Line Groups displayed as connected Hunt Groups",
"display": "list",
"icon": "group_work",
"link_text": "View Hunt Groups",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "Add a Cisco Hunt Pilot / Hunt Lists / Line Group combination to form a Hunt Group",
"display": "form",
"icon": "add",
"link_text": "Add Hunt Group",
"type": "relation/HuntGroupRelation"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "View any existing Cisco Call Pickup Groups",
"display": "list",
"icon": "contact_phone",
"link_text": "View Call Pickup Groups",
"type": "relation/CallPickupGroups"
},
{
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"description": "Add a Cisco Call Pickup Group",
"display": "form",
"icon": "add_box",
"link_text": "Add Call Pickup Group",
"type": "relation/CallPickupGroups"
}
],
"title": "Quick Actions"
}
}
],
"pkid": "66787bc6fa938def2462c28f",
"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": "Dashboard Cisco Call Groups",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5ad5bacbaffa9343e4d93e01",
"href": "/api/data/HierarchyNode/5ad5bacbaffa9343e4d93e01"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/",
"pkid": "66787bc6fa938def2462c28e"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5ad5bacbaffa9343e4d93e01",
"66787bc6fa938def2462c28e"
],
"schema_version": "0.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66787bc6fa938def2462c28e/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "66787bc6fa938def2462c28e"
}
]
}
(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": "66787662fa938def246293e7"
},
"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/66787662fa938def246293e6/",
"pkid": "66787662fa938def246293e6"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"66787662fa938def246293e6"
],
"schema_version": "0.2",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66787662fa938def246293e6/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66787662fa938def246293e6/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66787662fa938def246293e6/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66787662fa938def246293e6/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66787662fa938def246293e6/export/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/?auth_token=[authtoken],
"submit": "payload"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/66787662fa938def246293e6/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66787662fa938def246293e6/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "66787662fa938def246293e6"
}
| 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 | 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. |