Get Api Client Grid
API EndPoint : getApiClientGrid
This API returns the configuration and metadata required to render a grid (table) in the client UI. It provides column definitions, display settings, grid-specific options, and references for data sources.
HTTP Method
GET
API URL
https://localhost:8066/api/json/ncmclient/getApiClientGrid?gridId="Devices"&gridTableId=101&apiKey=********Parameters
| Param Name | Description | Data Type | Regex | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your server. | - | - | Yes |
| gridId | The unique ID of the grid configuration to fetch. | - | [p{L}p{N}-_s]+ | yes |
| gridTableId | The table identifier, used for referencing the grid instance. | - | [p{L}p{N}-_s]+ | No |
Sample Response
HTTP Code: 200
{
"dataUrl": "",
"listcolNamesList": [],
"colModelList": [
{
"formatter": "",
"search": "",
"hidden": true,
"displayName": "",
"classes": "",
"searchtype": "",
"hidedlg": true,
"name": "id",
"index": "id",
"sortable": ""
},
{
"formatter": "credentialFormatter1",
"search": false,
"hidden": false,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "CRED_VALIDITY",
"width": 60,
"index": "CRED_VALIDITY",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "VALIDITY",
"index": "VALIDITY",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "",
"searchtype": "",
"hidedlg": true,
"name": "PROTOCOL_DISPLAYNAME",
"index": "PROTOCOL_DISPLAYNAME",
"sortable": ""
},
{
"formatter": "",
"search": "",
"hidden": true,
"displayName": "",
"classes": "",
"searchtype": "",
"hidedlg": true,
"name": "MANAGED",
"index": "NCMManagedStateHolder__MANAGED",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "BACKUP_STATUS",
"index": "NCMBackupStateHolder__BACKUP_STATUS",
"sortable": ""
},
{
"formatter": "hostNameFormat",
"search": "",
"hidden": false,
"displayName": "jsp.commonst.HostName",
"classes": "pointer",
"searchtype": "",
"name": "RESOURCENAME",
"index": "NCMResource__RESOURCENAME",
"sortable": ""
},
{
"formatter": "",
"search": "",
"hidden": false,
"displayName": "jsp.commonstr.IpAddress",
"classes": "pointer",
"searchtype": "",
"name": "IP_ADDRESS",
"index": "NCMResource__ADDRESS",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "ncmee.common.probe.name",
"classes": "pointer",
"searchtype": "",
"name": "PROBE_NAME",
"index": "PROBE_NAME",
"sortable": false,
"onlyInCentral": true
},
{
"search": "",
"hidden": false,
"displayName": "jsp.commonstr.Vendor",
"classes": "",
"searchtype": "",
"name": "VENDOR",
"index": "NCMVendor__DISPLAYNAME",
"sortable": ""
},
{
"formatter": "deviceRestStatus",
"search": "",
"hidden": false,
"displayName": "jsp.commonstr.TemplateName",
"classes": "",
"searchtype": "",
"name": "DT_NAME",
"index": "NCMDeviceTemplate__DISPLAYNAME",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "REST_CRED_STATUS",
"index": "DeviceRESTCredStatus__STATUS",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "REST_DT_ID",
"index": "DTRESTTemplateMapping__TEMPLATEID",
"sortable": ""
},
{
"formatter": "",
"search": "",
"hidden": false,
"displayName": "ncm.acd.Device_Type",
"classes": "",
"searchtype": "",
"name": "DEVICE_TYPE",
"index": "NCMPersonality__DISPLAYNAME",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "Series",
"classes": "",
"searchtype": "",
"name": "SERIES",
"index": "NCMResource__SERIES",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "Model",
"classes": "",
"searchtype": "",
"name": "MODEL",
"index": "NCMResource__MODEL",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "jsp.commonstr.OSTypes",
"classes": "",
"searchtype": "",
"name": "OSTYPE",
"index": "NCMResource__OSTYPE",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "ncm.acd.OS_Version",
"classes": "",
"searchtype": "",
"name": "OSVERSION",
"index": "NCMResource__OSVERSION",
"sortable": ""
},
{
"formatter": "",
"search": "",
"hidden": false,
"displayName": "Serial Number",
"classes": "",
"searchtype": "",
"name": "SERIALNUMBER",
"index": "NCMResource__SERIALNUMBER",
"sortable": ""
},
{
"formatter": "lastoperStatusFormatter1",
"search": false,
"hidden": false,
"displayName": "ncm.acd.Last_Operation_Status",
"classes": "pointer",
"searchtype": "",
"name": "LAST_OPERATIONSTATUS",
"index": "NCMOperationStateHolder__OPERATIONSTATUS",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "OPERATIONSTATUS",
"index": "OPERATIONSTATUS",
"sortable": ""
},
{
"formatter": "",
"search": false,
"hidden": true,
"displayName": "",
"classes": "pointer",
"searchtype": "",
"hidedlg": true,
"name": "OPERATIONTYPE",
"index": "OPERATIONTYPE",
"sortable": ""
},
{
"formatter": "healthConfigFormatter",
"search": false,
"hidden": false,
"displayName": "jsp.common.ConfigDiffView.ConfigConflict",
"classes": "pointer",
"searchtype": "",
"name": "STARTUP_CONFLICT",
"index": "NCMResourcesConfConflict__ISCONFLICT",
"sortable": ""
},
{
"formatter": "healthComplianceFormatter",
"search": false,
"hidden": false,
"displayName": "jsp.commonstr.ComplianceStatus",
"classes": "pointer",
"searchtype": "",
"name": "COMPLIANCE_STATUS",
"index": "NCMResourceCompStatus__COMPLIANCE_STATUS",
"sortable": ""
},
{
"formatter": "healthConfigFormatter",
"search": false,
"hidden": false,
"displayName": "ncm.baseline.conflict",
"classes": "pointer",
"searchtype": "",
"name": "BASELINE_CONFLICT",
"index": "NCMBaseRunningConflict__ISCONFLICT",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "ncm.CustomColumn1",
"classes": "",
"searchtype": "",
"name": "CUSTOM_COLUMN1",
"index": "NCMResourceCustomColumn__COLUMNVALUE1",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "ncm.CustomColumn2",
"classes": "",
"searchtype": "",
"name": "CUSTOM_COLUMN2",
"index": "NCMResourceCustomColumn__COLUMNVALUE2",
"sortable": ""
},
{
"formatter": "cellValueEscapeFormat",
"search": "",
"hidden": false,
"displayName": "ncm.CustomColumn3",
"classes": "",
"searchtype": "",
"name": "CUSTOM_COLUMN3",
"index": "NCMResourceCustomColumn__COLUMNVALUE3",
"sortable": ""
},
{
"search": false,
"hidden": false,
"displayName": "ncm.report.EOSD",
"classes": "",
"searchtype": "",
"name": "ENDOFSALEDATE",
"index": "NCMDeviceEOL__ENDOFSALEDATE",
"sortable": ""
},
{
"search": false,
"hidden": false,
"displayName": "ncm.report.EOSUD",
"classes": "",
"searchtype": "",
"name": "ENDOFSUPPORTDATE",
"index": "NCMDeviceEOL__ENDOFSUPPORTDATE",
"sortable": ""
}
],
"isv2Grid": true,
"groupsList": [],
"remote": true,
"grouping": false,
"listcolModelList": [],
"apiUrl": "/client/api/json/v2/ncmdevice/listAllDevices",
"gridSorting": {
"sortOrder": "desc",
"index": "NCMOperationStateHolder__OPERATIONSTATUS",
"columnIndex": 21
},
"gridPageSize": 50,
"notifRegistered": true,
"id": "Devices",
"colNamesList": [
"",
"",
"",
"",
"",
"",
"Host Name",
"IP Address",
"Probe Name",
"Vendor",
"Template Name",
"",
"",
"Device Type",
"Series",
"Model",
"OS Type",
"OS Version",
"Serial Number",
"Last Operation Status",
"",
"",
"Config Conflict",
"Compliance Status",
"Baseline Conflict",
"Custom Column 1",
"Custom Column 2",
"Custom Column 3",
"End Of Sale Date",
"End Of Support Date"
],
"v2translateColNames": true
}Error Response
View common error responses
Rate limit: 100 requests per minute. Exceeding this limit will block requests for 1 minute