Projects API Developer Guide

Discover APIs available for Projects.

List Projects for User

The service retrieves the list of projects that the authorizing user has access to within their organization.

URL structure

HTTP GET: https://{hostname}/api/projects

Parameters

Parameters	Type(maxlength)	Cardinality	Notes

Interface

Request Fields

Not applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/projects

Response Fields

Element	Type(maxlength)	Cardinality	Notes
ProjectResults	Group	1
TotalResults	Attribute Short(Signed 16 Bit)	1	The number of results that match the given search parameters
* SearchResults	Group	1
** Project	Group	0..n
** Hidden	Attribute boolean	1	Determines if the project is hidden from view
** DisconnectionStatus	Attribute String	1	One of: WARNING ACTIVATED PROJECT DISCONNECTED
** Active	Attribute boolean	1	Determines if the project is "Active" or "De-activated"
*** CreationDate	String(24)	1	Standard DateTime in UTC format
*** DeliveryAddressLine	String(120)	1
*** DeliveryCity	String(25)	1
*** DeliveryCountry	String(25)	1
*** DeliveryPostcode	String(10)	1
*** DeliveryState	String(25)	1
*** FaxNumber	String(27)	1
*** LogoPath	String(255)	0..1	Relative URL path to project logo
*** ProjectOwnerOrganizationId	String	1
*** ProjectOwnerOrganizationName	String(120)	1
*** ProjectOwnerOrganizationTradingName	String(120)	1
*** PostalAddressLine	String(120)	1
*** PostalCity	String(25)	1
*** PostalCountry	String(25)	1
*** PostalPostCode	Short(10)	1
*** PostalState	String(25)	1
*** ProjectAddressLine	String(120)	1
*** ProjectCity	Sring(25)	1
*** ProjectCode	String(15)	1
*** ProjectCountry	String(25)	1
*** ProjectDescription	String(2GB)	1	Max of 2 GB worth of characters
*** ProjectId	String	1
*** ProjectName	String(100)	1
*** ProjectPostcode	String(10)	1
*** ProjectShortName	String(20)	1
*** ProjectState	String(25)	1
*** ProjectType	String(30)	1
*** ProjectValue	String	1	Decimal (2 decimal places) converted to String
*** ProjectResponsibilities	Group	1
**** ProjectResponsibility	Group	0..n
***** Responsibility	String(30)	1
***** Role	String(30)	1
*** StartDate	String(24)	1	Standard DateTime in UTC format
*** StopDate	String(24)	1	Standard DateTime in UTC format

Sample response

<?xml version="1.0" encoding="UTF-8"?>

