POST Agents/Dash/CreateDefaultPreviewDash

• 2 minutes to read
 • 2 minutes to read 
POST /api/v1/Agents/Dash/CreateDefaultPreviewDash

Loading default values into a new PreviewDash.

NsApiSlow threshold: 5000 ms.

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: 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/CreateDefaultPreviewDash
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": 214,
  "Name": "Koelpin Inc and Sons",
  "Description": "Programmable eco-centric encoding",
  "OwnedByFullName": "Miss Shirley Morar",
  "Registered": "2009-09-19T02:30:47.0694635+02:00",
  "Tiles": [
    {
      "Name": "Metz, Kreiger and Block",
      "TileType": "Area",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 468
        }
      }
    },
    {
      "Name": "Metz, Kreiger and Block",
      "TileType": "Area",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 468
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 759
    }
  }
}