The Hybrid Data Pipeline OData service interface supports GET, PATCH, POST, POST/PATCH and POST/DELETE HTTP methods. Each operation acts on the resource specified in the URL.

The POST request to create or update an entity should include a Content-Type header specifying the format of the request payload. The Hybrid Data Pipeline OData API recognizes the following content types:

  • application/json
  • application/json;charset=UTF-8

If the Content-Type header is not supplied, Hybrid Data Pipeline interprets the body as the JSON format encoded using the UTF-8 character set.

Supported OData API Operations

The following table shows the operations that can be performed and their associated URLs. Refer to the specified section for detailed descriptions for these operations. Query the data source name to get a list of the valid entities.

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

Note: Unless the ports 80 and 443 are redirected to 8080 and 8443 respectively, you must specify <myserver>:<port>.
Purpose Request URL
Fetch Data from an OData Service 
GET
 
https://<myserver>:<port>/api/odata4/
   <data-source-name><entity-plural-name>
Create an Entity 
POST
 
https://<myserver>:<port>/api/odata4/
   <data-source-name><entity-plural-name>
Update an Entity 
PATCH

OR

POST
X-HTTP-Method:PATCH
 
https://<myserver>:<port>/api/odata4/
   <data-source-name><entity-plural-name>('primary-key')
Delete an Entity 
DELETE

OR

POST
X-HTTP-Method:DELETE
 
https://<myserver>:<port>/api/odata4/
   <data-source-name><entity-plural-name>('primary-key')