RAW services

This document describes how RAW services are working. The calls examples are given using the curl command line tool (that can easily be transposed to any HTTP client tool or API).

Note: the -b cookies.txt -c cookies.txt parameters of the curl calls bellow are required as they allow to use the same server session (identified by the JSESSIONID cookie).

For an application named myapp, the base URL of the raw services endpoint is:

http[s]://<host[:<port>]>/myappws/raw

As of version 3.0 MAINTENANCE 20, the API endpoint is also available in the main webapp /myapp (this allows to avoid deploying the webservice gateway webapp /myappws):

http[s]://<host[:<port>]>/myapp/api/raw

if you are using this API endpoint please refer to this document for details on the authentication mechanisms.

It will be noted <base URL> in the rest of the document.

Warning: In production the services endpoint's URL should be restricted only to allowed origins e.g. using URL filtering based on request's origin IP address or similar approaches.

Data services

Business object service

The object raw data service returns the rows of a business object as a plain HTML table. The values are formatted using the user's locale settings (dates, floats, ...) and the field labels are returned in the user's language.

To get data from the SystemParam business object the call is:

curl -b cookies.txt -c cookies.txt -u <login>[:<password>] "<base URL>/data?object=SystemParam"

List of values service

The list of values raw data service returns the code and values of a list of values as a plain HTML table. The values are returned using the user's language.

To get data from the LANG list of values the call is:

curl -b cookies.txt -c cookies.txt -u <login>[:<password>] "<base URL>/data?lov=LANG"

Usage in Microsoft Excel®

Typical usage of raw data services is to configure traditional external datasources in Microsoft Excel®.

Note: In recent Excel versions (Office 2016+) a much better approach is to use the PowerQuery tool (which is now provided by default with Excel) and the REST services. See dedicated section in this document for details.

Usage in Google Spreadsheets®

As of version 3.1 MAINTENANCE 07, another possible usage of raw data services is to configure external datasources in Google Spreadsheetsl®.

Note that only public data can be loaded (unless your application uses the same Google OAuth2 authentication than the spreadsheet).

To do so create a formula like: =ImportHTML("<base URL>/raw/data?object=<object name>[&<filters>]"; "table"; 1)