CONTENTS

Overview

The OData protocol API offers an additional option to the 3E REST APIs when integrating with 3E. The 3E OData API package provides access to 3E Application Objects, which provides more flexibility and power with building integrations with 3E.

API Requests

The 3E ODATA API is organized around REST. It uses standard verbs (e.g., GET, POST, and PUT) and returns HTTP response codes and JSON-encoded responses.

To make a REST API request, combine the following elements in the HTTP request in order to query, create or update the data for the designated target object:

  • URL to the API service

  • Method to be used (i.e. GET, POST, PUT, PATCH or DELETE)

  • URI to the resource

Note: The DELETE method is not offered as a method for OData API requests.

API Service URL

The URL to the API OData service is: https://api.elite.com/[environment]/3e/odata. For details on how to access 3E OData endpoints for 3E Cloud, go to the 3E API Guide and see the Where to Get Started and How to Access section. When opening the Support case, please specify "3E OData" with your request.

Request Sample

Below is an example of a 3E OData request for matters created after September 9, 2021. The GET request includes the query parameters that filters by the Timestamp attribute.

Query Parameters

For most REST GET calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response.

3E OData API Objects

The 3E OData API guide includes request and response samples for some of the 3E Application Objects accessible via the 3E OData API. Information is provided on object endpoints (e.g., Clients and Matters) and attributes.

OTHER DOCUMENTS