Skip to main content

/Data/GetDashboard/:dashboardName

Retrieves the definition of the given dashboard.

Request Method

GET

URL Parameters

dashboardName

Full name of the dashboard.

Request Body Details

The request body is ignored.

Example Request

Example Response

{
  "Info": {
    "Error": "",
    "DashboardName": "Listing with Filters.dashboard"
  },
  "Result": {
    "name": "Listing with Filters",
    "fullName": "Listing with Filters.dashboard",
    "description": "",
    "title": "",
    "canModify": 1,
    "widgets": [
      {
        "name": "Widget1",
        "type": "pivot",
        "subtype": "pivot",
        "title": "",
        "dataSource": "Use in Dashboards/Patients Listing.pivot",
        "localDataSource": "",
        "drillDownDataSource": "",
        "width": 699,
        "height": 690,
        "sidebarContent": "",
        "showSidebar": 0,
        "sidebarWidth": "",
        "showToolbar": 1,
        "showToolbarBottomBorder": 1,
        "showToolbarOnlyWhenMaximized": 0,
        "colorToolbar": "#F0F0F0",
        "opacityToolbar": 1,
        "opacity": 1,
        "backgroundColor": "#F0F0F0",
        "theme": "",
        "subtypeClass": "",
        "controls": [
          {
            "name": "",
            "action": "applyFilter",
            "target": "*",
            "targetProperty": "[DiagD].[H1].[Diagnoses]",
            "targetPropertyDisplay": "",
            "type": "auto",
            "location": "widget",
            "controlClass": "",
            "timeout": "",
            "label": "Diagnoses",
            "title": "",
            "value": "",
            "valueRequired": 0,
            "text": "",
            "valueList": "",
            "displayList": "",
            "size": "",
            "readOnly": 0,
            "activeWhen": ""
          },
          {
            "name": "",
            "action": "applyFilter",
            "target": "*",
            "targetProperty": "[DiagD].[H1].[Diagnoses]",
            "targetPropertyDisplay": "",
            "type": "auto",
            "location": "widget",
            "controlClass": "",
            "timeout": "",
            "label": "Diagnoses",
            "title": "",
            "value": "",
            "valueRequired": 0,
            "text": "",
            "valueList": "",
            "displayList": "",
            "size": "",
            "readOnly": 0,
            "activeWhen": ""
          },
          {
            "name": "",
            "action": "applyFilter",
            "target": "*",
            "targetProperty": "[DiagD].[H1].[Diagnoses]",
            "targetPropertyDisplay": "",
            "type": "auto",
            "location": "widget",
            "controlClass": "",
            "timeout": "",
            "label": "Diagnoses",
            "title": "",
            "value": "",
            "valueRequired": 0,
            "text": "",
            "valueList": "",
            "displayList": "",
            "size": "",
            "readOnly": 0,
            "activeWhen": ""
          }
        ],
        "properties": {
          "analyzer": "0"
        }
      }
    ]
  }
}
Purpose of this instance: Draft documentation
DocReleaseID: IRIS2025.1
Content loaded from:
/staging/learning/iris-doc/2025.1.x/doc/cache/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/ensemble/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/security/en-us/src/
/staging/learning/iris-doc/2025.1.x/doc/iris/en-us/src/
Excluded items: EAST, EDICOM, EHL72, EHL7T, HXHCINST, HXHCRN, HXIHINST, HXIHRN, PAGE_healthcare
FeedbackOpens in a new tab