POST api/ytcpmsg/GetWaitedObjectMSG/{id}?waitsec={waitsec}

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required
waitsec		integer	Default value is 20
api-version	The requested API version	string	Default value is 1.0

Body Parameters

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

sAnyData

Name	Description	Type	Additional information
mType	Determines expected format in BData	enRType	None.
BData	Payload: mostly in base64/byte[] in expected format defined by mType	Collection of byte	None.

Response Formats

application/json, text/json

Sample:

{
  "mType": 0,
  "BData": "QEA="
}