- 10 Aug 2022
- 2 Minutes to read
- Updated on 10 Aug 2022
- 2 Minutes to read
Open Data Protocol (OData) is an open protocol that makes it easy and standardized to create and use queryable, interoperable REST APIs. OData helps you focus on your business logic while building RESTful APIs without having to worry about the approaches to define request and response headers, status codes, HTTP methods, URL conventions, media types, payload formats and query options1.
Read more: odata.org1
Adding a new resource
You can add a new OData integration via the 'Data' tab. Choose 'OData integration' by clicking the 'Add Data Resource'.
You will be presented with the initial configuration screen. Here, you need to choose the desired Authentication type and the enter the OData Base URL. As an example, you can use a OData.org test destination: https://services.odata.org/v4/TripPinServiceRW/. Click 'Verify URL' to connect to the destination.
Upon connecting, you will be presented with the available data entities in the left-side menu. You can enable and disable them accordingly. Choose the desired destination(s) and click "Save Data Resource". It is of best practice to create a new data resource for every entity, unless you want to combine data between both.
OData supports several request methods, similar to REST API. The basic request is "list" (Get record collection). By choosing a desired method from the menu, you can perform advanced tests and modify the request to your requirements.
All available methods correspond to logic flow functions in the following way:
- list: Get record collection
- retrieve: Get record
- create: Create record
- update: Update record
- delete: Delete record
The Config tab allows you to append a query to the destination. Query values are set in the 'Identifiers' field in the 'Test' tab.
Enables output filtering. Supports following methods:
- Equal: Compares provided string with the property value. Displays entities with matching values.
- Not equal: Ignores entities that contain the provided value string.
- Less: Displays entities with a value less than provided.
- Greater: Displays entities with a value more than provided.
- Maximum: Limits the value to be no more than the provided one.
- Minimum: Limits the value to be no less than the provided one.
- Equal (case sensitive): Same as 'Equal', but is case sensitive.
- Not equal (case sensitive): Same as 'Not equal', but is case sensitive.
Allows you to include only the chosen fields in the output.
Provided input will be used as a search string for property values inside an entity.
Page size & Page number
Allows you to divide returned data into pages (groups). The Page Size defines the number of entities in a single page, while Page Number outputs the value of a generated page.
After running a single test, you should see the response schema in the 'Schema' tab. It contains a full list of available properties, along with their types.