POST Agents/Dash/GetPreviewDash

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Dash/GetPreviewDash

Get a dashboard from its id

NsApiSlow threshold: 5000 ms.

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. 
POST /api/v1/Agents/Dash/GetPreviewDash?$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
Content-Type Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json
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.

Request Body: request

DashboardId

Property Name Type Description
DashboardId Integer

Response:

OK

Response Description
200 OK

Response body: PreviewDash

Property Name Type Description
DashboardId int32 Primary key
Name string The name of this dashboard
Description string Detailed description
OwnedByFullName string Full name of dashboard owner
Registered date-time Registered when in UTC.
Tiles array Dashboard tiles
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/Agents/Dash/GetPreviewDash
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

{
  "DashboardId": 567
}

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "DashboardId": 980,
  "Name": "McCullough, Cremin and Veum",
  "Description": "Ergonomic discrete database",
  "OwnedByFullName": "Elvie Ward PhD",
  "Registered": "2007-07-18T02:30:47.0694635+02:00",
  "Tiles": [
    {
      "Name": "Wehner, Bergstrom and Blick",
      "TileType": "Area",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 147
        }
      }
    },
    {
      "Name": "Wehner, Bergstrom and Blick",
      "TileType": "Area",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 147
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 283
    }
  }
}