Chemical Insights API
Chemical InsightsUL Research Institutes
HomeAPI ReferenceSDKsContext Plugin
Grid Config

Create one or more columns for an existing grid

POST
/ui-config/grid/{gridKey}/columns

Creates column definitions in ui.ui_grid_column for the given grid. Accepts a non-empty array of column definitions. All columns are validated before any are inserted (all-or-nothing). fieldName, displayOrder, and rowGroupIndex must be unique within the submitted array and across existing columns.

Path Parameters

gridKey*string

Unique logical identifier for the parent grid.

Request Body

application/json

Non-empty array of column definitions to create.

[index: integer]?

Request body for creating a new column definition for a UI grid.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/ui-config/grid/study-results/columns" \  -H "Content-Type: application/json" \  -d '[    {}  ]'
[  {    "gridColumnId": 0,    "fieldName": "string",    "headerName": "string",    "displayOrder": 0,    "isActive": true  }]

Create a grid configuration POST

Creates a new grid record in ui.ui_grid. Returns the created grid with an empty columns list.

Get grid configuration by grid key GET

Returns the grid configuration including ordered active column definitions for the given unique grid key. Only active grids and active columns are returned. Columns are ordered by display order. When detailGridKey is set, the detail grid is loaded and included one level deep.