External Service for OData
  • 08 Mar 2024
  • 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 removes the need to define request and response headers, status codes, HTTP methods, URL conventions, media types, workload formats, query options, etc. 


Example

  1. In a Designer Folder, navigate to Settings > Integrations > External Services. Then select the ADD ODATA SERVICE REFERENCE button in the Action Bar at the top of the page.
  2. When the Add OData window appears, provide a Name for the service. 
  3. A URL must be provided, which typically redirects to a metadata document (i.e. a WSDL file) that defines the service reference.  
    OData authentication is done entirely via OAuth. To learn more, see OAuth token.
  4. The Service Type option, by default, will have OData selected. The Dynamics AX option in this dropdown list includes features for this specific use case of generic OData. Once the configurations are complete, click SAVE 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. 
  5. Once the Service Reference is saved, Decisions will process the integration and provide Flow steps based on the service definition of the metadata URL. In the Designer Folder, click CREATE FLOW to create a new Flow to use the steps. 
  6. In the Toolbox panel, navigate to INTEGRATION > ODATA > [NAME OF SERVICE] to locate the steps. Be sure that the token is refreshed before running the steps.

For further information on Integrations, visit the Decisions Forum.



Was this article helpful?