External Service for OData
  • 30 Mar 2022
  • 1 Minute to read
  • Dark
    Light

External Service for OData

  • Dark
    Light

Article Summary

Overview

The Open Data Protocol (OData) is a service that standardizes the creation and consumption of REST API calls in a simple way. OData does this by removing the need to define request and response headers, status codes, HTTP methods, URL conventions, media types, workload formats, and query options, etc. 


Example

  1. In a Designer Folder, select the CREATE DATATYPES/INTEGRATIONS button on the bottom Action Bar. 
  2. When the window appears, select the External Services tab on the left, then select the Add OData Service Reference tile and click CREATE.

  3. When the Add OData window appears, provide a Name for the service. 
  4. A URL must be provided, which typically redirects to a metadata document (i.e. a WSDL file) that defines the service reference.
  5. Service Type by default will already have OData selected. The Dynamics AX option in this drop down list includes features for this specific use case of generic OData. 
    OData authentication is done entirely via OAuth, therefore, setting up an OAuth Token is required. The steps required are similar to setting up a Salesforce integration.
  6. Once the configurations are complete, select the SAVE SERVICE REFERENCE button.

  7. Once the Service Reference is saved, Decisions will process the integration and provide Flow steps based on the service definition of the metadata URL. 
  8. Once these steps are created, open the Flow Designer to use them in workflow logic. 
  9. These steps can be located in the by navigating to Integration > OData category in the step toolbox. 
  10. The name of the service that was configured will appear in this section, containing the steps that were generated for the datatypes in the service metadata. Be sure that the token is refreshed before running the steps. Below is a sample output from one of the steps

    image1.png



OData Service Reference settings

Below is a short overview of the settings found when setting up an OData Service reference:

SettingDescription
NameThe name of the service reference as it appears in Decisions.
URLThe URL used to pull the metadata needed to access the service
Get Metadata from FileAllows uploading an OData metadata file to generate an OData service reference
OAuth TokenThe OAuth token used for authentication
Service TypeDefines the service used for OData. The Dynamics AX option includes features that are used when handling this specific OData service type.



Was this article helpful?