API Release Notes

Owned by Daniel Finn
Last updated: May 03, 2024
3 min read

Latest Version Details

Version

23.12
Release Date05-Dec-2023
REST Urlhttps://au.itwocx.com/api/23.12/api/help/index
SOAP Url

https://au.itwocx.com/api/23.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

VersionRelease DateEnd of LifeREST ChangesSOAP Changes
24.0410-Apr-2024


23.1205-Dec-202301-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.0809-Aug-202301-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.0412-Apr-202305-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
      • UserCode (string)
      • Comment (string)
      • VerdictId (int32)
      • VerdictName (string)
      • StepOrder (double)
      • StepName (string)
      • StepType (string)
      • ActionType (string)
      • LastUpdateTime (datetime)
      • Markups (WorkflowMarkupDto[])
    • WorkflowMarkupDto
      • RevisionId (int32)
      • RevisionValue (string)
      • UploadedTime (datetime)
    • WorkflowVerdictDto
      • Id (int32)
      • Name (string)
      • SecurityId (int32)
      • ReviewResult (string)
      • RevisionStatusId (int32)
  • Updated Models
    • DocumentDto
      • FormWorkflowId (int32)
    • UserfieldValueDto
      • RevisionId (int32)
    • DocumentSettingDto
      • FormWorkflows (FormWorkflowDto[])
    • UserfieldSettingDto
      • EditStatusIds (int32[])
    • RevisionDto
      • StatusDescription (string)
    • TenderPackageDto
      • AcceptedBidderId (int32)
      • AwardedBidderId (int32)
    • StatusActionDto
      • FormWorkflowId (int32)
  • Updated Models
    • CxDocument
      • Added: FormWorkflow
    • AddressingSetting
      • Added: ShowBusinessNo
      • Added: ShowEmail
    • DocumentSetting
      • Added: FormWorkflowList
    • StatusAction
      • Added: FormWorkflowId
    • PrjDocSettingUfSecurity
      • Added: CanEditAuthor
      • Added: CanEditNonAuthor
      • Added: CanViewAuthor
      • Added: CanViewNonAuthor
  • Retired Interfaces
    • GetAttachmentId
    • GetDocumentId
22.1206-Dec-202209-Aug-2023
  • New Interfaces
    • Company/Rename (id, newCompanyCode, updatePreferCode)
    • Document/ImportComment (CommentDto)
    • Security/GetById (SecurityDto)
    • Security/GetByIds (SecurityDto[])
    • User/Rename (id, newUserCode, updatePreferCode)
  • Updated Interfaces
    • Document/GetDocumentAsPdf
      • Optional Parameter: relativeLinks (bool)
      • Optional Parameter: showHistory (bool)
  • Added Models
    • SecurityDto
      • Id (int32)
      • ModelType (string)
      • Levels (SecurityLevelDto[])
    • SecurityLevelDto
      • Type (string)
      • Level (int32)
      • SecurityString (string)
    • TenderAddendumDto
      • SetSequence (int32)
      • IssuedDate (date-time)
      • IsResetSubmissions (bool)
  • Updated Models
    • BidderDto
      • Added BidderUserCode (string)
    • ClaimDto
      • Added RetentionManual (double)
    • DocumentSettingDto
      • Added SecurityId (int32)
    • StatusSettingDto
      • Added SecurityId (int32)
    • UserfieldSettingDto
      • Added SecurityId (int32)
      • Added IsCommon (bool)
    • StatusActionDto
      • Added SecurityId (int32)
    • FolderDto
      • Added SecurityId (int32)
    • TenderPackageDto
      • WithdrawnBidderIds (int32[])
      • Addendums (TenderAddendumDto[])
  • Updated Models
    • Session
      • Type - enum options updated.
    • CxAttachment
      • Added: RowStatus
      • Added: SourceAttachmentId
    • UserfieldValue
      • Change: Lattitude - from double to decimal
      • Change: Longitude - from double to decimal


22.0803-Aug-202212-Apr-2023
  • New Interfaces
    • DocSetting/GetByType (DocumentSettingDto)
    • ExternalUser/Get (UserDto[])
    • ExternalUser/GetById (UserDto)
    • ExternalUser/GetByIds (UserDto[])
    • PaymentCertificate/Create (PaymentCertificateDto)
    • RegisterDoc/Move (ids[], folderId)
    • RegisterDoc/Retire (ids[])
    • RegisterDoc/Restore (ids[])
    • Report/ProcessExcel (ExcelDataDto)
    • SavedSearch/Get (SavedSearchDto[])
    • SavedSearch/GetById (SavedSearchDto)
    • SavedSearch/GetExcel (File: xlsx)
    • SavedSearch/GetExcelData (ExcelDataDto)
    • User/GetByEmailAddress (UserDto)
  • Updated Interfaces
    • Transmital/Create
      • Optional Parameter: sendNotification (bool)
  • Added Models
    • SavedSearchDto
      • Id (int64)
      • FolderId (int32)
      • Name (string)
      • Description (string)
      • Path (string)
      • Timestamp (int64)
  • Updated Models
    • BidderDto
      • Added: BidderUserId (int32)
    • LinkedDocumentDto
      • Added: CommentId (int64)
    • DocumentSettingDto
      • Added: FormVersion (int32)
    • RevisionDto
      • Added: FileSize (int64)
  • Updated Models
    • CxAddresse
      • renamed to CxAddressee
    • UserfieldValue
      • Added: UserfieldPinValue
      • Added: UserfieldPinValueId
      • Added: UserfieldPolygonValueId
    • UserformSetting
      • Added: Version
    • UIWebStyle
      • Theme - enum options updated
    • Userfield
      • Type - enum options updated
