POST Agents/Dash/SaveDash

• 4 minutes to read
 • 4 minutes to read 
POST /api/v1/Agents/Dash/SaveDash

Updates the existing Dash or creates a new Dash if the id parameter is empty

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: entity

The Dash to be saved.

Property Name Type Description
DashboardId Integer Primary key
UniqueId String GUID identifying a default dashboard from SuperOffice
Name String The name of this dashboard
Description String Detailed description
AssociateId Integer Associate who owns this dashboard
Columns Integer How many columns there will be in the dashboard.
Theme DashTheme The theme for this dashboard
VisibleForAll Integer 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 Integer True if pinned for all
PinForAssociates Array Array of references to the pinned associates
PinForGroups Array Array of references to the pinned groups

Response:

OK

Response Description
200 OK

Response body: Dash

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.

Sample request

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

{
  "DashboardId": 293,
  "UniqueId": "nobis",
  "Name": "Kutch-Gerlach",
  "Description": "Upgradable client-driven architecture",
  "AssociateId": 142,
  "Columns": 562,
  "Theme": null,
  "VisibleForAll": 111,
  "VisibleForAssociates": [
    884,
    46
  ],
  "VisibleForGroups": [
    710,
    50
  ],
  "PinForAll": 260,
  "PinForAssociates": [
    289,
    827
  ],
  "PinForGroups": [
    415,
    167
  ]
}

Sample response

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

{
  "DashboardId": 513,
  "UniqueId": "et",
  "Name": "Predovic Group",
  "Description": "Face to face holistic encoding",
  "AssociateId": 601,
  "Columns": 262,
  "Theme": null,
  "VisibleForAll": 587,
  "VisibleForAssociates": [
    54,
    717
  ],
  "VisibleForGroups": [
    675,
    156
  ],
  "PinForAll": 442,
  "PinForAssociates": [
    276,
    112
  ],
  "PinForGroups": [
    815,
    419
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.String",
      "FieldLength": 543
    }
  }
}