GET Api/Dashboards/GetDashboards

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DashboardDto

Name	Type	Additional information
DashboardId	integer	None.
OrganizationalUnitId	integer	None.
Roles	string	None.
AuthorId	string	None.
IsPublic	boolean	None.
Title	string	None.
Sequence	integer	None.
Location	DashboardLocationEnum	None.
LanguageId	integer	None.
Elements	Collection of DashboardPartDto	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "dashboardId": 1,
    "organizationalUnitId": 1,
    "roles": "sample string 2",
    "authorId": "sample string 3",
    "isPublic": true,
    "title": "sample string 5",
    "sequence": 6,
    "location": 0,
    "languageId": 1,
    "elements": [
      {
        "dashboardPartId": 1,
        "dashboardId": 2,
        "widgetType": "sample string 3",
        "settings": "sample string 4",
        "posX": 5,
        "posY": 6,
        "width": 7,
        "height": 8
      },
      {
        "dashboardPartId": 1,
        "dashboardId": 2,
        "widgetType": "sample string 3",
        "settings": "sample string 4",
        "posX": 5,
        "posY": 6,
        "width": 7,
        "height": 8
      }
    ]
  },
  {
    "dashboardId": 1,
    "organizationalUnitId": 1,
    "roles": "sample string 2",
    "authorId": "sample string 3",
    "isPublic": true,
    "title": "sample string 5",
    "sequence": 6,
    "location": 0,
    "languageId": 1,
    "elements": [
      {
        "dashboardPartId": 1,
        "dashboardId": 2,
        "widgetType": "sample string 3",
        "settings": "sample string 4",
        "posX": 5,
        "posY": 6,
        "width": 7,
        "height": 8
      },
      {
        "dashboardPartId": 1,
        "dashboardId": 2,
        "widgetType": "sample string 3",
        "settings": "sample string 4",
        "posX": 5,
        "posY": 6,
        "width": 7,
        "height": 8
      }
    ]
  }
]

multipart/form-data

Sample:

[{"dashboardId":1,"organizationalUnitId":1,"roles":"sample string 2","authorId":"sample string 3","isPublic":true,"title":"sample string 5","sequence":6,"location":0,"languageId":1,"elements":[{"dashboardPartId":1,"dashboardId":2,"widgetType":"sample string 3","settings":"sample string 4","posX":5,"posY":6,"width":7,"height":8},{"dashboardPartId":1,"dashboardId":2,"widgetType":"sample string 3","settings":"sample string 4","posX":5,"posY":6,"width":7,"height":8}]},{"dashboardId":1,"organizationalUnitId":1,"roles":"sample string 2","authorId":"sample string 3","isPublic":true,"title":"sample string 5","sequence":6,"location":0,"languageId":1,"elements":[{"dashboardPartId":1,"dashboardId":2,"widgetType":"sample string 3","settings":"sample string 4","posX":5,"posY":6,"width":7,"height":8},{"dashboardPartId":1,"dashboardId":2,"widgetType":"sample string 3","settings":"sample string 4","posX":5,"posY":6,"width":7,"height":8}]}]

application/xml, text/xml

Sample:

<ArrayOfDashboardDto xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <DashboardDto>
    <DashboardId>1</DashboardId>
    <OrganizationalUnitId>1</OrganizationalUnitId>
    <Roles>sample string 2</Roles>
    <AuthorId>sample string 3</AuthorId>
    <IsPublic>true</IsPublic>
    <Title>sample string 5</Title>
    <Sequence>6</Sequence>
    <Location>Home</Location>
    <LanguageId>1</LanguageId>
    <Elements>
      <DashboardPartDto>
        <DashboardPartId>1</DashboardPartId>
        <DashboardId>2</DashboardId>
        <WidgetType>sample string 3</WidgetType>
        <Settings>sample string 4</Settings>
        <PosX>5</PosX>
        <PosY>6</PosY>
        <Width>7</Width>
        <Height>8</Height>
      </DashboardPartDto>
      <DashboardPartDto>
        <DashboardPartId>1</DashboardPartId>
        <DashboardId>2</DashboardId>
        <WidgetType>sample string 3</WidgetType>
        <Settings>sample string 4</Settings>
        <PosX>5</PosX>
        <PosY>6</PosY>
        <Width>7</Width>
        <Height>8</Height>
      </DashboardPartDto>
    </Elements>
  </DashboardDto>
  <DashboardDto>
    <DashboardId>1</DashboardId>
    <OrganizationalUnitId>1</OrganizationalUnitId>
    <Roles>sample string 2</Roles>
    <AuthorId>sample string 3</AuthorId>
    <IsPublic>true</IsPublic>
    <Title>sample string 5</Title>
    <Sequence>6</Sequence>
    <Location>Home</Location>
    <LanguageId>1</LanguageId>
    <Elements>
      <DashboardPartDto>
        <DashboardPartId>1</DashboardPartId>
        <DashboardId>2</DashboardId>
        <WidgetType>sample string 3</WidgetType>
        <Settings>sample string 4</Settings>
        <PosX>5</PosX>
        <PosY>6</PosY>
        <Width>7</Width>
        <Height>8</Height>
      </DashboardPartDto>
      <DashboardPartDto>
        <DashboardPartId>1</DashboardPartId>
        <DashboardId>2</DashboardId>
        <WidgetType>sample string 3</WidgetType>
        <Settings>sample string 4</Settings>
        <PosX>5</PosX>
        <PosY>6</PosY>
        <Width>7</Width>
        <Height>8</Height>
      </DashboardPartDto>
    </Elements>
  </DashboardDto>
</ArrayOfDashboardDto>