Request Fields
Not Applicable. HTTP GET operations have no request body.
https://au1.aconex.com/api/projects/1879048400/register/schema
Response Fields
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 |
|---|---|---|---|
|
RegisterSchema |
Group |
1 |
|
|
projectName |
Attribute |
1 |
|
|
projectId |
Attribute |
1 |
|
|
autoNumberingEnabled |
Attribute |
1 |
Is Basic Auto Numbering OR Project-Wide Auto-Numbering enabled for this project. |
|
* EntityCreationSchemaFields |
Group |
1 |
The fields here will describe the XML document that must be submitted to the register document API service when registering a new document. |
|
** MultiValueSchemaField |
Group |
0..n |
There may be many repetitions of this element, along with SingleValueSchemaField, presented in no particular order |
|
*** Attributes |
Group |
1 |
|
|
**** EntityField |
No type |
1 |
|
|
**** MandatoryStatus |
Attribute |
1 |
Determines if the field must be specified when creating a piece of project mail. One of:
|
|
***** MandatoryRules |
Group |
0...n |
The child elements of this element describe the rules that make the field mandatory |
|
****** Rule |
Group |
1...n |
Defines a single rule on which this field becomes mandatory |
|
******* Identifier |
String |
1 |
The identifier of another entity creation field which if specified in the XML post content, makes this schema field mandatory |
|
******** SchemaValues |
Group |
0...n |
|
|
********* SchemaValue |
Group |
1...n |
|
|
*********Id |
Integer |
1...n |
If the field the identifier of the rule refers to is a multi value schema field,this Id will refer to one or more of the values which apply to this rule. Values outside of the Id's specified here do not make this field mandatory |
|
*** DataType |
String |
1 |
One of : |
|
*** FieldName |
String(No Limit) |
1 |
Field (label) name used in the application, for display purposes |
|
*** Identifier |
String |
1 |
Predefined set of identifiers of XML elements that should be sent as part of the register document request when registering a new document. These fields will depend on project configuration, possible values may include:
|
|
*** SchemaValues |
Group |
1 |
|
|
**** SchemaValue |
Group |
0..n |
|
|
***** Id |
Integer(Signed 32 bit) |
0..1 |
A valid value for this field |
|
***** Value |
String |
1 |
A string representation for the value |
|
*****AutoNumberScheme |
String |
1 |
A string will be true/false depending on the auto-numbering scheme enabled for that document type. This will be only for identifier DocumentTypeId |
|
** SingleValueSchemaField |
Group |
0..n |
There may be many repetitions of this element, along with MultiValueSchemaField, presented in no particular order |
|
*** Attributes |
Group |
1 |
|
|
**** EntityField |
No type |
1 |
|
|
**** MandatoryStatus |
Attribute |
1 |
Determines if the field must be specified when creating a piece of project mail. One of:
|
|
****** Rule |
Group |
1...n |
Defines a single rule on which this field becomes mandatory |
|
******* Identifier |
String |
1 |
The identifier of another entity creation field which if specified in the XML post content, makes this schema field mandatory |
|
******** SchemaValues |
Group |
0...n |
|
|
********* SchemaValue |
Group |
1...n |
|
|
*********Id |
Integer |
1...n |
If the field the identifier of the rule refers to is a multi value schema field,this Id will refer to one or more of the values which apply to this rule. Values outside of the Id's specified here do not make this field mandatory |
|
*** DataType |
String |
1 |
One of : |
|
*** FieldName |
String(No Limit) |
1 |
Field (label) name used in the application, for display purposes |
|
*** Identifier |
String |
1 |
Predefined set of identifiers of XML elements that should be sent as part of the register document request when registering a new document. These fields will depend on project configuration, possible values may include:
|
|
* SearchSchemaFields |
Group |
1 |
|
|
** MultiValueSchemaField |
Group |
0..n |
There may be many repetitions of this element, along with SingleValueSchemaField, presented in no particular order |
|
*** Attributes |
Group |
1 |
|
|
**** SearchResultField |
No type |
0..1 |
The presence of this element indicates that the field may be returned in search results |
|
**** sortable |
Attribute |
1 |
Determines if the field may be used to sort the search results |
|
**** SearchableField |
No type |
0..1 |
The presence of this element indicates that the field may be used as a search parameter |
|
*** DataType |
String |
1 |
One of : |
|
*** FieldName |
String(No Limit) |
1 |
Field (label) name used in the application, for display purposes |
|
*** Identifier |
String |
1 |
Predefined set of string values depending on project configuration, possible values may include:
|
|
*** SchemaValues |
Group |
0..1 |
|
|
**** SchemaValue |
Group |
0..n |
|
|
***** Id |
Long(10) |
0..1 |
A valid value for this field |
|
***** Value x |
String(100) |
1 |
A string representation for the value |
|
*****AutoNumberScheme |
String |
1 |
A string will be true/false depending on the auto-numbering scheme enabled for that document type. This will be displayed only for identifier doctype |
|
** SingleValueSchemaField |
Group |
0..n |
There may be many repetitions of this element, along with MultiValueSchemaField, presented in no particular order |
|
*** Attributes |
Group |
1 |
|
|
**** SearchResultField |
No type |
0..1 |
The presence of this element indicates that the field may be returned in search results |
|
**** sortable |
Attribute |
1 |
Determines if the field may be used to sort the search results |
|
**** SearchableField |
No type |
0..1 |
The presence of this element indicates that the field may be used as a search parameter |
|
*** DataType |
String |
1 |
One of : |
|
*** FieldName |
String(No Limit) |
1 |
Field (label) name used in the application, for display purposes |
|
*** Identifier |
String |
1 |
Predefined set of string values depending on project configuration, values may include:
|
INTEGER Status DocumentStatusId 1 Approved 12 Approved Subject to Comments 1879048205 As-Built 1879048216 For Construction 1879048196 For Information 1879048327 For Review 1879048198 For Tender 1879048330 Revise and Re-Submit BOOLEAN Has Backing File HasFile BOOLEAN Check 2 Check2 STRING VDR Code Vdrcode VDR001 VDR002 STRING Attribute 4 Attribute4 Attrib4-Val1 Attrib4-Val2 Attrib4-Val3 STRING Contractor Rev. ContractorRev RATIO Scale Scale STRING Contractor Doc No ContractorDocumentNumber STRING Project Field 1 ProjectField1 INTEGER Confidential AccessList STRING Author Author STRING Title Title STRING Attribute 3 Attribute3 Attrib3-Val1 Attrib3-Val2 Attrib3-Val3 STRING Vendor Doc No VendorDocumentNumber DATE Date Approved DateApproved DATE Date Reviewed DateReviewed STRING Authorised by AuthorisedBy BOOLEAN Contract Deliverable ContractDeliverable INTEGER Type DocumentTypeId 1879048197 Drawing false 1879048365 Manual false 1879048217 Program false 1879048366 Report false 1879048227 Sample false 1879048226 Schedule false 1879048225 Sketch false 1879048207 Specifications false 1879048228 Technical Data false DATE Milestone Date MilestoneDate BOOLEAN Check 1 Check1 INTEGER Percent Complete PercentComplete STRING Comments Comments STRING Comments 2 Comments2 STRING Vendor Rev. VendorRev DATE Date To Client ToClientDate STRING Contract No ContractNumber CN001 CN002 CN003 STRING Package No PackageNumber P001 P002 P003 DATE Date 1 Date1 STRING Attribute 1 Attribute1 Administration Events Centre Marina North Tower Hotel Podium Retail Building South Tower Hotel Spa Building STRING Revision Revision DATE Planned Submission Date PlannedSubmissionDate STRING Attribute 2 Attribute2 WP1.01 - Piling WP1.02 - Sheet Piling & Retaining Walls WP1.03 - Bulk Excavation (inc. Pile Mat & Probing) WP1.04 - Ground Works (inc. Grade Concrete Slab) WP1.05 - Superstructure Concrete WP2.02 - Structural Steelwork WP2.02 - Tan WP2.03 - Metal Decking WP2.04 - Underground Drainage WP3.01 - Cladding WP3.02 - Planar Glazing WP3.03 - Rain Screen Cladding WP3.04 - Gutters WP3.05 - Glazed Roof WP3.06 - Podium Mesh Cladding WP3.07 - Fire System WP3.08 - Alarm System WP3.09 - Electrical Fitout WP3.10 - Plumbing WP4.01 - Builders Clean WP4.02 - Dry Lining WP4.03 - Plaster & Screeding WP4.04 - Suspended Ceilings WP4.05 - Stone Floor Finishes WP4.06 - Ceramic Tiling WP4.07 - Carpets/Timbers/Vinyl Flooring WP4.08 - Painting & Decoration WP4.09 - Signage WP4.10 - Artwork/Statues WP4.11 - Intenral Fitout WP4.11 - Internal Fitout WP5.01 - Internal Electrical Installation WP5.02 - Mains Electrical Supply DATE Date Created DateCreated BOOLEAN As-Built Required AsBuiltRequired DATE Date 2 Date2 STRING Document No DocumentNumber STRING Project Field 2 ProjectField2 STRING Tag No TagNumber STRING Reference Reference STRING Discipline Discipline Architectural Civil Electrical Faade Facade Fire Services Hydraulics Internal Fitout Landscape Mechanical Project Wide Structural STRING Category Category Cat001 Cat002 Cat003 Cat004 STRING Print Size PrintSize DATE Revision Date RevisionDate DATE Date For Review DateForReview STRING Project Field 3 ProjectField3 STRING Document No docno DATE Date Approved approved BOOLEAN Current Revision current STRING Print Size printSize INTEGER Number of Markups numberOfMarkups STRING Author author DATE Markup Last Modified Date markupLastModifiedDate DATE Markup Date markupdate STRING Attribute 2 attribute2 Emissions Energy IEQ Innovation Land Use & Ecology Management Materials Transport Water DATE Date Modified registered STRING Attribute 1 attribute1 Administration Basement Car Park External Works Office Tower INTEGER Status statusid 5 For Approval 1879048196 For Information STRING Filename filename STRING Title title BOOLEAN Confidential confidential STRING Revision revision STRING Type doctype Specifications false STRING Discipline discipline Architectural Construction Management Electrical Hydraulic Interior Design QA Structural STRING File size fileSize STRING Comments comments STRING Comments 2 comments2 DATE Revision Date revisiondate