<ProjectResults TotalResults="2">
    <SearchResults>
        <Project Hidden="false" DisconnectionStatus="NONE" Active="true">
            <CreationDate>2005-07-25T04:59:08.340Z</CreationDate>
            <DeliveryAddressLine>Unit 221 Buckhurst Grange1</DeliveryAddressLine>
            <DeliveryCity>Clearwater Bay1</DeliveryCity>
            <DeliveryCountry>Australia</DeliveryCountry>
            <DeliveryPostcode>6588221</DeliveryPostcode>
            <DeliveryState>New Devonshire1</DeliveryState>
            <FaxNumber>61922221111</FaxNumber>
            <LogoPath>/html/logos/aconex-stored/project/1879048400/2007-10-24-14-21-43-683.jpg</LogoPath>
            <ProjectOwnerOrganizationId>1879048492</ProjectOwnerOrganizationId>
            <ProjectOwnerOrganizationName>Majestic Inc.</ProjectOwnerOrganizationName>
            <ProjectOwnerOrganizationTradingName>Majestic</ProjectOwnerOrganizationTradingName>
            <PhoneNumber>61933332222</PhoneNumber>
            <PostalAddressLine>Unit 22 Buckhurst Grange</PostalAddressLine>
            <PostalCity>Clearwater Bay</PostalCity>
            <PostalCountry>Australia</PostalCountry>
            <PostalPostcode>658822</PostalPostcode>
            <PostalState>New Devonshire</PostalState>
            <ProjectAddressLine>Lagoon Road Main Beach</ProjectAddressLine>
            <ProjectCity>Bay Cove</ProjectCity>
            <ProjectCode>HVIP</ProjectCode>
            <ProjectCountry>Australia</ProjectCountry>
            <ProjectDescription/>
            <ProjectId>1879048400</ProjectId>
            <ProjectName>Hotel VIP Resort &amp; Spa</ProjectName>
            <ProjectPostcode>9050</ProjectPostcode>
            <ProjectShortName>Hotel VIP Resort</ProjectShortName>
            <ProjectState/>
            <ProjectType>Construction</ProjectType>
            <ProjectValue>1000000000.00</ProjectValue>
            <ProjectResponsibilities>
                <ProjectResponsibility>
                    <Responsibility>VIP Development Group</Responsibility>
                    <Role>Client</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Majestic</Responsibility>
                    <Role>Head Contractor</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Splice Architecture</Responsibility>
                    <Role>Architect</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Enzice</Responsibility>
                    <Role>Structural/Civil Eng</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Elan Engineering</Responsibility>
                    <Role>Mechanical Eng</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Apex Mechanical</Responsibility>
                    <Role>Electrical Engineer</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Infinitel</Responsibility>
                    <Role>Telecommunications</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Gulf Wide Consultant</Responsibility>
                    <Role>Services Consultant</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>AJ Hydraulics</Responsibility>
                    <Role>Hydraulic</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Flame Away</Responsibility>
                    <Role>Fire Services</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>FMI</Responsibility>
                    <Role>FIM</Role>
                </ProjectResponsibility>
            </ProjectResponsibilities>
            <StartDate>2005-07-24T14:00:00.000Z</StartDate>
            <StopDate>2012-08-27T14:00:00.000Z</StopDate>
        </Project>
        <Project Hidden="false" DisconnectionStatus="NONE" Active="true">
            <CreationDate>2005-09-05T03:33:26.130Z</CreationDate>
            <DeliveryAddressLine>PO Box 12 Port Quayside</DeliveryAddressLine>
            <DeliveryCity>South Ishta Quays</DeliveryCity>
            <DeliveryCountry>Australia</DeliveryCountry>
            <DeliveryPostcode>6253</DeliveryPostcode>
            <DeliveryState>Greenfields County</DeliveryState>
            <FaxNumber>61856443011</FaxNumber>
            <LogoPath>/html/logos/aconex-stored/project/215/2005-11-23-10-04-46-057.gif</LogoPath>
            <ProjectOwnerOrganizationId>1879048481</ProjectOwnerOrganizationId>
            <ProjectOwnerOrganizationName>Majestic Inc.</ProjectOwnerOrganizationName>
            <ProjectOwnerOrganizationTradingName>Majestic</ProjectOwnerOrganizationTradingName>
            <PhoneNumber>61856443012</PhoneNumber>
            <PostalAddressLine>PO Box 12 Port Quayside</PostalAddressLine>
            <PostalCity>South Ishta Quays</PostalCity>
            <PostalCountry>Australia</PostalCountry>
            <PostalPostcode>6253</PostalPostcode>
            <PostalState>Greenfields County</PostalState>
            <ProjectAddressLine>PO Box 12 Port Quayside</ProjectAddressLine>
            <ProjectCity>South Ishta Quays</ProjectCity>
            <ProjectCode>WGAMES</ProjectCode>
            <ProjectCountry>Australia</ProjectCountry>
            <ProjectDescription>The physical set up and organisation
                of the World Games.</ProjectDescription>
            <ProjectId>1879048407</ProjectId>
            <ProjectName>The World Games</ProjectName>
            <ProjectPostcode>6253</ProjectPostcode>
            <ProjectShortName>World Games</ProjectShortName>
            <ProjectState>Greenfields County</ProjectState>
            <ProjectType>Sporting Event</ProjectType>
            <ProjectValue>20000000000.00</ProjectValue>
            <ProjectResponsibilities>
                <ProjectResponsibility>
                    <Responsibility>Federated World Games Committe</Responsibility>
                    <Role>Client</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Global Arc - Geoff Stravinsky</Responsibility>
                    <Role>Project Manager</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Bild Construction Padma
                        Karako</Responsibility>
                    <Role>Construction Manager</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>NAC Solutions - Andrew Killer</Responsibility>
                    <Role>Business Solutions</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Poshe PR -Randy Maxwell
                        </Responsibility>
                    <Role>Public Relations</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Rapid Response - Li Feng
                        Ying</Responsibility>
                    <Role>Security</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>AT &amp; E -Signe Janssen</Responsibility>
                    <Role>Lighting Engineer</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Creativ Catering - Jane
                        Davies</Responsibility>
                    <Role>Catering</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Explosiv Pyrotechnic James
                        Lau</Responsibility>
                    <Role>Fireworks</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Life By Design Madeleine
                        Frodo</Responsibility>
                    <Role>Architect</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Heist - Elke Tocana</Responsibility>
                    <Role>Structural/ Civil</Role>
                </ProjectResponsibility>
                <ProjectResponsibility>
                    <Responsibility>Beijing Jinlong - Wang Cheng</Responsibility>
                    <Role>Mechanical Eng</Role>
                </ProjectResponsibility>
            </ProjectResponsibilities>
            <StartDate>2005-10-31T13:00:00.000Z</StartDate>
            <StopDate>2010-10-31T13:00:00.000Z</StopDate>
        </Project>
    </SearchResults>
