set_session_property

The set_session_property request is used to configure some parameters of the current session.

Copied!
svc=core/set_session_property&params={"prop_name":"<text>", "prop_value":"<text>"}

Parameters

The allowed property names (prop_name):

  • skip_nonactive_items — allows hiding the deactivated objects (by default, all session objects are shown);
  • long_values — if set to 1, the server sends long numbers as strings (in brackets).

For both cases the prop_value should be:

  • 1 — activate;
  • 2 — deactivate.

Example

Copied!
svc=core/set_session_property&params={"prop_name": "skip_nonactive_items","prop_value": "1"}

Returned result

Copied!
{ }

Possible error codes:

CodeDescription
6Session not found or failed to set property.
4Wrong input parameters.
Download PDF file
Download Word document

See also