Support Central
We’ve updated our APIs to support projects enabled with Renditions.
Before you enable renditions on a project, you'll need to update your API integrations to support secondary files for documents. Existing integrations will continue to work for projects that are not enabled with Renditions.
In this article you'll find a summary of changes for Documents and Mail APIs followed by the details for each updated endpoint.
You must use a new request model when registering or updating documents using APIs.
When searching, the following response fields continue to represent the primary file: Filename, FileType, and FileSize.
Two new response fields have been introduced:
Users integrating with Renditions should update their implementations to:
There's a new includeSecondary flag when sending or saving a Transmittal or Tender Transmittal. This flag determines if secondary files should be included with a document:
When viewing or listing mail, a new SecondaryFiles block is returned for secondary files. Existing FileName and FileSize fields continue to represent the primary file. AttachmentFileSize is the total size of the primary file size plus all included secondary files.
Users integrating with Renditions should update their implementations to:
The document registration schema is enhanced to support new Renditions-related fields.
Changes:
Sample Response:
........ COMPLEX TempDocumentIds TempDocumentIds TempDocument STRING Id id STRING Type type tempDocument ........ BOOLEAN Renditions Renditions ........... COMPLEX Secondary Files secondaryFiles File STRING FileSize fileSize STRING FileType fileType STRING Filename filename file ........... INTEGER File Count fileCount
Metadata responses for Renditions documents now expose file-set information.
Changes:
Sample Response:
CONT_12345 CONT_12345 Manual 1 2 50869 EP01.pdf 83456 doc EP01.doc
Document search responses can now return Renditions file-set information.
Changes:
Sample Request:
GET /api/projects/1207959554/register?search_query=doctype:%20Drawing&return_fields=docno,filecount,title,secondaryFiles&search_type=NUMBER_LIMITED&search_result_size=75&sort_field=docno&sort_direction=ASC&show_document_history=trueSample Response:
CONT_12346 2 249344 doc O&T-2006.doc CONT_12346 DNN_1034 0 DNN_1034
Drawing search responses follow the same Renditions pattern as document search.
Changes:
Sample Request:
GET /api/projects/1207959554/drawings?search_query=doctype:%20Drawing&return_fields=docno,filecount,title,secondaryFiles&search_type=NUMBER_LIMITED&search_result_size=75&sort_field=docno&sort_direction=ASC&show_document_history=true
Sample Response:
CONT_12346 2 249344 doc O&T-2006.doc CONT_12346 DNN_1034 0 DNN_1034
The All-Filters List Documents API can now return Renditions file-set information.
Changes:
Sample Request:
POST /api/projects/1207959554/register/search
{
"orgId": "1879048492",
"userId": "1879049107",
"returnFields": [
"docno",
"title",
"doctype",
"filename",
"printSize",
"comments",
"attribute1",
"attribute2",
"fileCount",
"secondaryFiles"
],
"resultSize": "25",
"returnTransmittalIds": "false"
}
Sample Response:
{
"searchResults": [
{
"id": 271341877549172398,
"documentNumber": "CONT_12345",
"title": "CONT_12345",
"documentType": "Manual",
"comments": "",
"printSize": "1",
"filename": "EP01.pdf",
"fileCount": 2,
"secondaryFiles": [
{
"filename": "EP01.doc",
"fileSize": "83456",
"fileType": "doc"
}
]
},
{
"id": 271341877549122393,
"documentNumber": "DNN_1034",
"title": "DNN_1034",
"documentType": "Drawing",
"comments": "",
"printSize": "1",
"filename": "",
"fileCount": 0,
"secondaryFiles": []
}
],
"totalResultsCount": 2,
"totalResultsOnCurrentPage": 2,
"totalNumberOfPages": 1,
"currentPageNumber": 1,
"singlePageSize": 25
} Document registration now supports creating a single document record with a primary file and secondary files.
Changes:
Sample Request using TempDocumentIds:
POST /api/projects/1207959554/register HTTP/1.1 --myboundary--myboundary-- DNN_123456121 1879048197 1 Majestic Builders Civil 1879048196 A4 false 2026-03-06T12:00:00.000Z false true 3453453535 Primary 767576 Secondary
Sample Request using direct file content:
POST /api/projects/1207959554/register HTTP/1.1 --myboundary--myboundary X-Filename: primary.pdf cHJpbWFyeSBmaWxlIGNvbnRlbnRzCg== --myboundary X-Filename: secondary1.doc Zmlyc3Qgc2Vjb25kYXJ5IGZpbGUgY29udGVudHMK --myboundary X-Filename: secondary2.dwg c2Vjb25kIHNlY29uZGFyeSBmaWxlIGNvbnRlbnRzCg== --myboundary-- doc_reg_multi_1 1207959557 1 Majestic Builders Concrete Works 1207959618 false 2026-04-06T12:00:00.000Z true true
Document supersede now supports replacing the full Renditions file set.
Changes:
Sample Request using TempDocumentIds:
POST /api/projects/1207959554/register/271341877549322396/supersede --myboundary--myboundary-- 1879048197 2 Majestic Builders Civil 1879048196 A4 false 2026-04-06T12:00:00.000Z false true 8453453535 Primary 867576 Secondary
Sample Request using direct file content
POST /api/projects/1207959554/register/271341877549322396/supersede --myboundary--myboundary X-Filename: primary.pdf cHJpbWFyeSBmaWxlIGNvbnRlbnRzCg== --myboundary X-Filename: secondary1.doc Zmlyc3Qgc2Vjb25kYXJ5IGZpbGUgY29udGVudHMK --myboundary X-Filename: secondary2.dwg c2Vjb25kIHNlY29uZGFyeSBmaWxlIGNvbnRlbnRzCg== --myboundary-- 1207959557 2 Majestic Builders Concrete Works 1207959618 false 2026-04-06T12:00:00.000Z true true
File download now supports Renditions documents with multiple files.
Changes:
Sample Request:
GET /api/projects/1207959554/register/271341877549172398/?fileName=EP01.doc>
Create Mail now supports Renditions-aware document attachment behavior for transmittal mail types.
Changes:
POST /api/projects/1879053193/mail --myboundary Content-Type: application/vnd.aconex.mail.v3+xml--myboundary X-DocumentId: 271341877555449767 includeSecondary: false --myboundary X-DocumentId: 271341877555449768 includeSecondary: true --myboundary-- Transmittal with Renditions documents 23 1 1 2028-11-21T12:00:00.000Z true 1879053295 false 2
Save To Draft supports the same Renditions-aware attachment behavior as Create Mail for transmittal mail types.
Changes:
POST /api/projects/1879053193/mail?is_draft=true --myboundary Content-Type: application/vnd.aconex.mail.v3+xml--myboundary X-DocumentId: 271341877555449767 includeSecondary: true --myboundary-- Draft transmittal with Renditions documents 23 1 1 2028-11-21T12:00:00.000Z true 1879053295 false 1
Reply Mail supports the same Renditions-aware attachment behavior as Create Mail for transmittal mail types.
Changes:
POST /api/projects/1879053193/mail/1879167861/reply --myboundary Content-Type: application/vnd.aconex.mail.v3+xml--myboundary X-DocumentId: 271341877555449767 includeSecondary: true --myboundary-- Reply with Renditions document 23 1 1 2027-11-21T12:00:00.000Z true 1879053295 false 1
Forward Mail supports Renditions-aware attachment behavior for both newly attached documents and forwarded attachments on transmittal mail types.
Changes:
POST /api/projects/1879053193/mail/1879167861/forward --myboundary Content-Type: application/vnd.aconex.mail.v3+xml--myboundary X-DocumentId: 271341877555449767 includeSecondary: true --myboundary X-AttachmentId: 35353535 includeSecondary: false --myboundary-- Forward with Renditions document and attachment 23 1 1 2029-11-21T12:00:00.000Z true 1879053295 false 2
Register Mail supports the same Renditions-aware attachment behavior as Create Mail for transmittal mail types.
Changes:
POST /api/projects/1879053193/mail/register --myboundary Content-Type: application/vnd.aconex.mail.v3+xml--myboundary X-DocumentId: 271341877555449767 includeSecondary: true --myboundary-- Registered transmittal with Renditions document 256 1 1 2028-11-21T12:00:00.000Z true 1879053295 false 1
Mail metadata responses now expose secondary file information when an attached registered document includes secondary files.
Changes:
Sample Response:
TRM-000124 Renditions transmittal Transmittal 1879167990 271341877555449767 alcala.pdf 57344 79980 alcala.dwg 79980 alcala.xlsx
List Mail now reflects the total size of all included files for Renditions document attachments.
Changes: