POST api/ytcpmsg/GetGridDef/{id}

Retreive grid type definition + return GUID for awaited dataset Grid definition with message GUID is returned immediately. Next you can call GetAnyData or GetWaitedRawMSG(until timeout)

Request Information

URI Parameters

Name	Description	Type	Additional information
id	ID of dataset	integer	Required
api-version	The requested API version	string	Default value is 1.0

Body Parameters

REQUIRED:IDCust.When "mType" is specified, data will be prepared for pickup by "msgid". Values for messageFormat,paging,filtering,navigating are optional. + specifying caller IDAction

aPars

Name	Description	Type	Additional information
IDCust	ID Company, required(mostly)	integer	None.
IDObject	IDAction which performing operation(Only if call is related to the action)	integer	None.
entityIdent	Type of IDObject	enTablesLink	None.
qRowsOffset	FROM which recordNO take rows	integer	None.
qRowsCount	Requested NO rows	integer	None.
mType	Requested message type(json_utf8 is default)	enRType	None.
Params	Values for action to store	Collection of EParams	None.
Cols	Requested server side sublist of columns	Collection of EParams	None.
qWhere	Requested server side filtering by columns and condition	Collection of EParams	None.
qOrder	Requested server side ordering by columns and condition	Collection of EParams	None.
Caller_IDObject	optional: identify from which editor/action is call made(if known)	integer	None.
Caller_ParName	optional: identify from which editor Parameter(s)(delimited by ";") in IDObject is call made(if known)	string	None.

Request Formats

application/json, text/json

Sample:

{
  "IDCust": 1,
  "IDObject": 1,
  "entityIdent": 0,
  "qRowsOffset": 1,
  "qRowsCount": 1,
  "mType": 0,
  "Params": [
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    },
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    }
  ],
  "Cols": [
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    },
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    }
  ],
  "qWhere": [
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    },
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    }
  ],
  "qOrder": [
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    },
    {
      "ParName": "sample string 1",
      "ValName": "sample string 2",
      "Val": {},
      "Cond": "sample string 4",
      "DType": 0
    }
  ],
  "Caller_IDObject": 1,
  "Caller_ParName": "sample string 1"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

sGridModel2

Name	Description	Type	Additional information
MetaData	Metadata per grid definition	Collection of TWMetaDt	None.
msgid	payload can be picked from GetAnyData by this id	globally unique identifier	None.
DCols	Columns defitions	Collection of sDCol	None.
RowsLimit	Expected maximum rows count in Payload by msgid. Because there may by more, maximum limit says, how much to display per page	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "MetaData": [
    {
      "ID": 1,
      "IDCust": 1,
      "IDUsr": "sample string 2",
      "PubName": "sample string 3",
      "EntityIDent": 0,
      "CustomEntityIdent": "sample string 4",
      "DataRowID": "sample string 5",
      "PropName": "sample string 6",
      "ValType": "sample string 7",
      "Value": "sample string 8",
      "DatCreated": "2024-05-09T02:52:37.9072499+02:00"
    },
    {
      "ID": 1,
      "IDCust": 1,
      "IDUsr": "sample string 2",
      "PubName": "sample string 3",
      "EntityIDent": 0,
      "CustomEntityIdent": "sample string 4",
      "DataRowID": "sample string 5",
      "PropName": "sample string 6",
      "ValType": "sample string 7",
      "Value": "sample string 8",
      "DatCreated": "2024-05-09T02:52:37.9072499+02:00"
    }
  ],
  "msgid": "c927282e-6665-4179-84a0-69c52cc5bd87",
  "DCols": [
    {
      "SysName": "sample string 1",
      "PubName": "sample string 2",
      "Proto": "sample string 3",
      "isUnique": true,
      "isHidden": true,
      "DType": 0,
      "InCompactView": true,
      "CHid": true,
      "DataFormatString": "sample string 8",
      "ColWidth": "sample string 9",
      "xDef": "sample string 10",
      "ExtConfig": {}
    },
    {
      "SysName": "sample string 1",
      "PubName": "sample string 2",
      "Proto": "sample string 3",
      "isUnique": true,
      "isHidden": true,
      "DType": 0,
      "InCompactView": true,
      "CHid": true,
      "DataFormatString": "sample string 8",
      "ColWidth": "sample string 9",
      "xDef": "sample string 10",
      "ExtConfig": {}
    }
  ],
  "RowsLimit": 2
}