GetGridHeaderData result returns toolbar, field definitions, and business data from the database. The DATA element contains multiple ROW elements that represent a row of data from the database. The ROW element contains multiple ‘d’ elements that represent a column in the row. Every ‘d’ element has an attribute ‘n’ which is a number. This number corresponds to the aliasnum attribute in the field definitions. To retrieve the name of the column, refer to the attribute ‘name’ in that field definition.
Only the GetGridHeaderData response returns the FIELDS element to define the columns.
|
Element |
Attrib |
Description |
Occurs |
Lvl |
|---|---|---|---|---|
|
GRIDRESULT |
Result of grid query |
1 |
1 |
|
|
DATASPY |
Tells about the Dataspy run for this grid |
1 |
2 |
|
|
ID |
Identifier for the Dataspy. Should be used in subsequent requests for cached data retrieval |
1 |
||
|
LABEL |
Descriptive label for the Dataspy (from user definition) |
1 |
||
|
TOOLBAR |
Used in presentation to define grid toolbar and returned only in GetGridHeaderData. Ignore this element. |
0,1 |
2 |
|
|
GRID |
Contains the result of the query run from the database. Contains METADATA, DATA, FIELDS |
1 |
2 |
|
|
METADATA |
Data about the grid result. Ignore unused elements PORTLETFLAG, HASCREATEAUTH, EDITABLE, ISTAB |
1 |
3 |
|
|
REQUEST_TYPE_META |
Type of request made |
1 |
4 |
|
|
RECORDS |
Total number of records retrieved |
1 |
4 |
|
|
CLIENTROWS |
Number of rows returned with the result |
1 |
4 |
|
|
MORERECORDPRESENT |
A flag specifying whether there are more records present in the system after sending a number of CLIENTROWS |
1 |
4 |
|
|
CURRENTCURSORPOSITION |
The position of the cursor at present. Can be reset by CURSOR_POSITION in the request |
1 |
4 |
|
|
SERVERTIMESTAMP |
The timestamp of server (in milliseconds) when the request was made |
1 |
4 |
|
|
MULTIORGCOLUMN |
Org column used for this grid. Used when multi-org is enabled for entity queried by this grid. |
1 |
4 |
|
|
GRIDID |
Grid ID used. Should be supplied for every subsequent request to get data from cache |
1 |
4 |
|
|
DATASPYID |
Data spy ID used |
1 |
4 |
|
|
DATA |
Data from the result of query. If no data is returned, this element is missing. |
0,1 |
3 |
|
|
Element |
Attrib |
Description |
Occurs |
Lvl |
|
ROW |
A row of data. It contains multiple ‘d’ elements indicating a column of data. |
1 to n |
4 |
|
|
Id |
Attribute indicating the row ID in the present xml data set. It is not the rowid in the database |
1 |
||
|
d |
Contains the data of a row and column. |
1 to n |
5 |
|
|
N |
Short field ID for the value. Corresponds to FIELDS.Aliasnum |
1 |
||
|
FIELDS |
Contains the field definitions for grid columns |
1 to n |
3 |
|
|
Aliasnum |
Short field identifier number |
|||
|
Control |
Type of control (HTML control types). Values are 'CHECKBOX', 'RADIOBUTTON', 'BUTTON', ‘TEXT', 'LINK', 'SELECT', 'IMG', 'DIV', 'SPAN', 'HIDDEN', 'STATIC' |
|||
|
Filterable |
Whether this field is filterable (+ is Yes, - is No) |
|||
|
Sortable |
Whether this field is sortable (+ is Yes, - is No) |
|||
|
Label |
Internationalized label to display |
|||
|
Events |
Client-side events that are to be fired. Can be ignored |
|||
|
Name |
Column name (not the database column name). This is the field alias |
|||
|
Type |
Type of this column. These types are not data base types but application types. These types are used during formatting for client-side display. See "Table 2: Data Types" below. |
|||
|
Lookup |
Used only for HxGN EAM front end. Can be ignored. |
|||
|
Visible |
Whether to display this column or hide it. (+ is Yes, - is No). Hidden columns may be used to get corresponding non- displayed key values. |
|||
|
Width |
Width of column in the presentation grid in characters |
|||
|
Order |
The order of column display (1 to n) |
|||
|
Element |
Attrib |
Description |
Occurs |
Lvl |
|
KeyField |
Specifies fields needed to retrieve the corresponding entity from database. (+ is Yes, - is No) |