API News - December 2023

It's been a busy few months for APIs. Here's a recap of some of the updates you may have missed.

 

Important updates to API integrations 
All Aconex API integrations using Legacy Aconex OAuth, will be required to move to SCP OAuth before 1 September 2024. You may need to take action. 

  • Oracle's Smart Construction Platform OAuth (SCP OAuth) is our new API security method for all Aconex API integrations. This method allows users to authenticate via their Lobby user account.
  • The previous Aconex OAuth solution (referred to as Legacy OAuth) is now deprecated, however, support will continue until 1st September 2024.
  • All Aconex API integrations using Legacy Aconex OAuth will be required to move to SCP OAuth before this date. Aconex user account authentication will continue to work for Legacy OAuth and Basic Authentication.
  • Learn how to migrate current integrations to the new SCP OAuth solution.

 

A new API for Packages

  • We've added a new API to obtain the status of package documents.
  • Find the new Package Documents Status GET in the Packages API documentation.

 

Improvements for Cost APIs

  • The lastUpdated field in Cost APIs is now updated when a tag is changed.  Use this field in your integrations to check if any value was changed on a record.
  • The ProjectID can now be directly fetched from the control element GET method. This is useful for calling data from multiple projects.

 

Detailed examples for Cost APIs

To help you integrate with Cost, we've added Request Body examples for the following APIs:

  • PATCH /projects/{projectId}/contract-change-orders/{id}
  • PATCH /projects/{projectId}/contract-change-items/{id}
  • PATCH /projects/{projectId}/contracts/{id}
  • PATCH /projects/{projectId}/pay-items/{id}
  • PATCH /projects/{projectId}/change-event-items/{id}
  • PATCH /projects/{projectId}/change-events/{id}
  • PUT /projects/{projectId}/contract-change-orders/{id}
  • PUT /projects/{projectId}/contract-change-items/{id}
  • PUT /projects/{projectId}/contracts/{id}
  • PUT /projects/{projectId}/pay-items/{id}
  • PUT /projects/{projectId}/change-event-items/{id}
  • PUT /projects/{projectId}/change-events/{id}

We've also added payload examples for the following APIs:

  • PATCH /projects​/{projectId}​/change-items/{id}
  • PATCH /projects​/{projectId}​/change-orders/{id}
  • PATCH /user/{id}
  • PATCH /projects​/{projectId}​/payment-application-drafts/{id}
  • PATCH /projects​/{projectId}​/payment-application-items/{id}
  • PATCH /projects​/{projectId}​/payment-applications/{id}
  • PUT /projects​/{projectId}​/change-items/{id}
  • PUT /projects​/{projectId}​/change-orders/{id}
  • PUT /user/{id}
  • PUT /user/{id}/activate
  • PUT /projects​/{projectId}​/payment-application-drafts/{id}
  • PUT /projects​/{projectId}​/payment-application-items/{id}
  • PUT /projects​/{projectId}​/payment-applications/{id}
  • POST /projects​/{projectId}​/change-items/bulk
  • POST /projects​/{projectId}​/change-orders
  • POST /projects​/{projectId}​/change-orders/bulk

Some unused fields were removed from the examples to show the minimum required fields to create a record.


View the Cost API documentation