SELECT.ODATA
Selects OData data from a remote OData service.
Data can be selected in XML or in JSON formats. We recommend to use JSON format where available.
Properties
From | Must contain (or reference) an connection string, in one of the following ways: Name of a Data Source. Complete Connection-string: Lookup from a named Connection defined in Perfion Go to Administration -> Remote Queries and open a query to see available Remote Connection names: @RemoteConnectionName=ODataRemoteConnectionName Refer to Remote Query Setup for OData manual for more information about OData connection string. |
To | Name of the Output Data Source. The output data can be chosen to be in XML format or JSON format depending on "Format" parameter value in OData connection string. Note that not all OData servers support both formats. |
Script | The OData query. The query must be defined without base URI which is defined in the OData connection string. Example: |
Parameters
@CommandTimeOut | Specifies the request timeout in seconds. The parameter is optional. The default value is 30 seconds. |
@IncludeMetadata | Specifies if metadata should be included in the result. The parameter is optional. Per default, no metadata will be included in the response. @IncludeMetadata have two options
The metadata can also be retrieved independently by using "/$metadata" OData query. |
@GetAllPages | Allows receiving a full data set from OData server in case the response has paging. The parameter is optional. Values: TRUE or 1. If parameter is enabled then expected result is a single OData JSON or XML document with all data values concatenated from all pages including the page with original request data and all pages with data following after it. Perfion will read the "next" URLs present in the data and will automatically make subsequent request until all data is retrieved. Note that Perfion will only fetch data pages which follows the original request. If there are some pages before the original data, then those pages will not be retrieved. In this case in order to retrieve the full data set reset any filters in the original OData query so that it would point to the start of the data. Note that retrieving data sets which have many pages could result in a very large final documents which may exceed memory requirements needed to handle such data. |
Map
This Command does not use any value mappings.
Guide
With this Command one can retrieve OData data in raw format which then can be selected using SELECT.JSON or SELECT.XML commands in order to get the needed data for further processing.
Examples
Example of SELECT.ODATA command setup in Actions to retrieve OData data in JSON format including metadata.
- 1 Properties
- 2 Parameters
- 3 Map
- 4 Guide
- 5 Examples