GET api/dashboardsheets/{dashboardSheetId}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
dashboardSheetId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ReadDashboardSheetViewModelName | Description | Type | Additional information |
---|---|---|---|
BackgroundColor | string |
None. |
|
BackgroundImage | string |
None. |
|
HasTemplate | boolean |
None. |
|
IsReadOnly | boolean |
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", "HasTemplate": true, "IsReadOnly": true, "Id": 5, "Name": "sample string 6", "Order": 7, "Synchronize": true }
application/xml, text/xml
Sample:
<ReadDashboardSheetViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels"> <BackgroundColor>sample string 1</BackgroundColor> <BackgroundImage>sample string 2</BackgroundImage> <HasTemplate>true</HasTemplate> <Id>5</Id> <IsReadOnly>true</IsReadOnly> <Name>sample string 6</Name> <Order>7</Order> <Synchronize>true</Synchronize> <UserWidgetConfigurations xmlns:d2p1="http://schemas.datacontract.org/2004/07/VobeSoft.Shared.Models.ViewModels.Widgets" i:nil="true" /> </ReadDashboardSheetViewModel>