Enterprise oData API Retirement

The e-Builder Enterprise OData API has reached a mature stage of its lifecycle.

Released in 2016, the OData API allows developers to integrate Capital Improvement Data captured in e-Builder Enterprise to other sources of data. OData API calls can be identified via the following URL:

https://api.e-builder.net/ebodataapi.svc

Lifecycle Phase Effective Date Notes

Maintenance

January 2018

API v2 (REST) released July 2017

End of Maintenance

February 2022

  

End of Service

February 2023

  

Impact

The OData API is available until the End of Service phase. In the End of Maintenance phase, the service will function in an “as-is” state and no additional enhancements or fixes will be performed unless it is identified as a critical security issue.

Alternatives

There are multiple options available as customers migrate from using the OData API. The choice of alternative would be based on the use case scenario and the problem being solved.

  • The e-Builder Data Warehouse companion product was released on October 2019. This is an excellent option to replace oData functionality while allowing you to connect your 3rd Party Business Intelligence tools to drive analytics.

    For organizations currently using OData to extract large volumes of data for the purpose of reporting, analytics, or archiving, the Data Warehouse companion product is the recommended replacement.

  • e-Builder Enterprise API v2 (also referred to as REST API and previously Reporting API) was released in July 2017 and it allows programmers to retrieve information from and send information to e-Builder using a modern RESTful API. This API collection will continue to be developed, enhanced and expanded upon, broadening access to functions and interactions with e-Builder Enterprise.

    For organizations currently using OData for transactional integrations with other enterprise systems, or custom applications, this is the recommended replacement.

  • e-Builder AppXchange enables rapid deployment of integrations with common enterprise systems, such as accounting and content management. AppXchange integrations are highly maintainable through changes to organizational processes and procedures. Trimble PPM Services are available to support the integrations.

    For organizations starting new integration projects to commercially available enterprise systems, AppXchange is a recommended approach.

Actions Needed

Organizations currently using OData will need to migrate to one of the available alternatives. A course of action might include:

  1. Review all current integrations and standard spreadsheet tools that make calls to the OData API. Tabulate the list and denote the problem being solved in alignment to the above alternative descriptions.
  2. Determine which alternatives need to be explored further. Contact your Trimble PPM Account Manager to gather information and arrange for access or additional meetings with Trimble PPM Services
  3. Devise more detailed plans for each migration, keeping in mind the lifecycle phases and dates above in this announcement.

More Information

For more information or questions, please contact e-Builder support or your account manager, or reference one of the items outlined below.

  • e-Builder Enterprise API v2 Documentation Click here
  • e-Builder AppXchange Overview Click here
  • E-Builder AppXchange Technical Whitepaper Click here
  • e-Builder Enterprise Data Warehouse Click here

Announcement Publication Details

  • Published On: 8 February 2022
  • Last Updated On: 8 February 2022