Search Knowledge Base by Keyword

How to create ONDA OData queries

In this Section we describe the rules for constructing URIs allowing access to data Entities and Properties listed in Section 0.

The general scheme summarizing the URI components is depicted in Figure 2.

Figure 2 – URI components scheme

 

A URI used by an OData service has up to three significant parts:

  • The service root (Scheme+Host:Port+ServiceRoot);
  • The resource path;
  • The query string options.

For Example:

The service root URI identifies the root of an Odata service. For the ONDA Odata interface, the Scheme is the protocol HTTPS, Host represents the ONDA server IP address or hostname [ONDA_Catalogue_Hostname]).

The ResourcePath identifies the resource to be interacted with and enables any aspect of the data model exposed by an Odata service to be addressed. For the ONDA interface, it is Products.

QueryOptions are additional parameters for the query which specify which data are returned and how they are formatted. We will analyse the query options in the Section 4.1, in order to help the user go through the most common and useful scenarios.