22.0406-Apr-202215-Dec-2022
  • Updated Interfaces
    • Login/EncryptPassword
      • GET changed to POST
      • PasswordDto replaces the password parameter.
  • Added Models
    • PasswordDto
      • Password (string)
  • Updated Models
    • SalaryControlSheetDto AND WageControlSheetDto
      • Added: ForecastFinalCostComment (string)
      • Added: ForecastBestQty (double)
      • Added: ForecastBestPerWeek (double)
      • Added: ForecastBestOther (double)
      • Added: ForecastBestComment (string)
      • Added: ForecastTargetQty (double)
      • Added: ForecastTargetPerWeek (double)
      • Added: ForecastTargetOther (double)
      • Added: ForecastTargetComment (string)
      • Added: ForecastWorstQty (double)
      • Added: ForecastWorstPerWeek (double)
      • Added: ForecastWorstOther (double)
      • Added: ForecastWorstComment (string)
      • Added: OneOffCostComment (string)
      • Added: BudgetOriginal (double)
      • Added: ApprovedVariations (double)
      • Added: BudgetApproved (double)
      • Added: GainLoss (double)
    • SalaryItem and WageItem
      • Added: StartDate (date)
      • Added: FinishDate (date)
  • Updated Models
    • UserFieldValue
      • Added: UserfieldPolygonValue
    • ProjectSetting
      • Added: WeekEndDay
      • Added: WeekStartDay
    • UserFieldType
      • Added: Calculation
21.1201-Dec-202103-Aug-2022
  • New Interfaces
    • Company/Restore (int32)
    • Company/Retire (int32)
    • Document/Import (DocumentDto)
    • Project/GetByName (ProjectDto)
    • Revision/GetByFolderIds (RevisionDto)
    • Transmittal/Distribute (TransmittalDocDto)
    • User/GetCurrent (UserDto)
    • User/Restore (int32)
    • User/Retire (int32)
  • Updated Interfaces
    • Document/Create, Document/Update
      • Optional Parameter: sendNotification (bool)
    • Login/ByEmail
      • LoginDto replaces email and encryptedPassword parameters.
    • RegisterDoc/GetById, RegisterDoc/GetByName, RegisterDoc/GetByIds
      • OptionalParameter: includeRetired (bool)
      • OptionalParameter: includeRetiredRevisions (bool)
    • Revision/GerById, Revision/GetByIds, Revision/GetByFolderId
      • OptionalParameter: includeRetired (bool)
  • Added Models
    • ContactFieldValueDto
      • Id (int32)
      • ContactId (int32)
      • FieldId (int32)
      • FieldDescription (string)
      • FieldType (string)
      • OptionId (int32)
      • Text (string)
    • StatusActionDto
      • Id (int32)
      • StatusSettingId (int32)
      • Type (string)
      • DisplayText (string)
      • CanSee (string)
      • PreConditions (array[QueryCriterionDto])
      • PostActions (array[QueryCriterionDto])
      • Order (int32)
      • RowStatus (int32)
    • QueryCriterionDto
      • Id (int32)
      • Order (int32)
      • LogicOperator (string)
      • Type (string)
      • Criteria (string)
      • Operator (string)
      • Value (string)
    • LoginDto
      • Email (string)
      • EncryptedPassword (string)
  • Updated Models
    • BidderDto
      • FieldValues (array[ContactFieldValueDto])
    •  DocumentDto
      • BodyText (string)
    • SalaryItem
      • Allowances (array[SalaryItemAllowance])
    • WageItem
      • Allowances (array[WageItemAllowance])
    • StatusSettingDto
      • RowStatus (int32)
      • Actions (array[StatusActionDto])
  • Updated Models
    • Revision.LockedType
      • Renamed LockedByWorkflow
    • Folder.FolderType
      • Added Enum: Timeline
    • PrjDocSettingSecurity
      • Added: CanCloseReopen (bool)
    • SalaryItem
      • Added: Allowances
    • WageItem
      • Added: Allowances
  • Updated Interfaces
    • GetRevisionsByRegisterDocIds
      • Parameter: includeRetired (bool)
