Aconex Brochure
Aconex Brochure
Aconex Brochure
APIs
Managing project information can sometimes involve multiple applications
and platforms. Until now, these systems couldn’t easily “talk” to Aconex,
creating a barrier to efficient information flow. But what if you could connect
everything, reducing risk, and improving efficiency to maximize your financial
return? And what if you could do even more with the project data that is
captured and managed on Aconex? Web Services APIs make this possible.
Applications
Extract and archive project information, in real time or in batches, for
archiving, data mining or reporting.
Integrate with other software applications to allow your information to flow automatically
between Aconex and your EDMS, internal mail system or other business software.
Benefits
Your risk is reduced. Synchronizing information between Aconex and your other systems
will help ensure consistency and data quality, can reduce errors related to manual
processing, and may help satisfy regulatory requirements.
Your efficiency is increased. Eliminating the delays and cost of double data entry will
improve the efficient capture of project data in your enterprise systems.
You drive more value from your investment. Using Aconex to automate distribution of
information to your other systems allows you to leverage the value of that information right
across your business.
Technology overview
The Aconex Web Services APIs are based on standards including Extensible Markup Language
(XML) for representing data and Representational State Transfer (REST) for data exchange.
This architecture allows ready integration with .NET, Java and other programming languages
that can exchange data using HTTPS. Access to the Web Services APIs is secure and requires
user authentication to specific projects on the Aconex platform, and can be managed at a user
level. The API authentication model is stateless, and all security checks applicable to the user
interface also apply to the APIs. All transactions are conducted over HTTPS.
Directory Search Project directory – returns selected details of matching users & groups based on specified
search criteria
Global directory – returns selected details of matching users based on specified search criteria
View Organization information (from global directory) – returns details of specified organization in
the global directory
User information (from global directory) – returns details of specified user in the global
directory
User information (from project directory) – returns details of specified user in the project
directory
Get Organization logo NEW – retrieves the logo image for the specified organization
Projects List Available Projects – returns list of projects that the requesting user has access to, including
project details
Get Project logo NEW – retrieves the project logo image for the specified project
Documents List / Search Documents – returns list of ID’s of documents based on specified search criteria
View Document schema – returns the schema for the specified project’s document register
Document metadata NEW – returns the detailed metadata for a specified document
Document event log – returns content of the event log for the specified document
Download Document attachments – delivers the actual file associated with the specified document
Document attachments with mark-ups – delivers a TIFF conversion of the file with mark-ups
shown
Register New document NEW – registers a new document in the register including the backing file
Supersede Existing document NEW – supersedes the specified document with another revision (including
the backing file)
Mail List / Search Mail – returns list of ID’s of mails based on specified search criteria
View Mail schema – returns the schema for the specified project’s mail register
Mail metadata – returns details of the specified mail item including all metadata, a list of file
attachments, and the full body/content
Mail thread NEW – returns the details of the full thread of mails related to the specified mail item
Download Mail attachments – delivers the actual file (s) associated with the specified mail
Mail attachments with mark-ups – delivers a TIFF conversion of the file with mark-ups shown
Create New mail – generates new project mail item issued to specified recipients (including
attachments)
Reply mail NEW – generates a new project mail item in reply to an existing mail
Forward mail NEW – generates a new project mail item as a forward from an existing mail
Register Incoming mail NEW– register an external correspondence in your organization’s mail Inbox
About Aconex
With more than 6,000 projects valued at $210 billion managed on the
system, Aconex is the world’s largest provider of project collaboration
solutions to construction, energy, resources, and related industries. We
service clients in more than 65 countries, on projects of all sizes on every
continent. Delivered on-demand, on a project-by-project basis, Aconex
is used to ensure that all project information is securely and permanently
captured, efficiently distributed and managed, and instantly retrievable.
www.aconex.com