Aconex Web Services
Version 5.12
The most up-to-date revision of this guide will always be published on the linked Support page
Copyright Notice
Copyright © 1994-2018, Oracle and/or its affiliates. All rights reserved.
License Restrictions Warranty/Consequential Damages Disclaimer
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and
are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not
use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any
form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
Warranty Disclaimer
The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors,
please report them to us in writing.
Restricted Rights Notice
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S.
Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed
on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to
the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure,
modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the
hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other
rights are granted to the U.S. Government.
Hazardous Applications Notice
This software or hardware is developed for general use in a variety of information management applications. It is not developed or
intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use
this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup,
redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages
caused by use of this software or hardware in dangerous applications.
Trademark Notice
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective
owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license
and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron
logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
Third-Party Content, Products, and Services Disclaimer
This software or hardware and documentation may provide access to or information about content, products, and services from
third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with
respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and
Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to
or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.
Pre-General Availability Draft Documentation Notice
If this document is in public or private pre-General Availability status:
This documentation is in pre-General Availability status and is intended for demonstration and preliminary use only. It may not be
specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and
expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or
damages incurred due to the use of this documentation.
Private Pre-General Availability Draft Documentation Notice
If this document is in private pre-General Availability status:
The information contained in this document is for informational sharing purposes only and should be considered in your capacity as
a customer advisory board member or pursuant to your pre-General Availability trial agreement only. It is not a commitment to
deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development,
release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.
This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle.
Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle
License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement
which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein
may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This
document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its
subsidiaries or affiliates.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.
oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Access to Oracle Support
Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic
/lookup?ctx=acc&id=trs if you are hearing impaired.
Aconex Tasks Services
Task Count
The service returns task counts for a given project, or for all projects.
Note: Counts include totals for individual features (Mail, Register, Supplier Documents) and totals for different task types within features.
URL structure
HTTP GET: https://{hostname}/api/tasks/count?projectid={projectId}
Parameters
Parameters Type(maxlength) Cardinality Notes
projectid string Optional. If provided, task counts for the
given project are returned, else task
counts for all projects associated with the
user are returned.
Expected Response
Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear
in the response.
The number of *'s indicate the parent-child depth.
Element Type(maxlength) Cardinality Notes
Tasks Group 1
totalCount Attribute 1 The number of total tasks found for a
Integer given project or for all projects. Value can
be "0" if none found.
*Feature Group 1..n n refers to the number of features this user
/project registered to
*totalCount 1
Attribute The number of total tasks found for a
Integer given feature. Value can be "0" if none
found.
*featureName Attribute 1 One of:
String
Mail
Register (includes Documents, Assets,
Items, Defects, Issues)
Supplier Documents (only if applicable)
**Type Group 1..n n refers to the number of task types each
feature will have
**typeName Attribute 1 One of:
String
Mail :
unreadto
unreadcc
responserequired-OUTSTANDING
responserequired-OVERDUE
awaitingapproval
Register :
unreadtransmittalto
unreadtransmittalcc
responserequiredtransmittal-
OUTSTANDING
responserequiredtransmittal-
OVERDUE
unreadshare
awaitingreview
Supplier Documents:
supplierdocssubmissionrequired
supplierdocssubmitted
**totalCount Attribute 1 The number of total tasks found for a task
Integer type specified. Value can be "0" if none
found.
Examples/Samples
Sample Request
(Task Counts for a given project with id : 1879048400)
https://au1.aconex.com/api/tasks/count?projectid=1879048400
(Task Counts for all projects)
https://au1.aconex.com/api/tasks/count
Sample Response
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Tasks totalCount="28">
<Feature totalCount="12" featureName="Mail">
<Type totalCount="3" typeName="unreadto"/>
<Type totalCount="6" typeName="unreadcc"/>
<Type totalCount="1" typeName="responserequired-OUTSTANDING"/>
<Type totalCount="1" typeName="responserequired-OVERDUE"/>
<Type totalCount="1" typeName="awaitingapproval"/>
</Feature>
<Feature totalCount="13" featureName="Register">
<Type totalCount="5" typeName="unreadtransmittalto"/>
<Type totalCount="4" typeName="unreadtransmittalcc"/>
<Type totalCount="1" typeName="responserequiredtransmittal-
OUTSTANDING"/>
<Type totalCount="1" typeName="responserequiredtransmittal-OVERDUE"
/>
<Type totalCount="1" typeName="unreadshare"/>
<Type totalCount="1" typeName="awaitingreview"/>
</Feature>
<Feature totalCount="3" featureName="Supplier Documents">
<Type totalCount="2" typeName="supplierdocssubmissionrequired"/>
<Type totalCount="1" typeName="supplierdocssubmitted"/>
</Feature>
</Tasks>
Error Codes Specific to the Service
Status Descriptio HTTP Status
Code n Code
Prerequisites
Required Permissions
There are no required permissions to use this service.
Preferences/Module Setup
Not Applicable.
Related APIs
Task List Service
Task List
The service returns detailed information for tasks for a specified task type and project.
Notes:
1. Paged searching is mandatory for the service.
2. Page size is fixed to maximum of 25 tasks per response.
URL structure
HTTP POST: https://{hostname}/api/projects/{projectid}/tasks?task_type=
{taskType}&page_number={pageNumber}
Parameters
Parameters Type(maxlength) Cardinality Notes
task_type String 1 task_type is mandatory. One of:
Mail :
unreadto
unreadcc
responserequired-OUTSTANDING
responserequired-OVERDUE
awaitingapproval
Register :
unreadtransmittalto
unreadtransmittalcc
responserequiredtransmittal-
OUTSTANDING
responserequiredtransmittal-
OVERDUE
unreadshare
awaitingreview
Supplier Documents:
supplierdocssubmissionrequired
supplierdocssubmitted
page_number Integer 1 page_number is mandatory.
Note: Any value greater than 0 is
accepted
Expected Response
Cardinality refers to the number of repetitions a field can have. A cardinality that allows zero (0) means the field is optional, and may not appear
in the response.
The number of *'s indicate the parent-child depth.
Parameters Type(maxlength) Cardinality Notes
Tasks Group 1
*Task Group 1...n n refers to the number of tasks found for a
given project , given task type and page
number
*totalResultsOnPage Integer 1 Refers to the total number of tasks found
for a given project, given task type on a
given page
**AssignedByOrg String 0..1 This value is available to all task types
except awaitingapproval and
awaitingreview
**CreationDate String 1 UTC format
**Description String 1
**ProjectId String 1
**ProjectName String 1
**ReferenceLabel String 1
**StepName String 0..1 Only available for "awaitingreview" task
type
**AggregateCount Integer 0..1 Only available for "awaitingreview" task
type
**DueDate String 0..1 UTC format , Only available below task
types
responserequired-OUTSTANDING
responserequired-OVERDUE
responserequiredtransmittal-
OUTSTANDING
responserequiredtransmittal-OVERDUE
awaitingreview
**AssignedByUser String 0..1 Only available for "awaitingapproval" task
type
**MailId String 0..1 Only available for below task types
unreadto
unreadcc
unreadtransmittalto
unreadtransmittalcc
unreadshare
responserequired-OUTSTANDING
responserequired-OVERDUE
responserequiredtransmittal-
OUTSTANDING
responserequiredtransmittal-
OVERDUE
Examples/Samples
Sample Request for task type unreadto
Task List for a given project with id : 1879048194 and task type "unreadto"
https://au1.aconex.com/api/projects/1879048194/tasks?
task_type=unreadto&page_number=1
Sample Response for above request
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Tasks totalResultsOnPage="2">
<Task>
<AssignedByOrg>Walla</AssignedByOrg>
<CreationDate>2004-05-25T00:19:48.307Z</CreationDate>
<Description>external wall</Description>
<ProjectId>1879048194</ProjectId>
<ProjectName>Moonlight</ProjectName>
<ReferenceLabel>AA-000001</ReferenceLabel>
</Task>
<Task>
<AssignedByOrg>High Rise Architecture </AssignedByOrg>
<CreationDate>2004-05-24T23:01:09.703Z</CreationDate>
<Description>Project Update Meeting</Description>
<ProjectId>1879048194</ProjectId>
<ProjectName>Moonlight</ProjectName>
<ReferenceLabel>MEMO-000004</ReferenceLabel>
</Task>
</Tasks>
Sample Request for task type awaitingapproval
(Task List for a given project with id : 1879048194 and task type "awaitingapproval")
https://au1.aconex.com/api/projects/1879048194/tasks?
task_type=awaitingapproval&page_number=1
Sample Response for above request
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Tasks totalResultsOnPage="1">
<Task>
<AssignedByUser>Walla</AssignedByUser>
<CreationDate>2004-05-25T00:19:48.307Z</CreationDate>
<Description>Mail Approval task type</Description>
<ProjectId>1879048194</ProjectId>
<ProjectName>Moonlight</ProjectName>
<ReferenceLabel>DRAFT-00003</ReferenceLabel>
</Task>
</Tasks>
Sample Request for task type awaitingreview
(Task List for a given project with id : 1879048194 and task type "awaitingreview")
https://au1.aconex.com/api/projects/1879048194/tasks?
task_type=awaitingreview&page_number=1
Sample Response for above request
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<Tasks totalResultsOnPage="1">
<Task>
<aggregateCount>1</aggregateCount>
<creationDate>2011-01-26T23:32:44.997Z</creationDate>
<description>One step workflow- new</description>
<dueDate>2011-01-27T23:32:44.880Z</dueDate>
<projectId>1879048194</projectId>
<projectName>Moonlight</projectName>
<referenceLabel>WF-000002</referenceLabel>
<stepName>one step</stepName>
</Task>
</Tasks>
Error Codes Specific to the Service
Status Descriptio HTTP Status
Code n Code
Prerequisites
Required Permissions
There are no required permissions to use this service.
Preferences/Module Setup
Not Applicable.
Related APIs
Task Count Service
Additional to above services, a set of OAuth2 services are available, described in a separate specification.
