GET api/users/current/dashboardsheets-with-widgets

Gets a collection of DashboardSheets with their related Widgets.



Request Information

URI Parameters

None.



Body Parameters

None.



Response Information

Resource Description

A collection of ReadDashboardSheetViewModel representing the requested DashboardSheets.

Collection of ReadDashboardSheetViewModel

NameDescriptionTypeAdditional information
BackgroundColor

string

None.

BackgroundImage

string

None.

Id

integer

None.

Name

string

None.

Order

integer

None.

Synchronize

boolean

None.

UserWidgetConfigurations

Collection of ReadBaseWidgetConfigurationViewModel

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "UserWidgetConfigurations": null,
    "BackgroundColor": "sample string 1",
    "BackgroundImage": "sample string 2",
    "Id": 3,
    "Name": "sample string 4",
    "Order": 5,
    "Synchronize": true
  },
  {
    "UserWidgetConfigurations": null,
    "BackgroundColor": "sample string 1",
    "BackgroundImage": "sample string 2",
    "Id": 3,
    "Name": "sample string 4",
    "Order": 5,
    "Synchronize": true
  }
]

application/xml, text/xml

Sample:
<ArrayOfReadDashboardSheetViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <ReadDashboardSheetViewModel>
    <BackgroundColor>sample string 1</BackgroundColor>
    <BackgroundImage>sample string 2</BackgroundImage>
    <Id>3</Id>
    <Name>sample string 4</Name>
    <Order>5</Order>
    <Synchronize>true</Synchronize>
    <UserWidgetConfigurations xmlns:d3p1="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Widgets" i:nil="true" />
  </ReadDashboardSheetViewModel>
  <ReadDashboardSheetViewModel>
    <BackgroundColor>sample string 1</BackgroundColor>
    <BackgroundImage>sample string 2</BackgroundImage>
    <Id>3</Id>
    <Name>sample string 4</Name>
    <Order>5</Order>
    <Synchronize>true</Synchronize>
    <UserWidgetConfigurations xmlns:d3p1="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Widgets" i:nil="true" />
  </ReadDashboardSheetViewModel>
</ArrayOfReadDashboardSheetViewModel>