</ProjectResults>

Error Codes Specific to the Service

StatusCode	Description	Http Status Code

Prerequisites

Required Permissions

The authorizing user (specified in the request header) must be associated with at least one project.

Preferences/Module Setup

Not Applicable.

Constraints

None listed for this service.

Get Project Logo

The service returns the current logo associated with the specified project.

URL structure

HTTP GET: https://{hostname}/api/project/logo?{parameters}

Parameters

Parameters	Type(maxlength)	Cardinality	Notes
projectid	Integer(signed 32 bit )	1	Required

Request Fields

Not Applicable. HTTP GET operations have no request body.

Sample request

https://au1.aconex.com/api/project/logo?projectid=10

Response Fields

Not applicable. The response is a binary stream of the logo associated with the project.

Sample response

Not applicable.

Error Codes Specific to the Service

Status Code	Description	HTTP Status Code
LOGO_NOT_FOUND	When project does not have any associated logo	400 Bad Request
USER_NOT_ON_PROJECT	When user is not on the project	401 Unauthorized

Prerequisites

Required Permissions

Requesting user must belong to the project for which the logo is being requested

Preferences/Module Setup

Not applicable.

Constraints

None.

Invite User To Project

This service invites a user into a project. Your request can provide a single userid, or a comma-separated list of userid’s to invite multiple users at once.

URL structure

POST: https://{hostname}/api/projects/{projectid}/users?userid={userid}

Parameters

Parameters	Type(maxlength)	Cardinality	Notes
userid	String(No Limit)	1	The userid to be invited to the project

Interface

Request Fields

This operation have no request body.

Sample request

https://au1.aconex.com/api/projects/1207959678/users?userid=1879049196

Response Fields

This service have no response

Error Codes Specific to the Service

Status Code	Description	HTTP Status Code
PROJECT_IS_BY_EXPLICIT_INVITATION_ONLY	The project invitation mode is explicit, users can only be invited through the web application	401 Unauthorized

Prerequisites

Required Permissions

User must be also participate in the project

Preferences/Module Setup

This API respects the rules of Invitation mode which can be set in Project Preference

Copy a project

This API is available from the February 2024 release. See release notes.

This service copies project in an organization using provided project ID

URL structure

HTTP POST -Create Project using Copy Project

HTTP POST: https://{hostname}/api/externalcopyproject

Parameters

Parameters	Type(maxlength)	Cardinality	Notes

Input Payload Template

Input Payload template-JSON to copy project

{

"projectId" :,
"projectName" : "",
"projectShortName" :"",
"projectCode" : "",
"projectType" : "",
"registerType" : "",
"startDate" : "",
"estimatedCompletionDate" : "",
"currency" : "",
"projectValue" : "",
"dateProjectStatusApplied" : ""

}

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.

