GET Dashboard/default

• 3 minutes to read
 • 3 minutes to read 
GET /api/v1/Dashboard/default

Set default values into a new Dashboard.

NetServer calculates default values on the entity, which is required when creating/storing a new instance Calls the Dashboard agent service CreateDefaultDashboard.

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:

OK

Response Description
200 OK

Response body: Dashboard

Property Name Type Description
DashboardId int32 The dashboard id
AssociateId int32 Id of the associate who owns this dashboard
Caption string The caption for this dashboard
Layout string The dashboard layout, how the tiles are organized on the screen
Tiles array The tiles associated with this dashboard
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

GET /api/v1/Dashboard/default
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en

Sample response

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

{
  "DashboardId": 113,
  "AssociateId": 291,
  "Caption": "nihil",
  "Layout": "Four",
  "Tiles": [
    {
      "DashboardTileId": 439,
      "Caption": "perferendis",
      "Description": "Up-sized attitude-oriented collaboration",
      "ChartName": "Kertzmann Inc and Sons",
      "ChartId": "saepe",
      "IsDefault": false,
      "AssociateId": 724,
      "GroupId": 703,
      "SelectionId": 324,
      "Config": "in",
      "Type": "Bignum",
      "EntityType": "Activity",
      "Options": [
        {},
        {}
      ],
      "VisibleFor": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 566
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 156
    }
  }
}