Get grid configuration by grid key
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.
Path Parameters
Unique logical identifier for the grid (ui_grid.grid_key).
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/ui-config/grid/search/by-grid-key/traditional-toxicity-results"{ "gridId": 0, "gridKey": "string", "gridName": "string", "description": "string", "datasetKey": "string", "versionNo": 0, "status": "string", "isActive": true, "paginationEnabled": true, "pageSizeDefault": 0, "pageSizeMax": 0, "rowSelectionMode": "string", "defaultSortEnabled": true, "groupDisplayType": "string", "detailGridKey": "string", "detailGrid": {}, "columns": [ { "gridColumnId": 0, "fieldName": "string", "headerName": "string", "displayOrder": 0, "dataType": "string", "visibleDefault": true, "sortable": true, "resizable": true, "filterable": true, "filterType": "string", "width": 0, "minWidth": 0, "maxWidth": 0, "flex": 0, "pinned": "string", "editable": true, "wrapText": true, "autoHeight": true, "rowGroup": true, "rowGroupIndex": 0, "sortDefaultDirection": "string", "sortDefaultOrder": 0, "tooltipField": "string", "headerTooltip": "string", "exportLabel": "string", "isActive": true } ]}Create one or more columns for an existing grid POST
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.
Get all UI help content records GET
Returns all help content records from ui.ui_help_content, ordered by lookup_key. The frontend loads this at startup and resolves tooltip or panel help by lookupKey. Returns an empty array when no records are configured.