PUT api/ClientDashboard/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

CustomClientDashboard
NameDescriptionTypeAdditional information
ClientDashboardMasterID

globally unique identifier

None.

Name

string

None.

Description

string

None.

ReportID

string

None.

WorkSpaceID

string

None.

Categories

Collection of Category

None.

ClientID

globally unique identifier

None.

ClientName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClientDashboardMasterID": "aa4e7d60-8a3e-4675-88da-828d5553a81b",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "ReportID": "sample string 4",
  "WorkSpaceID": "sample string 5",
  "Categories": [
    {
      "CategoryName": "sample string 1",
      "CategoryID": "9d4e14c7-3b83-4911-b789-b5965314d074"
    },
    {
      "CategoryName": "sample string 1",
      "CategoryID": "9d4e14c7-3b83-4911-b789-b5965314d074"
    }
  ],
  "ClientID": "6be77448-e917-46f1-8cf0-80c301d9ffe7",
  "ClientName": "sample string 7"
}

application/xml, text/xml

Sample:
<CustomClientDashboard xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IRAApi.CustomModel">
  <Categories>
    <Category>
      <CategoryID>9d4e14c7-3b83-4911-b789-b5965314d074</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
    <Category>
      <CategoryID>9d4e14c7-3b83-4911-b789-b5965314d074</CategoryID>
      <CategoryName>sample string 1</CategoryName>
    </Category>
  </Categories>
  <ClientDashboardMasterID>aa4e7d60-8a3e-4675-88da-828d5553a81b</ClientDashboardMasterID>
  <ClientID>6be77448-e917-46f1-8cf0-80c301d9ffe7</ClientID>
  <ClientName>sample string 7</ClientName>
  <Description>sample string 3</Description>
  <Name>sample string 2</Name>
  <ReportID>sample string 4</ReportID>
  <WorkSpaceID>sample string 5</WorkSpaceID>
</CustomClientDashboard>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.