[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": 181,
"total_limit": null,
"order_by": "name",
"direction": "asc",
"current": "/api/data/Dashboard/?skip=0&limit=3&order_by=name&direction=asc&traversal=fulltree"
},
"operations": [
"list",
"get",
"update",
"help",
"transform",
"export_bulkload_template",
"field_display_policy",
"configuration_template",
"add",
"export",
"bulk_update_form",
"migration",
"remove"
],
"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": "66b06472782467d43d684bcc",
"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/66b06472782467d43d684bcb/",
"pkid": "66b06472782467d43d684bcb"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"66b06472782467d43d684bcb"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "66b06472782467d43d684bcb"
},
{
"data": {
"name": "Automate - Additional Admin Functions - Admin Tools",
"description": "General tools, file access and information",
"widgets": [
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 0,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Transaction Log",
"icon": "format_list_numbered",
"display": "list",
"type": "tool/Transaction"
},
{
"link_text": "Transactions Log Level Configuration",
"description": "Update the system settings ",
"icon": "settings_applications",
"display": "form",
"type": "view/DataSettings"
},
{
"link_text": "Bulk Load",
"icon": "cloud_upload",
"display": "form",
"type": "tool/BulkLoad"
},
{
"link_text": "Alerts",
"icon": "warning",
"display": "list",
"type": "data/Alert"
},
{
"link_text": "Import",
"icon": "arrow_upward",
"display": "form",
"type": "tool/DataImport",
"filter_options": [],
"configurable_options": []
},
{
"link_text": "Macro Evaluator",
"description": "Interface to test and/or run macros in the portal to see results",
"icon": "data_usage",
"display": "form",
"type": "tool/Macro"
}
],
"title": "General Tools"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 10,
"y": 0
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"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": "Africa/Johannesburg",
"title": "Files and Logs"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 0,
"y": 3
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Overbuild Overview",
"description": "Overview counts of service resources in the system and to see elements that may need to run through overbuild",
"icon": "view_comfy",
"display": "form",
"type": "view/OverbuildOverview"
},
{
"link_text": "Site Defaults",
"description": "View site default values to see and adjust overbuild settings for the site",
"icon": "business_center",
"display": "list",
"type": "data/SiteDefaultsDoc"
},
{
"link_text": "Run Overbuild",
"description": "Run the overbuild tool to move resources",
"icon": "play_arrow",
"display": "form",
"type": "view/EasyOverbuild"
},
{
"link_text": "Run Analogue Gateway Overbuild",
"description": "Run the analog gateway specific tool to move analog gateway resources",
"icon": "play_arrow",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/GS_AGW_overbuild_VIEW"
},
{
"link_text": "Run Dial-Plan Overbuild",
"description": "Run dial plan specific overbuild tool",
"icon": "play_arrow",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/MKI_DialPlan_Overbuild_View"
},
{
"link_text": "Dial-Plan Overbuild Search Queries",
"description": "Review the dial plan queries for overbuild",
"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
}
]
},
{
"link_text": "Fix User Phone Associate Tool",
"description": "Tool to run and fix user and phone association",
"icon": "build",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "form",
"type": "view/FixUserAssociateDevices"
},
{
"link_text": "Move user (without Services)",
"description": "Move User advanced feature to move user (without services) to a different hierarchy. If moving a user with services - use the Move User on the related user dashboards.",
"icon": "arrow_downward",
"display": "list",
"type": "view/HcsMoveUsersVIEW"
}
],
"title": "Overbuild Tools",
"condition": "(( fn.authorized_admin_allowed_hierarchy_level Customer == fn.true ))"
}
}
],
"pkid": "68937fad41f63fe774b6f12a",
"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 - Additional Admin Functions - Admin Tools",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5a7c462e1360b64cc8bf16e5",
"href": "/api/data/HierarchyNode/5a7c462e1360b64cc8bf16e5"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/",
"pkid": "68937fad41f63fe774b6f129"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"68937fad41f63fe774b6f129"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/68937fad41f63fe774b6f129/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "68937fad41f63fe774b6f129"
},
{
"data": {
"name": "Automate - Additional Admin Functions - Data Sync",
"description": "Manage data sync options for the various integrated UC apps",
"widgets": [
{
"alignmentData": {
"cols": 20,
"rows": 1,
"x": 0,
"y": 0
},
"type": "counters",
"modelType": "data/DashboardWidgetCounters",
"data": {
"title": "Schedule Status",
"datasource": "Automate",
"allowDatasourceSelection": true,
"_outputType": "highcharts",
"_limit": "20",
"_offset": "0",
"_groupingLimit": "0",
"type": 7,
"automate_counters": [
{
"title": "Active Schedules",
"icon": "schedule",
"type": "data/Schedule",
"filter_options": [
{
"filter_by": "active",
"operation": "equals",
"filterValue": "true"
}
]
},
{
"title": "Inactive Schedules",
"icon": "indeterminate_check_box",
"type": "data/Schedule",
"filter_options": [
{
"filter_by": "active",
"operation": "equals",
"filterValue": "false"
}
]
}
],
"drilldowns": {
"filterOption": "IN",
"drilldownOption": 0
}
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 0,
"y": 1
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "All Pull Syncs",
"icon": "sync",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "notcontain",
"filterValue": "Purge"
}
]
},
{
"link_text": "All Purge Syncs",
"description": "List of all Purge syncs in the system",
"icon": "warning",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "Purge"
}
]
},
{
"link_text": "Sync Scheduling",
"icon": "schedule",
"display": "list",
"type": "data/Schedule"
},
{
"link_text": "Model Type Lists",
"icon": "merge_type",
"display": "list",
"type": "data/ModelTypeList"
},
{
"link_text": "Model Instance Filters",
"icon": "filter_list",
"display": "list",
"type": "data/ModelInstanceFilter"
},
{
"link_text": "Bulk Schedule Activation / Deactivation",
"description": "Activate and Deactivate Schedules",
"icon": "history",
"display": "form",
"type": "view/BulkScheduleTool"
},
{
"link_text": "Default Sync Workflows",
"description": "These workflows apply generally to sync types regardless of the sync configuration",
"icon": "arrow_forward",
"display": "list",
"type": "data/DataSyncWorkflow"
}
],
"title": "General Data Sync Options"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 3,
"x": 10,
"y": 1
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"configuration_template": "HcsSyncUsersViewCFT",
"display": "form",
"icon": "sync",
"link_text": "Sync LDAP Users",
"type": "view/HcsSyncUsersVIEW"
},
{
"display": "form",
"icon": "sync_problem",
"link_text": "Resync LDAP Users",
"type": "view/ReSyncLdapUsersVIEW"
},
{
"configuration_template": "HcsAdUserSyncRelCFT",
"display": "list",
"field_display_policy": "HcsLdapUserSyncRelFDP",
"icon": "people",
"link_text": "LDAP User Sync",
"type": "relation/HcsLdapUserSyncREL"
},
{
"display": "list",
"filter_options": [
{
"filter_by": "name",
"filterValue": "HcsLdapUserPurge",
"operation": "startswith"
}
],
"icon": "warning",
"link_text": "LDAP User Purge (HcsLdapUserPurge filter)",
"type": "data/DataSync"
},
{
"display": "list",
"filter_options": [
{
"filter_by": "name",
"filterValue": "HcsLdapSchemaImport",
"operation": "startswith"
}
],
"icon": "text_fields",
"link_text": "LDAP Schema Import (HcsLdapSchemaImport filter)",
"type": "data/DataSync"
}
],
"title": "LDAP Data Syncs"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 2,
"x": 0,
"y": 4
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Cisco Webex Sync (SyncSpark filter)",
"icon": "sync",
"condition": "{{ macro.is_cisco_webex_teams_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "SyncSpark",
"ignore_case": true
}
]
},
{
"link_text": "Cisco Webex Purge (PurgeSpark filter)",
"icon": "warning",
"condition": "{{ macro.is_cisco_webex_teams_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "PurgeSpark",
"ignore_case": true
}
]
}
],
"title": "Cisco Webex Calling Data Syncs",
"condition": "{{ macro.is_cisco_webex_teams_enabled }}"
}
},
{
"alignmentData": {
"cols": 10,
"rows": 2,
"x": 10,
"y": 4
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Microsoft Apps Sync (SyncMS filter)",
"icon": "sync",
"condition": "{{ macro.is_microsoft_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "SyncMS"
}
]
},
{
"link_text": "Microsoft Apps Purge (PurgeMS filter)",
"icon": "warning",
"condition": "{{ macro.is_microsoft_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "PurgeMS"
}
]
}
],
"title": "Microsoft Data Syncs",
"description": "Microsoft filtered view of syncs",
"condition": "{{ macro.is_microsoft_enabled }}"
}
},
{
"alignmentData": {
"cols": 20,
"rows": 3,
"x": 0,
"y": 6
},
"type": "links",
"modelType": "data/DashboardWidgetLinks",
"data": {
"links": [
{
"link_text": "Cisco UC Apps Sync (HcsPull filter)",
"icon": "sync",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsPull"
}
]
},
{
"link_text": "Cisco CUCM User Sync (HcsUserSync filter)",
"icon": "sync",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsUserSync"
}
]
},
{
"link_text": "Cisco CUCM-CNF Sync (HcsCnf filter)",
"icon": "sync",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsCnf"
}
]
},
{
"link_text": "Cisco UC Apps Purge Sync (HcsPurge sync filter)",
"icon": "warning",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsPurge"
}
]
},
{
"link_text": "Cisco CUCM Phone Purge Sync (HcsPhonePurge filter)",
"icon": "warning",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsPhonePurge"
}
]
},
{
"link_text": "Cisco CUCM Phone Sync (HcsPhoneSync filter)",
"icon": "sync",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsPhoneSync"
}
]
},
{
"link_text": "Cisco CUCM-CNF Device Changes",
"icon": "settings_applications",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DeviceChanges"
},
{
"link_text": "Cisco CUCM User Purge Sync (HcsUserPurge filter)",
"icon": "warning",
"condition": "{{ macro.is_cisco_cucm_enabled }}",
"display": "list",
"type": "data/DataSync",
"filter_options": [
{
"filter_by": "name",
"operation": "contains",
"filterValue": "HcsUserPurge"
}
]
}
],
"title": "Cisco Data Syncs",
"description": "All Cisco UCM, CUC, Syncs",
"condition": "{{ macro.is_cisco_cucm_enabled }}"
}
}
],
"pkid": "68937fa741f63fe774b6f106",
"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 - Additional Admin Functions - Data Sync",
"business_key": {
"unique": [
"name"
],
"hierarchy": true
},
"api_version": "21.2",
"cached": true,
"references": {
"parent": [
{
"pkid": "5a7c462e1360b64cc8bf16e5",
"href": "/api/data/HierarchyNode/5a7c462e1360b64cc8bf16e5"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": [],
"owner": [
{
"pkid": ""
}
],
"self": [
{
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/",
"pkid": "68937fa741f63fe774b6f105"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"5a7c462e1360b64cc8bf16e5",
"68937fa741f63fe774b6f105"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/clone/?schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/import/",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/export/",
"support_async": false,
"title": "Export",
"view": "/api/view/ExportData/add/",
"submit": "payload"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/+tag/",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/"
}
},
{
"get": {
"method": "GET",
"class": "get",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/68937fa741f63fe774b6f105/help",
"support_async": false,
"title": "Help"
}
}
],
"summary": "false"
},
"pkid": "68937fa741f63fe774b6f105"
}
]
}
(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": "66b06472782467d43d684bcc"
},
"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/66b06472782467d43d684bcb/",
"pkid": "66b06472782467d43d684bcb"
}
]
},
"path": [
"6t0ggef2c0deab00hb595101",
"66b06472782467d43d684bcb"
],
"schema_version": "0.8",
"actions": [
{
"update": {
"method": "PUT",
"class": "update",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Modify"
}
},
{
"remove": {
"method": "DELETE",
"class": "delete",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Delete"
}
},
{
"clone": {
"method": "GET",
"class": "clone",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/clone/?hierarchy=[hierarchy]&schema=&schema_rules=true",
"support_async": false,
"title": "Clone"
}
},
{
"import": {
"method": "POST",
"class": "import",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/import/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Import"
}
},
{
"export": {
"method": "GET",
"class": "export",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/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/66b06472782467d43d684bcb/+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/66b06472782467d43d684bcb/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Get"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/data/Dashboard/66b06472782467d43d684bcb/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"pkid": "66b06472782467d43d684bcb"
}
| 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. |