Back

GET dashboards

Returns a list of all dashboards accessible for the current user. PM

Request Information

URI Parameters

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList

None.

Body Parameters

None.

Response Information

Resource Description (Dashboards)

System.Collections.ObjectModel.Collection`1[Connections.API.Areas.HelpPage.ModelDescriptions.ParameterDescription] IList
ID globally unique identifier ReadOnly

ID of the given dashboard.
Site_ID globally unique identifier ReadOnly

ID of the site for the given dashboard.
RowType integer ReadOnly

Rowy type (organization = 4, department = 56, individual = 39) for the type of given dashboard: .
Name string ReadOnly

Name of the given dashboard.
Importance integer ReadOnly

Importance level of the given dashboard.

Response Formats

application/xml, text/xml

Sample
<Dashboards xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://col4.com/api/v4">
  <ID>8bec82ce-4d6f-4340-899e-e51fee176dfa</ID>
  <Importance>4</Importance>
  <Name>sample string 3</Name>
  <RowType>2</RowType>
  <Site_ID>119cef8f-e3e0-45f8-9f8b-8ec1cb0efbbd</Site_ID>
</Dashboards>

application/json, text/json

Sample
{
  "ID": "8bec82ce-4d6f-4340-899e-e51fee176dfa",
  "Site_ID": "119cef8f-e3e0-45f8-9f8b-8ec1cb0efbbd",
  "RowType": 2,
  "Name": "sample string 3",
  "Importance": 4
}