6.2 Supported Queries
This section contains information about queries that are supported in the REST API.
6.2.1 data
The data query has no value. It specifies, that data information of a resource specified should be returned.
6.2.2 meta
The meta query has no value. It specifies, that meta-data information of a resource specified should be returned.
6.2.3 show
The show query has no value. It specifies that the data of a resource should be shown in a user-friendly format. This query is currently only supported on TRND function blocks where the show query causes that a graphical representation of data is returned.
6.2.4 export
The export query has no value. It specifies that the data of a resource should be returned in a format that is suitable for subsequent processing. This query is currently only supported on TRND function blocks where the export query causes that all the data from buffer are returned in a selected file format.
6.2.5 override
The override query has no value. It causes that the signal being written is switched to a Local override ie. manual mode. It may be applied to inputs of function block to put an input signal into fixed state. The override query is available only in a POST request.
6.2.6 format
The format query has a value which may be long or short. It defines the detail of information being returned. In case of a signal, only actual value is returned if format=short but signal quality and time-stamp are also included if format=long.
6.2.7 robot
The robot query has no value. The query notifies the server that the client is not a user. With this query specified, the server sends no responses that need interaction with a user and basic authentication is assumed. This query should be always specified when using wget of curl for interaction with the REST API.
6.2.8 mime
The mime query has a value that specifies the MIME format of data returned from the server. See section 5.2 for supported MIME types. The MIME specified by a mime query has always a precedence over the Accept HTTP header field.
[Previous] [Back to top] [Up]