/
API Release Notes

API Release Notes

Latest Version Details

Version

25.12

Release Date

04-Dec-2025

REST Url

https://au.itwocx.com/api/25.12/api/help/index

SOAP Url

https://au.itwocx.com/api/25.12/CXApi.svc

  1. You require a license to use the API. Please contact your RIB Account Manager for pricing and further information.

  2. The user you are connecting with and project(s) you are connecting to need to be enabled for the API. If you have a license please contact Support to enable this.

Change Log

Version

Release Date

End of Life

REST Changes

SOAP Changes

Version

Release Date

End of Life

REST Changes

SOAP Changes

25.12

 

11-Feb-2026

01-Aug-2026

New Interfaces

  1. Get → Redirect from User/GetGroups

  2. GetById - single result if user can acces.

  3. GetByCode - single result if user can access.

  4. GetByUserId - all groups user can access.

  5. GetByUserCode - all groups user can access.

  6. Create - if contacts module admin or project admin.

  7. Update - if contacts module admin or project admin and can edit group.

  8. Restore

  9. Retire

Extended GroupEntityDto

  1. IsAllowMultiple

  2. IsEnumerate

Create or Update will validate for duplicate codes.

 

04-Dec-2025

01-Aug-2026

  • New Interfaces

    • DesignReviewIssue

      • Create (DesignReviewIssueDto)

      • Import (DesignReviewIssueDto) - Project Admin Only

  • Updated Interfaces

    • Attachment/Upload

      • Added: commentId (int32) - Link attachment to Comment by the same user, or any comment for Project Admins.

  • Updated Models

    • AttachmentDto

      • Added: CommentId (int32)

 

25.08

21-Aug-2025

01-Apr-2026

  • New Interfaces

    • DistributionTransmittal

      • Get (DistributionTransmittalDto[])

      • GetById (DistributionTransmittal)

      • GetByIds (DistributionTransmittalDto[])

    • DesignReviewIssue - Added 12-Nov-2025

      • Create (DesignReviewIssueDto) - Same as Document.Create with additional Revision property, which can be populated with either:

        • Id
          or

        • RegisterDocId
          or RegisterDoc.Reference + RegisterDoc.FileName*
          +
          Revision.Value + Revision.DateTime*

      • Import (DesignReviewIssueDto) - Project Administrators Only, allows to specify the author and comments.

  • Updates Interfaces

    • Transmittal

      • Get - will only return Upload Transmittals.

    • SavedSearch/GetExcelData

      • Optional Parameter: maxResults (int)

  • Updated Models

    • ControlSheetCashFlowItem

      • Added: CashflowRowType (enum)

      • Added: IsExpanded (bool)

      • Added: SourceColumnName (string)

    • TransmittalDocDto

      • Added: DistributionTransmittalDocId (long) - References parent distribution transmittal for child transmittals.

  • New Models

    • DistributionTransmittalDocDto : DocumentDto

      • Revisions (RevisionDto[])

      • Distributions (TransmittalDistributionDto[])

      • TransmittalIds (long) - References child transmittal ids, which can get retrieved with Transmittal/GetById(s)

 

25.04

16-Apr-2025

01-Dec-2025

  • New Models

    • StatusCategoryDto

      • Name (string)

      • Color (string)

      • CategoryType (string)

      • IncludeInProgress (bool)

      • StatusIds (int32[])

  • Updated Interfaces

    • Contract/Get

      • Optional Parameter: includeWithdrawn (bool)

    • DesignReviewIssue/GetById, GetByIds

      • Optional Parameter: includeComments (bool)

    • DocSetting/Get. GetById, GetByCode, GetByIds, GetByCodes, GetByType

      • Optional Parameter: includeStatusCategories (bool)

  • Updated Models

    • ContractVariationDto

      • Added: AssessedTotal (double)

    • ContractVariationLineItemDto

      • Added: AssessedQty (double)

      • Added: AssessedRate (double)

      • Added: AssessedAmount (double)

    • DesignReviewIssueDto

      • Added: WorkflowDocId (int64)

      • Added: PageNumber (int32)

    • DocumentSettingDto

      • Added: StatusCategories (StatusCategoryDto[])

    • SavedSearch/GetExcelData

      • Date format updated JSON standard

 

24.12

19-Dec-2024

01-Aug-2025

  • New Interfaces

    • DesignReviewIssue

      • Get (DesignReviewIssueDto[])

      • GetById (DesignReviewIssueDto)

      • GetByIds (DesignReviewIssueDto[])

  • New Models

    • DesignReviewIssueDto : DocumentDto

      • Revision (RevisionDto)

 

24.08

14-Aug-2024

