POST v2/grid/{gridID}/settings/save

Save Grid User Settings

Request Information

URI Parameters

Name	Description	Type	Additional information
gridID		integer	Required

Body Parameters

GridSettingsModel

Name	Type	Additional information
Sort	string	None.
SortDirection	string	None.
Columns	Collection of GridColumnModel	None.
Filters	Collection of GridFilterModel	None.

Request Formats

application/json, text/json

Sample:

{
  "sort": "sample string 1",
  "sortDirection": "sample string 2",
  "columns": [
    {
      "columnOrder": 1,
      "columnHeader": "sample string 2",
      "fieldName": "sample string 3",
      "width": 4,
      "format": "sample string 5",
      "isHidden": true,
      "isFrozenLeft": true,
      "isFrozenRight": true
    },
    {
      "columnOrder": 1,
      "columnHeader": "sample string 2",
      "fieldName": "sample string 3",
      "width": 4,
      "format": "sample string 5",
      "isHidden": true,
      "isFrozenLeft": true,
      "isFrozenRight": true
    }
  ],
  "filters": [
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    },
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    }
  ]
}

Response Information

Resource Description

GridSettingsModel

Name	Type	Additional information
Sort	string	None.
SortDirection	string	None.
Columns	Collection of GridColumnModel	None.
Filters	Collection of GridFilterModel	None.

Response Formats

application/json, text/json

Sample:

{
  "sort": "sample string 1",
  "sortDirection": "sample string 2",
  "columns": [
    {
      "columnOrder": 1,
      "columnHeader": "sample string 2",
      "fieldName": "sample string 3",
      "width": 4,
      "format": "sample string 5",
      "isHidden": true,
      "isFrozenLeft": true,
      "isFrozenRight": true
    },
    {
      "columnOrder": 1,
      "columnHeader": "sample string 2",
      "fieldName": "sample string 3",
      "width": 4,
      "format": "sample string 5",
      "isHidden": true,
      "isFrozenLeft": true,
      "isFrozenRight": true
    }
  ],
  "filters": [
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    },
    {
      "columnName": "sample string 1",
      "operator": "sample string 2",
      "searchValue": "sample string 3",
      "combinationLogic": "sample string 4"
    }
  ]
}