Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This OData sample was generated to work with the default h2 database (DATA_SERV_SAMP.h2.db), which is used for samples in WSO2 EI product. This database is stored in the <EI_HOME>/samples/database directorydata-services/dbs/odata directory. The details of this database are as follows:

...

You can easily invoke the service using HTTP requests. See the following examples.

Tip

If you want to invoke the OData services using the HTTPS protocol use the 8243 port. For an example:https://localhost:8243/odata/ODataSampleService/default

  • To get the service document:

    Code Block
    GET httpshttp://localhost:82438280/odata/ODataSampleService/default 
    Accept : application/json
  • To get the meta data of the service:

    Code Block
    GET httpshttp://localhost:82438280/odata/ODataSampleService/default/$metadata
    Accept : application/xml
  • To read customer details:

    Code Block
    GET httpshttp://localhost:82438280/odata/ODataSampleService/default/CUSTOMERS
    Accept : application/json
  • To add accounts details, send the HTTP request as shown below. In this example we will be creating an account ID named "1".

    Code Block
    POST httpshttp://localhost:82438280/odata/ODataSampleService/default/ACCOUNTS
    Accept: application/json
    Content-Type: application/json
    Prefer : return=representation
    { "BALANCE" : 12.22 ,"ACCOUNTID" : 1 }
  • To delete account details, send the HTTP request as shown below. In this example, we will be deleting the account ID "1".

    Code Block
    DELETE httpshttp://localhost:82438280/odata/ODataSampleService/default/ACCOUNTS(1)
    Accept: application/json
  • To update account details:

    Code Block
    PUT  httpshttp://localhost:82438280/odata/ODataSampleService/default/ACCOUNTS(1)
    Accept: application/json
    { "BALANCE" : 12.22 }
  • To invoke a particular query, send the HTTP request as shown below. In this example, we will receive the city and phone numbers of customers.

    Code Block
    GET  httpshttp://localhost:82438280/odata/ODataSampleService/default/CUSTOMERS?$select=CITY,PHONE
    Accept: application/json
  • To filter information based on a query, send the HTTP request as shown below. In this example, we will receive the employee details connected to the 'Nantes' city.

    Code Block
    GET httpshttp://localhost:82438280/odata/ODataSampleService/default/CUSTOMERS?$filter=CITY eq 'Nantes'
    Accept: application/json