Frequently Asked Questions

There are reasonable limits that apply to both volume and frequency of requests an API caller can make using Aconex web services. These limits have been put in place to ensure the quality of service is maintained for all, especially users of the Aconex web interface. See Aconex Web Services Performance Throttling

Currently there are no API services for project settings available.

Solution: Changes are carried out using Aconex Web App.

In the Aconex app, external hyperlinks can be created to documents and mail.

For documents add the Hyperlink column to your document search.

For mail, hover over the mail subject to see the URL.

A field identifier name can differ from one service to another, and also differ in the request vs. response for the same service. A field name can’t be assumed to be consistently used.

Solution: For each service, the API specification need to be used to determine the correct field identifier for each context. 

Currently this information is not available. A mail item can belong to the inbox, sent box or both.

Solution: Use the ‘List Mail’ service to find out.

The "Created By" field in the Aconex Web App is called "Author" in the API document services, as they are the same field.

Solution: Look for the "Author" field.

Two different API services can be used to get documents based on a date range, "List Documents" or "Document Last Updated".

Solution: With "List Documents" use a date range with parameter "registered", like "registered:[20170101 TO 20180101]". With "Document Last Updated", use parameter "everythingsince" and set "show_document_history" to true to get all the changes.

Aconex has a feature in the Web App where it’s possible to register a response mail on behalf of another user. This can be useful when the other user has sent a response to an Aconex mail outside of Aconex, and there is a need to import this response into the Aconex mail thread.

Solution:  This is not possible currently. You can only register a NEW mail on behalf of another user using the “Register Mail” service.

Documents can be made confidential in Aconex. The user who register or supersede a document can make it confidential. When that is done, the user specifies a list of users that will have access to the document. Also, users that have their access level set to see all confidential documents will see it, all other users will not see the document.

Solution:  Yes, by using the “View Document” service, if you have access to the document or have it set in your role to see all confidential documents.

You can change document field names during your project setup. This means that a document field can have a default field name and a “modified name”.

Solution: Both default and modified field name are listed in the project document schema.

Two different API services can be used to get mails based on a date range, "List Mails" or "Mail Last Updated".

Solution:  With "List Mails" use a date range with parameter "sentdate", like "sentdate:[20170101 TO 20180101]". With "Mail Last Updated", use parameter "everythingsince" and also set which mailbox to search, "Inbox" or "Sentbox".

Some fields require an ID when updating Aconex.

Solution: If the schema provides an ID for a field, then this should be used.

Currently this is not possible.

Solution: You have to download one file at a time.

Several fields are listed in the API specification that can be the “Create Date”. For example: ‘registered’, ‘date created’, ‘received’, ‘lastModifiedDate’ and ‘ModifiedDate’.

Solution: The “Modified Date” field is a document’s created date.

Currently there is no API service to list available instances.

Solution: Go to https://help.aconex.com and select “Aconex Login”. You can find a list of available instances there.

Both ids are unique to a document. The tracking ID for a document is the same for all document versions. The document ID is unique for each document version.

Currently there is no API service to retrieve the field size properties.

Solution: Log in to Aconex and select Setup. The fild max length is listed under Project Settings.

In Aconex users can set their preferred language in the preference settings. The language preference selected will be the one used by the API when this account is used.

Solution: Login to Aconex and set the desired language in preferences.