PATCH DashTileDefinition/{id}

• 5 minutes to read
 • 5 minutes to read 
PATCH /api/v1/DashTileDefinition/{id}

Update a DashTileDefinition with changes, as described in a JSON Patch or a JSON Merge Patch document.

See RFC6902 and RFC 7396. NsApiSlow threshold: 5000 ms. Update the Department field to "foo" can be done either as a JSON PATCH:


[ { "op": "replace", "path": "/Department", "value": "foo" } ]

or as a JSON MERGE PATCH, which describes the change directly:


{ "Department": "foo" }

JSON PATCH supports operations 'add', 'replace', 'remove' and 'test'. The path is case insensitive, and the leading slash is optional, so the paths "/department", "Department" and "department" are all equivalent.

Calls the {SuperOffice.CRM.Services.IDashAgent} service SaveDashTileDefinition.

Path Part Type Description
id int32 The DashTileDefinition id to update. Required

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. 
PATCH /api/v1/DashTileDefinition/{id}?$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:
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: changes

JSON-Patch array of operations+path+value, or a MERGE-PATCH object (which will be converted to a list of JSON-PATCH operations).

Property Name Type Description
op String "add", "replace", "remove", "test" "move" and "copy" not supported
path String The property names to modify. "/users/0/email", "/users/-",
value Object New/Replaced value - string or object.

Response:

DashTileDefinition updated.

Response Description
200 DashTileDefinition updated.
404 DashTileDefinition with given id does not exist in the db.
409 Update blocked because a 'test' operation has detected a conflict with the entity value.
412 Update aborted because DashTileDefinition has changed since the requested If-Unmodified-Since timestamp.

Response body: DashTileDefinitionWithLinks

Property Name Type Description
DashboardTileDefinitionId int32 Primary key
Name string The name of the tile
Description string Detailed description
DefaultHeight int32 Default height when added to a dashboard
DefaultWidth int32 Default width when added to a dashboard
TileType string Dashboard tile type
EntityType string Dashboard entity type
EntityName string The entity measured by this tile, defines what provider to use
SelectionId int32 Selection holding the criterias for the tile definition
CurrencyMode string Dashboard currency mode
CurrencyCode string Currency code
Measure string Dashboard measure type (Count, Sum, Avg, etc.)
MeasureField string Field to be measured
SortBy string Sort by field
LayoutConfig string The JSON formatted layout config
SecondarySelectionId int32 Selection holding the replaced or changed criterias (period comparisons etc)
MeasureByField string Field to group by
Usage string Where this tile can be used
ProviderName string Name of provider to use with this entity type - read only property
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.
_Links object

Sample request

PATCH /api/v1/DashTileDefinition/{id}
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8

[
  {
    "op": "add",
    "path": "quo",
    "value": {}
  },
  {
    "op": "add",
    "path": "quo",
    "value": {}
  }
]

Sample response

HTTP/1.1 200 DashTileDefinition  updated.
Content-Type: application/json; charset=utf-8

{
  "DashboardTileDefinitionId": 487,
  "Name": "Sales Pipeline Chart",
  "Description": "Enterprise-wide context-sensitive flexibility",
  "DefaultHeight": 905,
  "DefaultWidth": 312,
  "TileType": "Area",
  "EntityType": "Appointment",
  "EntityName": "Price, Daniel and Hammes",
  "SelectionId": 694,
  "CurrencyMode": "Base",
  "CurrencyCode": "unde",
  "Measure": "Average",
  "MeasureField": "impedit",
  "SortBy": "et",
  "LayoutConfig": "et",
  "SecondarySelectionId": 235,
  "MeasureByField": "dolorem",
  "Usage": "Dashboard",
  "ProviderName": "Ankunding LLC",
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 579
    }
  },
  "_Links": {
    "Self": "https://www.example.com/api/v1/project/321",
    "Archive": "https://www.example.com/api/v1/project"
  }
}