Skip to main content

OData Receiver Connector

OData is a REST and HTTP-based protocol used to query data sources via URL and customize the result. Since it is HTTP based, it performs all queries via URL. With this connector, you can send requests to odata services and run queries.

Required Connector Properties​

  • OData Version: The choice of OData version depends on the application's needs, performance expectations, and existing infrastructure. Different versions support different feature sets and offer performance improvements. Selecting the appropriate version is crucial for meeting requirements, enhancing performance, and ensuring compatibility with future updates.
OData Version
  • OData v2.0: Supports basic CRUD operations and RESTful APIs.
  • OData v3.0: Provides advanced data processing and querying capabilities.
  • OData v4.0: Offers the latest and most advanced query options and performance enhancements.

  • HTTP Address: HTTP address field is used to specify the address of the targeted OData service for integration with the OData adapter. This address contains the URL of the OData service to be accessed. For example, a URL like "http://example.com/odata" can be used to access an OData service named "odata" on the "example.com" server.

  • Authorization Type: It is a header type used to determine whether the user making the request is authorized or not. This header may contain a username and password, an API key, or other authentication information to verify to the server the identity of the party making the request.

  • Authorization Name: This variable represents pre-registered username and password information for use in services. Each Authentication Resource Name contains authentication information for a user or application.

  • Get Entities And Fields: When this button is clicked, it establishes a connection by utilizing the HTTP Address and Authorization fields to retrieve entities and fields.

  • Resource Path: It allows the selection of one of the entities from the incoming data, and subsequent operations are carried out within this selected entity.

  • Operation: Operation is used to perform specific actions on data resources. These actions are commonly known as CRUD (Create, Read, Update, Delete) operations. If OData version is selected as v2.0 or v3.0, the operations can be selected as Query, Create, Update, Read, Delete, Patch, and Merge. If OData version v4.0 is selected, the operations can be selected as Query, Create, Update, and Delete.

  • Content Type: Content type ATOM or JSON can be selected depending on the Odata service.

  • Batch Processing: Activates the Batch Process feature. Batch processing refers to the processing of high volumes of data in bulk within a certain time period. Processes large volumes of data simultaneously. The data size is known and finite. Data is processed in multiple passes.

  • HTTP Timeout: Indicates a time limit applied when an HTTP request does not receive a response within a specified period. The timeout duration is determined by the requesting party and is typically expressed in seconds.

OPERATION

When OData Version is set to v2.0 or v3.0 and "Read" or "Query" is selected as the Operation.

Or when OData version is v4.0 and "Query" is selected as the Operation, the following fields are displayed.

  • Use Manual Query: If this field is selected, preparing the query is entirely left to the user. If not selected, the query can be prepared more easily and functionally using QueryOptions and other fields.

  • Query Options: If the "Use Manual Query" field is selected, the user can write the desired query in accordance with the OData format in this section, and the query they write will be appended to the end of the HTTP request. If the "Use Manual Query" field is not selected, this field can be filled by clicking on the fields shown in the "Select query fields" section below.

  • Select Query Fields: This is where the fields belonging to the Entity are located. Each selected field here will be added to the QueryOptions, and operations will be performed based on these fields.

  • Skip: Skip value specifies the number of records to be skipped before starting to return records in an OData query. It is useful for pagination, allowing you to skip a certain number of records and retrieve subsequent pages of results.

  • Top: Top value specifies the maximum number of records to be returned in an OData query. It allows limiting the number of records returned by a query, particularly useful when dealing with large datasets.

  • Count: Count value in an OData query specifies whether to include a count of the total number of records that match the query criteria. It is useful for obtaining the total count of records without retrieving all the individual records themselves.

  • Value: Value parameter in an OData query is used to specify that only the property values of entities should be returned, excluding any additional metadata or context. This is particularly useful when you only need the raw property values of entities without any additional information.

  • Query Filters - Add Filter: Add Filter button is used to add a custom filter to a query. "Filter" is a parameter used in an OData query to select records that meet specific conditions, allowing the queried dataset to be narrowed down based on certain criteria to retrieve the desired data.

  • Query Filters - Field: The fields belonging to the entity are displayed here. By selecting a field and assigning a value to it, the query is filtered accordingly.

  • Query Filters - Filter Method: The filtering methods displayed here are used in OData queries to narrow down datasets based on specific criteria and are useful for selecting records based on various conditions.

  • Query Filters - Value: This is the field where the value of the field to be filtered is indicated. The value of the previously selected field is entered here.

  • Query Sort - Add Sort: Add Sort button is used to add a custom sort to a query. Sort allows the data returned in an OData query to be sorted based on specific criteria. This parameter determines the order in which the returned data will be sorted, either ascending or descending, based on certain properties.

  • Query Sort - Field: It allows sorting according to the field selected here.

  • Query Sort - Sort Method: Specifies how the sorting will be done.

OPERATION

When the Operation Create, Update, Merge or Patch is selected when Odata Version is v2.0 and v3.0, and if Operation Update is selected when Odata version is v4.0, the following fields appear.

  • Key Value('Entity Key Value'): It finds the Key Value belonging to that entity and writes its name in the '' field within quotes. At this point, the key value of the value that you want to change should be written here. For example, if the key value is 'Country', Türkiye is written here.

  • Fields: The selected fields in the Select fields field go here, and the new value is written inside the "" quotes of the fields to be updated.

For Example

"UserName": "Sam",

"FirstName": "White",

"Age":"25"

  • Select Fields: Fields belonging to the entity are written here one by one. Which fields want to be updated are selected one by one. After the fields are selected, it comes to the fields field at the top.
OPERATION

If Operation Delete is selected in all Odata versions, the following field appear.

  • Key Value('Entity Key Value'): It finds the Key Value belonging to that entity and writes its name in the '' field within quotes. At this point, the key value of the value that you want to change should be written here. For example, if the key value is 'Country', Türkiye is written here.