Skip to main content
Get Dash

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

dashId
integer<int32>
required

The identifier of the Dash object

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Response

OK

Dashboard configuration Carrier object for Dash. Services for the Dash Carrier is available from the Dash Agent.

DashboardId
integer<int32>

Primary key

UniqueId
string

GUID identifying a default dashboard from SuperOffice

Name
string

The name of this dashboard

Description
string

Detailed description

AssociateId
integer<int32>

Associate who owns this dashboard

Columns
integer<int32>

How many columns there will be in the dashboard.

Theme
object

Dashboard theme configuration Carrier object for DashTheme. Services for the DashTheme Carrier is available from the Dash Agent.

VisibleForAll
integer<int32>

True if visible for all

VisibleForAssociates
integer<int32>[]

Array of references to the visible for associates

VisibleForGroups
integer<int32>[]

Array of references to the visible for groups

PinForAll
integer<int32>

True if pinned for all

PinForAssociates
integer<int32>[]

Array of references to the pinned associates

PinForGroups
integer<int32>[]

Array of references to the pinned groups

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.