/handshake request

[starting from version: 2.8]

A request to establish communication between the client and server sides. Flexmonster includes its version in the request and expects a response with the custom data source API version implemented by the server.

See an example of handling the /handshake request.

Request

{
  type: string,
  version: string
}

Property/Type	Description
type String	The type of request. In this case, it is "handshake".
version String	The version of the custom data source API implemented by Flexmonster Pivot.

Response

{
  version: string
}

Property/Type	Description
version String	The version of the custom data source API implemented by the server. It is recommended to specify the flexmonster.js version used at the time of implementing the custom data source API. For example, if you handle the /handshake request while using Flexmonster version 2.9.80, set the version to 2.9.80.

Example

Request:

{
  "type": "handshake"
  "version": "2.9.80"
}

Response:

{
  "version": "2.9.80"
}

See also

/fields request
/members request
/select request for pivot table
/select request for flat table
/select request for drill-through view