GET Dash/{id}

Some tooltip text!

• 3 minutes to read

 • 3 minutes to read

GET /api/v1/Dash/{id}

Gets a Dash object.

Calls the Dash agent service GetDash. NsApiSlow threshold: 5000 ms.

Path Part	Type	Description
id	int32	The id of the Dash to return. Required

Query String Parameters

Parameter Name	Type	Description
$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.

GET /api/v1/Dash/{id}?$select=name,department,category/id

Request Headers

Parameter Name	Description
Authorization	Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN	If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept	Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language	Convert string references and multi-language values into a specified language (iso2) code.
SO-Language	Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture	Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone	Specify the timezone code that you would like date/time responses converted to.
SO-AppToken	The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

Dash found.

Response	Description
200	Dash found.
404	Not Found.

Response body: DashWithLinks

Property Name	Type	Description
DashboardId	int32	Primary key
UniqueId	string	GUID identifying a default dashboard from SuperOffice
Name	string	The name of this dashboard
Description	string	Detailed description
AssociateId	int32	Associate who owns this dashboard
Columns	int32	How many columns there will be in the dashboard.
Theme	DashTheme	The theme for this dashboard
VisibleForAll	int32	True if visible for all
VisibleForAssociates	array	Array of references to the visible for associates
VisibleForGroups	array	Array of references to the visible for groups
PinForAll	int32	True if pinned for all
PinForAssociates	array	Array of references to the pinned associates
PinForGroups	array	Array of references to the pinned groups
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

GET /api/v1/Dash/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

HTTP/1.1 200 Dash found.
Content-Type: application/json; charset=utf-8

{
  "DashboardId": 391,
  "UniqueId": "ut",
  "Name": "Sales Dashboard",
  "Description": "Dashboard for sales metrics",
  "AssociateId": 233,
  "Columns": 477,
  "Theme": null,
  "VisibleForAll": 18,
  "VisibleForAssociates": [
    148,
    549
  ],
  "VisibleForGroups": [
    240,
    406
  ],
  "PinForAll": 846,
  "PinForAssociates": [
    271,
    369
  ],
  "PinForGroups": [
    810,
    524
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 984
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}