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

Create a grid configuration

POST
/ui-config/grid

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

Request Body

application/json

Grid configuration to create.

Request body for creating a new UI grid configuration.

gridKey?string

Unique logical identifier for the grid. Must not already exist.

gridName?string

Human-readable name of the grid.

description?string

Optional description of the grid purpose.

datasetKey?string

Reference key identifying the data source or dataset contract.

versionNo?integer

Version number of the grid definition. Defaults to 1.

Formatint32
status?string

Lifecycle status of the grid. Must be DRAFT, PUBLISHED, or RETIRED.

isActive?boolean

Indicates whether the grid definition is active. Defaults to true.

paginationEnabled?boolean

Indicates whether pagination is enabled. Defaults to true.

pageSizeDefault?integer

Default number of rows per page. Must be greater than 0. Defaults to 25.

Formatint32
pageSizeMax?integer

Maximum allowed rows per page. Must be >= pageSizeDefault. Defaults to 500.

Formatint32
rowSelectionMode?string

Row selection behavior. Must be single, multiple, or none.

defaultSortEnabled?boolean

Indicates whether default sorting is applied. Defaults to false.

groupDisplayType?string

Row grouping display behavior. Must be singleColumn, multipleColumns, or groupRows.

detailGridKey?string

Optional grid_key of the detail grid for master-detail layouts. Must reference an existing grid and must not equal gridKey.

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/ui-config/grid" \  -H "Content-Type: application/json" \  -d '{}'
{  "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    }  ]}

Get exposure-use executive summary by CIChem ID GET

Returns an executive summary of exposure-use data for a given Chemical Insights Registry of Chemicals Identifier. The summary includes aggregated counts across multiple data sources: - Product Use Categories - CDR Consumer Categories - CDR NAICS Codes - Products - Reported Functions - Predicted Functions (probability > 0.9) - List Presence Keywords Results are ordered by display_order for consistent UI presentation.

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.