API News - July 2023

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

 

Introducing a new Mail API

  • We've delivered a much-requested API. 
  • The new View Mail Saved Searches API returns default saved searches, plus any newly created ones. 
  • This includes My Searches, My Organization's Searches, My Project's Searches and Standard Searches.

 

Get your saved searches

  • A new Get Saved Searches API service returns the saved searches that are stored from the Document Register’s All Filters section. 
  • It returns the saved search group that the saved search belongs to, and the saved search filter criteria.

 

Manage users via API

  • Org Admins, you can save time and enable or disable users via Userstatus in the Directory API
  • What does this mean? When an employee leaves your organization, you can now revoke access to your organizations' Aconex projects via API. This reduces risk, exposure and potentially sensitive information from individuals who should no longer have access.

 

Improvements for large files

  • We've changed the way the Register Document API uploads large files.
  • The Chunked Transfer-Encoding option has been improved to allow the files to be uploaded with background processing.
  • You can track its process via the new Background Job Status Check API.
  • Read more about this API

 

A new sort option in the BCF API

 

Integrated with Oracle Primavera Cloud

We've updated the package management APIs to include Oracle Primavera Cloud. The updated APIs are:

  • Packages GET (list all)
  • Package GET
  • Packages POST (list all with pagination)
  • Package POST
  • Package PUT
  • Package Schedule GET (new)
  • Package Management API documentation update

 

Manage user roles via API

View the User Role APIs to help you manage user accounts. These are:

  • User Role Search (Project) - a read API to fetch user roles and their respective secured assets in a project.
  • User Search (User Role – Project) - a read API to fetch users assigned to a user role in a project.
  • User Entitlements (Organization) - a read API to see the user roles assigned to a user in an organization.
  • User Entitlements (Project) - a read API for to see the user roles assigned to a user in a project.
  • Create User Role (Organization) - an API to create a new user role in an organization.
  • Create User Role (Project)
  • Update User Role (Organization)
  • Update User Role (Project)
  • Update Secured Asset permissions (Organization)
  • Update Secured Asset permissions (Project)
  • Update Users assigned to User Role (Organization)
  • Update Users assigned to User Role (Project)
  • Delete User Role (Organization)
  • Delete User Role (Project)

 

Configured fields for Cost

  • The Configured fields (manual & calculated) APIs are now available to use.
  • Learn more about the Cost API.

 

Bug fixes

  • We fixed the bug that stopped autonumbering from working when uploading documents with project fields. 
  • Thanks for letting us know the renamed VDR code Document Field was either not rendering or rendering mismatched results for Drawings and Documents. We've now fixed the API so this will render as expected.
  • If you're using US1, the Register Document API has had its bug fixed. The API works with auto-numbered documents now.
  • Some of you encountered a bug that corrupted PDF files downloaded via an API. We've fixed it and you can use the API for these files again.

 

In other news

There will be a change to the current API authentication process.  We'll be communicating important information over the coming months, so if there are other members of your organization who may need these updates, make sure they are subscribed to API News.