You are here

Changes to the Aconex External APIs

Written for: 
Change Scheduled: 
Wednesday, 31 December, 2014 - 13:00

Aconex is making changes to its external APIs.  We're committed to maintaining the consistency of our APIs, and ensuring the longevity of the API solutions we develop. So we rarely alter the APIs, and we understand that each change could have an impact on our customers. 

These changes are urgently needed to ensure documents can continue to be uploaded to Aconex.

What's changing?

Specifically, we’re changing the way we represent all IDs returned from the external APIs.  The accelerating growth in the number of documents in Aconex means that we need to use a larger data type to store and identify them.

These changes will mean that IDs can no longer be stored using integer types; all IDs that are used with our APIs must now be stored as strings.

When will the change take place?

This change will be rolled out progressively across different ID types and instances from January 2015.

We'll start with Control Document IDs <documentID> and Tracking IDs <trackingID> on 18 January 2015.

Other IDs will follow in the coming months. We’ll update you prior to changing the remaining IDs.

What should you do?

If you don’t already store all the IDs you’re using with our API in strings, we recommend that you:

  1. begin storing the IDs in strings immediately, and
  2. establish a data migration plan, and begin migration, for any IDs currently stored as integer types as soon as possible.

More information

If you have questions about this change or want access to our test instance, please don’t hesitate to contact our API team direct, by emailing idmigrationsupport@aconex.com.

Any feedback?

Thanks. A ticket has been opened with the Support Central team.