Breadcrumbs

How to Verify that OData is Working

How to quickly verify that OData is running and working correctly.

URL and Credentials Required

  1. The URL to the OData server.
    The URL can be obtain from 2 sources.

    1. The OData feed(URL) field on from the ETL+ Source Driver for OData page for the data source. For more about opening the OData source driver see Accessing Acumatica/OData in a Web Browser,
      Access Data Source's Metadata from ETL+

    2. Knowledge of the URL to the Acumatica instance. See OData URL from an Acumatica Instance

image-20230819-001143.png
OData feed(URL) field, OData source driver page

  1. Credentials. A user login for the Odata URL below that has the ODataV4 ROLE. 

    • If the Acumatica Admin has set up permission restrictions by screen then the user will need the screen permissions AND the ODatav4 role.

Single-tenant & Multi-tenant URLs

<service-root>/odatav4

acu.dataself.com/AcurmaticaDB_2022R/odatav4


Verification

  1. In web browser enter
    https://xxx.acumatica.com/odatav4/AB&C%20Corp/$metadata 
    Where:

    • “xxx" is replaced with the customer's Acumatica site name

    • “AB&C%20Corp" with replaced with the customer's Acumatica tenant name.  
      For more about %20 encoding see the URL Encoding section below.

  2. Enter the user login

Evaluating Results

If the web page display a list of tables then Acumatica is working.

⚒️

Work in Progress
Restart Acumatica message.
What to do if you get a message like “Restart Acumatica” or some other error message.

Troubleshooting

See OData: Message OData[0100] "contents ... not available"



About URL Encoding

If there are spaces in the customer's tenant name, each space must be replaced with %20. This is a example of URL Encoding.  
URL Encoding replaces certain characters – mostly spaces and other special characters – with a % followed by a 2 digit number.

  • AB&C Corp is encoded as AB&C%20Corp

  • Benchmark Technology Group is encoded as benchmark%20technology%20group


For more see URL Encoding


In OData, the service root is essentially the base URL or entry point of the OData URL.
The service root URL is the starting point for constructing API requests to OData.