PUT api/dashboardsheets/{dashboardSheetId}

Updates a specific DashboardSheet.



Request Information

URI Parameters

NameDescriptionTypeAdditional information
dashboardSheetId

The id of the DashboardSheet to update.

integer

Required



Body Parameters

A model containing the properties to update.

UpdateDashboardSheetViewModel
NameDescriptionTypeAdditional information
Name

string

None.

Order

integer

None.

Synchronize

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Name": "sample string 1",
  "Order": 2,
  "Synchronize": true
}

application/xml, text/xml

Sample:
<UpdateDashboardSheetViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <Name>sample string 1</Name>
  <Order>2</Order>
  <Synchronize>true</Synchronize>
</UpdateDashboardSheetViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.



Response Information

Resource Description

A task representing the asynchronous operation to execute.

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
}

application/xml, text/xml

Sample:
<ReadDashboardSheetViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels">
  <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:d2p1="http://schemas.datacontract.org/2004/07/VobeSoft.Models.ViewModels.Widgets" i:nil="true" />
</ReadDashboardSheetViewModel>