21.0818-Aug-202106-Apr-2022
  • New Interfaces
    • CostCode/Get (CaCostCodeDto)
    • CostCode/GetByDocSettingId (CaCostCodeDto)
    • CostCode/Create (CaCostCodeDto)
    • CostCode/Update (CaCostCodeDto)
    • CostCode/Upsert (CaCostCodeDto)
    • Revision/GetByIds (RevisionDto)
  • Updated Interfaces
    • ControlSheet_Get
      • Optional Parameter: onlyReportable (bool)
  • Added Models
    • CaCostCodeDto
      • Id (int32)
      • DocCode (string)
      • DocSettingId (int32)
      • Code (string)
      • Description (string)
      • RowStatus (int32)
      • Timestamp (int64)
  • Updated Models
    • ControlSheetDto
      • IsReportable (bool)
    • CommentDto
      • IsInternal (bool)
    • NumberInfoDto
      • CostCode (CaCostCodeDto)
      • PreviousVariance (double)
    • ProjectDto
      • Phone (string)
      • Fax (string)
      • Email (string)
      • Address (string)
      • PostCode (int32)
    • RevisionDto
      • Notes (string)
  • Updated Models
    • UserFieldValue
      • Added UserSignatureId
    • Project
      • Added Address
    • ControlSheet.Type
      • Added Supplier
  • Updated Interfaces
    • GetControlSheets
      • Added IsReportable
21.0414-Apr-202101-Dec-2021
  • New Interfaces
    • BudgetForecast/Update (BudgetForecastDto)
    • ContractVariation/Update (ContractVariationDto)
    • GlobalCompany/Get (PageResult[GlobalCompanyDto])
    • GlobalCompany/Search (GlobalCompanyDto[])
    • GlobalCompany/GetById (GlobalCompanyDto)
    • GlobalCompany/GetByIds (GlobalCompanyDto[])
    • GlobalCompany/Update (Result)
  • Updated Interfaces
    • TenderDatabase/*
      • No longer needs ProjectName parameter
  • Added Models
    • GlobalCompanyDto
      • Id (int32)
      • PreferCode (string)
      • Name (string)
      • BusinessNo (string)
      • Title (string)
      • EmailAddress (string)
      • ProjectIds (array[int32])
      • Address (string)
      • PostalAddress (string)
      • Phone (string)
      • Fax (string)
      • Mobile (string)
      • Web (string)
  • Updated Models
    • BudgetForecastDto
      • LinkedBudgetId (int64)
    • ContractDto
      • LinkedBudgetId (int64)
    • ContractVariationDto
      • LinkedBudgetId (int64)
    • LineItemDto
      • LinkedBudgetLineItemId (int64)
    • ProjectDto
      • Phase (string)
  • Updated Models
    • Revision
      • Added StatusDescription
    • Contract.LineItems
      • Added BudgetLinkLineItem
    • ContractVariation.LineItems
      • Added BudgetLinkLineItem
    • BudgetForecast.LineItems
      • Added BudgetLinkLineItem
    • DocumentSettingDetails
      • Added ShowSplitModeOption
    • PrjDocSettingUserField
      • Added SecurityStatuses
20.1125-Nov-202031-Jul-2021
  • New Interfaces
    • Bidder/Create (BidderDto)
    • Bidder/Update (BidderDto)
    • Bidder/Upsert (BidderDto)
    • Report/CreateExcel (ExcelDataDto)
    • TenderDatabase/Get (PageResult[TenderDatabaseDto])
    • TenderDatabase/GetById (TenderDatabaseDto)
  • Updated Interfaces
    • Bidder/Get
      • Optional tenderDatabaseId (integer)
      • Optional includeRetired (boolean)
    • Bidder/GetByIds
      • Optional tenderDatabaseId (integer)
  • Added Models
    • ExcelDataDto
      • FileName (string)
      • Columns (array[string])
      • Rows (array[string])
      • RowStyles (dictionary[rowId, string])
    • TenderDatabaseDto
      • Id (integer)
      • Name (string)
      • Timestamp (int64)
      • CostCodes (array[CostCodeDto])
      • Status (integer)
    • CostCodeDto
      • Id (integer)
      • Code (string)
      • TradeAliasId (integer)
      • TradeName (string)
      • GlobalTradeId (integer)
      • GlobalTradeName (string)
      • IsAllTrades (boolean)
      • Status (integer)
  • Updated Models
    • BidderDto
      • Added CostCode (string)
      • Added CostCodeId (integer)
      • Added TradeName (string)
      • Added StreetAddress (string)
      • Added City (string)
      • Added State (string)
      • Added Country (string)
      • Added PostCode (string)
      • Added Rating (integer)
      • Added IsPreferred (boolean)
      • Added Phone (string)
      • Added Mobile (string)
      • Added Status (integer)
      • Added Timestamp (int64)
  • New Interfaces
    • DeleteAssociations
    • GetRecentCreatedDocumentIds
  • Updated Models
    • Folder
      • Added IsCanUpload
      • Added SecurityType
    • QueryCriterion
      • Added Enum Types: ContactUserField & Type
20.0729-Jul-202031-Mar-2021Initial Release