Element	Type(maxlength)	Cardinality		Notes
projectId	Attribute Integer	1	Should not be null	Project ID of project to be copied
projectName	Attribute String	1	Should not be null MAX Length cannot exceed 60 characters	Name of copy Project Name
projectShortName	Attribute String	1	Should not be null MAX Length cannot exceed 20characters	Name of copy Project short Name
projectCode	Attribute String	1	Should not be null MAX Length cannot exceed 15 characters	Name of copy Project code
projectType	Attribute String	1	can be null MAX Length cannot exceed 20characters	Name of copy Project Type
registerType	Attribute String	1	Should not be null Allowed only {DOC,ITEM,INTERFACE,DEFECT,ASSET,ISSUE}	Provide register type
startDate	Attribute String	1	Should not be null Allowed format YYYY-MM-dd -eg:"2023-12-07	Provide Start date
estimatedCompletionDate	Attribute String	1	Should not be null Allowed format YYYY-MM-dd -eg:"2023-12-07	Provide estimated completion date
currency	Attribute String	1	Should not be null	Provide currency
projectValue	Attribute Integer	1	Should not be null Value should be greater than 0	Provide project value
dateProjectStatusApplied	Attribute String	1	Should not be null Allowed format YYYY-MM-dd -eg:"2023-12-07	Provide date project status applied

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

An response body

{
"message": "ProjRestAPI1 successfully copied.",
"status": "OK"
}

with HTTP status code 200 OK

Examples/Samples

Sample Request

Create a user role in a project
Sample request for creating a user role in project

https://au1.aconex.com/api/externalcopyproject

Request Body -Json

{
"projectId": 1879053459,
"projectName": "RestAPIProject1",
"projectShortName": "ProjRestAPI1",
"projectCode": "Test0001",
"projectType": "ExtAPICopy",
"registerType": "DOC",
"startDate": "2023-12-07",
"estimatedCompletionDate": "2023-12-08",
"currency": "INR",
"projectValue": "500",
"dateProjectStatusApplied": "2023-12-07"
}

Sample Response with HTTP status code 200 OK

{
"message": "ProjRestAPI1 successfully copied.",
"status": "OK"
}

Error Codes Specific to the Service

Status Code	Description	HTTP Status Code
LOGIN_FAILED	Login failed - username or password incorrect	401 Unauthorized
UNAUTHORIZED	USER not permitted to use API	401 Unauthorized
NOT_FOUND	Project with no CONTRACTUAL METADATA	404 Not Found
BAD REQUEST	projectName already exists	400 Bad Request
BAD REQUEST	projectshortName already exists	400 Bad Request
BAD REQUEST	projectName is exceeding max limit 60/blank	400 Bad Request
BAD REQUEST	projectshortName is exceeding max limit 20/blank	400 Bad Request
BAD REQUEST	projectcode is exceeding max limit 15/blank	400 Bad Request
BAD REQUEST	projectType is exceeding max limit 20	400 Bad Request
BAD REQUEST	registerType is blank / other than {DOC,ITEM,INTERFACE,DEFECT,ASSET,ISSUE}	400 Bad Request
BAD REQUEST	valid startDate format-YYYY-MM-dd eg :2023-12-07	400 Bad Request
BAD REQUEST	valid estimatedCompletionDate format-YYYY-MM-dd eg :2023-12-07	400 Bad Request
BAD REQUEST	estimatedCompletionDate<=startDate eg : "startDate": "2023-12-07", "estimatedCompletionDate": "2023-12-07". or "startDate": "2023-12-07", "estimatedCompletionDate": "2023-12-06".	400 Bad Request
BAD REQUEST	currency is blank	400 Bad Request
BAD REQUEST	projectValue is blank	400 Bad Request
BAD REQUEST	valid dateProjectStatusApplied format-YYYY-MM-dd eg :2023-12-07	400 Bad Request

¿Qué sigue?

Getting started with APIs

Open Kaltura Popup

En este artículo

Artículos relacionados

Projects API Developer Guide

List Projects for User

URL structure

Parameters

Interface

Error Codes Specific to the Service

Prerequisites

Preferences/Module Setup

Constraints

Get Project Logo

URL structure

Parameters

Error Codes Specific to the Service

Prerequisites

Constraints

Invite User To Project

URL structure

Parameters

Interface

Response Fields

Error Codes Specific to the Service

Prerequisites

Copy a project

Input Payload Template

Examples/Samples

Error Codes Specific to the Service

¿Qué sigue?