OData requests to a Hybrid Data Pipeline data source must include authentication, the service root, and resource name. You can fetch single or multiple entities and related entities using entity addressing and the supported methods. While you can set some server-side behavior such as caching and paging in the data source definition, client-side options also allow you to control behaviors such as paging and response formatting.

The following are required:

  • Authentication
    Supply credentials for Hybrid Data Pipeline and for the backend data store:
    • The Hybrid Data Pipeline user ID and password must be passed using HTTP basic authentication. The client encrypts the Hybrid Data Pipeline user ID and password in the Authorization header.
    • The credentials for your data store can be stored in the data source definition or passed as part of an OData request — using the ddcloud-datasource-user and the ddcloud-datasource-password headers, as described in Data Source User Header and Data Source Password Header.
  • Service root and resource name

    The location of the Hybrid Data Pipeline service and the name of the OData-enabled data source definition (case insensitive) as displayed on the OData tab of your data source definition. See Service URI and resource path for OData Version 4 for an example.

The following are optional:

  • Entity addressing
    Append entity addresses to the request after the data source name. Use the plural entity name defined in the schema map. For example, the following request fetches the employee record with a primary key of 27, from the EMPLOYEES table in the myoracletest2 data source. 
    https://<myserver>:<port>/api/odata4/myoracletest2/EMPLOYEES('27')
    See Service URI and resource path for OData Version 4 and Formulating queries with OData Version 4 for details and more examples.

    where <myserver> is the DSN name or the IP address of the machine where Hybrid Data Pipeline is installed.

  • Queries and operations

    Hybrid Data Pipeline supports OData edit, create, update and delete operations, see examples in the Formulating queries with OData Version 4 section.