POST api/v1/Dashboard/GetDefinitionList

Get the list of available dashboard definitions

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of DashboardDefinition
NameDescriptionTypeAdditional information
Name

Name of the Dashboard definition

string

None.

DashboardDefinitionId

Id of the Dashboard definition

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "DashboardDefinitionId": "a5dc507f-a23d-4b60-b5a3-2f892c2ccb08"
  },
  {
    "Name": "sample string 1",
    "DashboardDefinitionId": "a5dc507f-a23d-4b60-b5a3-2f892c2ccb08"
  }
]

application/xml, text/xml

Sample:
<ArrayOfDashboardDefinition xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Dashboard">
  <DashboardDefinition>
    <DashboardDefinitionId>a5dc507f-a23d-4b60-b5a3-2f892c2ccb08</DashboardDefinitionId>
    <Name>sample string 1</Name>
  </DashboardDefinition>
  <DashboardDefinition>
    <DashboardDefinitionId>a5dc507f-a23d-4b60-b5a3-2f892c2ccb08</DashboardDefinitionId>
    <Name>sample string 1</Name>
  </DashboardDefinition>
</ArrayOfDashboardDefinition>