Request object syntax

Overview

The request object follows the JSON-RPC 2.0 specifications and has the following members:

Member	Description / Value	Mandatory
jsonrpc	Version of JSON-RPC. Equals 2.0	Yes
id	Identifier established by the initiator of the request. If this member is not present, the rpc call is assumed to be a notification.	No
method	Name of the method.	Yes
handle	Target of the method. The member handle is not part of the JSON-RPC 2.0 specifications.	Yes
delta	Boolean. If set to true, the engine returns delta values. The default value is false. Examples of use: The delta member is set to true to get the delta of the layout or the delta of the properties of an object. For more information, see Get the delta of the layout and Get the delta of properties.	No
params	Sets the parameters. The parameters can be provided by name through an object or by position through an array.	No

See http://www.jsonrpc.org/specification for more information on the syntax.

Example 1:

The parameters are provided by name through an object.

A request object could be as follows:

{ "jsonrpc": "2.0", "id": 6, "method": "DestroyChild", "handle": 7, "params": { "qId": "LB02" } }

Example 2:

The parameters are provided by position through an array.

A request object could be as follows:

{ "jsonrpc": "2.0", "id": 6, "method": "DestroyChild", "handle": 2, "params": [ "LB02" ] }

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!