01-Apr-2025

  • New Interfaces

    • ControlSheet/GetCashFlow (CashFlowControlSheetDto)

  • Updated Interfaces

    • Document/Update

      • Title can now be updated.

  • Updated Models

    • DocumentDto

      • Renamed: OpenedDate to FirstViewedDate

  • New Models

    • CashFlowControlSheetDto

      • ProjectId (int32)

      • ControlSheetId (int32)

      • ContractSheetName (string)

      • BudgetId (int64)

      • BudgetForecast (ControlSheetCashFlowItem[])

      • ManualForecast (ControlSheetCashFlowItem[])

      • TotalBudgetForecast (ControlSheetCashFlowItem)

      • TotalManualForecast (ControlSheetCashFlowItem)

      • CumulativeForecast (ControlSheetCashFlowItem)

      • TotalForecast (ControlSheetCashFlowItem)

      • PeriodWeightings (int32[])

    • ControlSheetCashFlowItem

      • Id (int32)

      • LineItemId (int64)

      • ItemNumber (string)

      • Level (int32)

      • Code (string)

      • Description (string)

      • IsHeader (bool)

      • ForecastFinalCost (double)

      • CertifiedToDate (double)

      • CostToComplete (double)

      • Profile (int32)

      • StartDate (dateTime)

      • FinishDate (dateTime)

      • Allocation (AllocationEntry[])

    • AllocationEntry

      • Period (string)

      • Value (double)

 

24.04

10-Apr-2024

01-Dec-2024

  • Updated Models

    • BudgetVariationDto

      • Added: LinkedBudgetId (int64)

 

23.12

05-Dec-2023

01-Aug-2024

  • Updated Interfaces

    • DocSetting/Get

    • DocSetting/GetByIds 

      • Optional Parameter: includeStatuses (bool)

      • Optional Parameter: includeUserFields (bool)

  • Updated Models

    • Revision

      • Added: SummaryFileInfo

    • UserFieldBase:

      • Removed: NotCopyForSplit

      • Added: SplitType

      • Added: UserfieldDefaultValues

23.08

09-Aug-2023

01-Apr-2024

  • New Interfaces

    • Budget/GetLineItemPdfFile (File)

    • Login/GetUrl (string)

  • Updated Interfaces

    • Company/Get

      • Optional Parameter: includeRetired (bool)

    • User Get

      • Optional Parameter: includeRetired (bool)

  • Updated Models

    • CompanyDto

      • Added: IsRetired (bool)

    • DocSettingDto

      • Added: FolderId (int32)

      • Added: FolderPath (string)

    • UserDto

      • Added: IsRetired (bool)

    • UserFieldSettingDto

      • Added: IsRetired (bool)

  • Updated Models

    • FolderType

      • Added: Dashboard

23.04

12-Apr-2023

05-Dec-2023

  • New Interfaces

    • Annotation/GetByRevisionIds (AnnotationDto[])

    • Annotation/GetByRegisterDocIds (AnnotationDto[])

    • Annotation/GetAnnotatedRevisionPdf (File)

    • Annotation/AddToRevision (AnnotationDto)

    • Attachment/DownloadFile (File)

    • Budget/GetByLineItemId (BudgetDto)

    • Budget/GetLineItemById (BudgetLineItemDto)

    • Company/Update (CompanyDto)

    • DocSetting/GetOptions (UserfieldOptionDto[])

    • DocSetting/UpsertOptions (UserfieldOptionDto[], docSettingCode, userFieldCode)

    • DocSetting/RemoveOptions (UserfieldOptionDto[], docSettingCode, userFieldCode)

    • Document/GetDocumentAsPdfFile (File)

    • Document/Split (DocumentDto, splitFromDocumentId)

    • RegisterDoc/GetByNames (RegisterDocDto[])

    • Revision/DownloadFile (File)

    • VersionSet/Get (VersionSetDto[])

    • VersionSet/GetById (VersionSetDto)

    • VersionSet/GetByName (VersionSetDto)

    • VersionSet/GetByIds (VersionSetDto[])

    • VersionSet/GetRevisions (RevisionDto[])

    • WorkflowDoc/Get (WorkflowDocDto[])

    • WorkflowDoc/GetById (WorkflowDocDto)

    • WorkflowDoc/GetByIds (WorkflowDocDto[])

    • WorkflowDoc/GetVerdicts (WorkflowVerdictDto[])

  • Updated Interfaces

    • Document/GetByIds

      • Optional Parameter: includeUserFields (bool)

    • GlobalCompany/Update

      • Optional Parameter: allProjects (bool)

    • RegisterDoc/GetById, GetByName, GetByIds

      • Optional Parameter: includeLatestRevision (bool)

      • Optional Parameter: includeUserFields (bool)

  • Added Models

    • AnnotationDto

      • LayerId (int32)

      • LayerType (string)

      • UserCode (string)

      • RevisionId (int32)

      • RegisterDocId (int64)

      • PageNumber (int32)

      • Type (string)

      • Points (PointDto[])

      • Color (string)

      • StrokeWidth (int32)

      • ContainerHeight (float)

      • ContainerWidth (float)

      • DocumentId (int64)

    • PointDto

      • X (float)

      • Y (float)

    • FormWorkflowDto

      • Id (int32)

      • Name (string)

      • SecurityId (int32)

      • RowStatus (int32)

    • UserfieldOptionDto

      • Id (int32)

      • Code (string)

      • Description (string)

      • IsDisabled (bool)

      • Mappings (string[])

    • VersionSetDto

      • Id (int32)

      • Name (string)

      • Description (string)

      • SecurityId (int32)

      • IsRetired (bool)

    • WorkflowDocDto : DocumentDto

      • WorkflowRevisions (WorkflowRevisionDto[])

      • WorkflowId (int32)

      • WorkflowName

    • WorkflowRevisionDto : RevisionDto

      • Id (int32)

      • Verdicts (WorkflowDocRevisionDto[])

    • WorkflowDocVerdictDto