POST DashboardTile

Some tooltip text!

• 5 minutes to read

 • 5 minutes to read

POST /api/v1/DashboardTile

Creates a new DashboardTile

Calls the Dashboard agent service SaveDashboardTile.

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/DashboardTile?$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: newEntity

The DashboardTile to be saved.

Property Name	Type	Description
DashboardTileId	Integer	The tile id
Caption	String	The tile caption
Description	String	The tile description
ChartName	String	The original chart name
ChartId	String	The original chart Id
IsDefault	Boolean	True if this is one of the default tiles
AssociateId	Integer	Id of the associate who owns this tile
GroupId	Integer	Id of the associates primary group at storage time
SelectionId	Integer	The selection that defines the data filter/restrictions
Config	String	The tile config
Type	String	The tile type, what kind of tile this is
EntityType	String	The tile entity type
Options	Array	The tile options
VisibleFor	Array	The set of users or groups the record is visible for

Response:

OK

Response	Description
200	OK

Response body: DashboardTileWithLinks

Property Name	Type	Description
DashboardTileId	int32	The tile id
Caption	string	The tile caption
Description	string	The tile description
ChartName	string	The original chart name
ChartId	string	The original chart Id
IsDefault	bool	True if this is one of the default tiles
AssociateId	int32	Id of the associate who owns this tile
GroupId	int32	Id of the associates primary group at storage time
SelectionId	int32	The selection that defines the data filter/restrictions
Config	string	The tile config
Type	string	The tile type, what kind of tile this is
EntityType	string	The tile entity type
Options	array	The tile options
VisibleFor	array	The set of users or groups the record is visible for
TableRight	TableRight	The carrier's table right
FieldProperties	object	Field property dictionary mapping field names to field access rights.
_Links	object

Sample request

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

{
  "DashboardTileId": 826,
  "Caption": "debitis",
  "Description": "Extended national workforce",
  "ChartName": "Dickinson, Mann and Wuckert",
  "ChartId": "enim",
  "IsDefault": true,
  "AssociateId": 401,
  "GroupId": 281,
  "SelectionId": 891,
  "Config": "quas",
  "Type": "Bignum",
  "EntityType": "Activity",
  "Options": [
    {
      "Name": "Baumbach, Cremin and Quigley",
      "Description": "Ameliorated disintermediate matrices",
      "Type": "Boolean",
      "ListName": "Baumbach, Wyman and Ondricka",
      "ListItems": [
        {},
        {}
      ],
      "Value": "et",
      "DefaultDataOption": false
    }
  ],
  "VisibleFor": [
    {
      "VisibleId": 41,
      "Visibility": "All",
      "DisplayValue": "laudantium"
    },
    {
      "VisibleId": 41,
      "Visibility": "All",
      "DisplayValue": "laudantium"
    }
  ]
}

Sample response

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

{
  "DashboardTileId": 48,
  "Caption": "ratione",
  "Description": "Persevering actuating software",
  "ChartName": "Mitchell LLC",
  "ChartId": "aspernatur",
  "IsDefault": false,
  "AssociateId": 971,
  "GroupId": 561,
  "SelectionId": 62,
  "Config": "eveniet",
  "Type": "Bignum",
  "EntityType": "Activity",
  "Options": [
    {
      "Name": "Bergstrom LLC",
      "Description": "Focused multi-state Graphical User Interface",
      "Type": "Boolean",
      "ListName": "Kiehn-Rempel",
      "ListItems": [
        {},
        {}
      ],
      "Value": "quam",
      "DefaultDataOption": true,
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.String",
          "FieldLength": 509
        }
      }
    }
  ],
  "VisibleFor": [
    {
      "VisibleId": 736,
      "Visibility": "All",
      "DisplayValue": "nobis",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 154
        }
      }
    },
    {
      "VisibleId": 736,
      "Visibility": "All",
      "DisplayValue": "nobis",
      "TableRight": null,
      "FieldProperties": {
        "fieldName": {
          "FieldRight": null,
          "FieldType": "System.Int32",
          "FieldLength": 154
        }
      }
    }
  ],
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 287
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/contact/321",
    "Archive": "https://www.example.com/api/v1/contact"
  }
}