POST Agents/Dashboard/SetTile

• 3 minutes to read
 • 3 minutes to read 
POST /api/v1/Agents/Dashboard/SetTile

Sets tile in the given dashboard position

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/Dashboard/SetTile?$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, TileId, Position

Property Name Type Description
DashboardId Integer
TileId Integer
Position Integer

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

POST /api/v1/Agents/Dashboard/SetTile
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: sv
Content-Type: application/json; charset=utf-8

{
  "DashboardId": 201,
  "TileId": 96,
  "Position": 443
}

Sample response

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

{
  "DashboardId": 597,
  "AssociateId": 777,
  "Caption": "aut",
  "Layout": "Four",
  "Tiles": [
    {
      "DashboardTileId": 629,
      "Caption": "incidunt",
      "Description": "Expanded explicit model",
      "ChartName": "Lockman, Fay and Daniel",
      "ChartId": "et",
      "IsDefault": false,
      "AssociateId": 851,
      "GroupId": 464,
      "SelectionId": 220,
      "Config": "et",
      "Type": "Bignum",
      "EntityType": "Activity",
      "Options": [
        {},
        {}
      ],
      "VisibleFor": [
        {},
        {}
      ],
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 566
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 210
    }
  }
}