.png){kind=logo}
Breaking Changes
- 27 Oct 2025
- 1 Minute to read
- Print
- DarkLight
Breaking Changes
- Updated on 27 Oct 2025
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Stay In the Loop
Sign up to receive email notifications about upcoming updates, releases, or changes.
Click subscribe or scan the QR code below.
Last Update: October 2025
All APIs
Centralized API Exception Handling
Endpoints: Applies to all APIs
Notes: Effective Nexus 1, CMiC has introduced centralized error handling across all APIs. This ensures every API response follows a consistent, structured JSON format, making errors easier to trace, debug, and handle across all services.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| All | Error Messages | Standard http codes and error messages | ALL | Nexus 1 | Best Practice - Global API Exception Handling |
Application Security on APIs
Endpoint: Applies to all APIs
Notes: Application-level security enforced across all endpoints. This ensures that API responses respect company, job, project, and employee relevant security rules, protecting sensitive information from unauthorized access. This update addresses previously reported scenarios where incomplete security filters could expose unauthorized data.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| All | Added Security | Company, Job, Employee | ALL | 22 | Best Practice - Global API Application Security |
Human Capital Management
United Kingdom Payroll
Endpoint: hcm-rest-api/rest/1/ukgpayheader
Notes: Modified to return the correct primary keys for employee check number in response.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Corrected View | Added syscontext | GET | 21 | UKG Pay Header |
Vertex Location by City
Endpoint: hcm-rest-api/rest/1/vertexloccity
Notes: Enhanced view to allow passing user sys context.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Modified finder attributes | loczipcodestart, loczipcodeend | GET | 21 | Vertex Location Code |
Payroll Timesheets
Endpoint: hcm-rest-api/rest/1/pyemptimesheet
Notes: Modified to be system-calculated (from workcompcode, job, phase, and category) instead of passed in the payload, resolving miscalculation issues from duplicate fields. Also, cleaned up duplicate and non-functioning attributes.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Removed Attributes | TshCertSeq, TshIuCreateDate, TshIuLastUpdateDate, TshIuUpdateDate, TshPciLineUuid, TshSeqNo, TshUserField1, TshUserField2, TshUserField3, TshWbsSetupFlag, TshWbsvCode1, TshWbsvCode2, TshWbsvCode3, TshWbsvCode4 | All | 21 | Payroll Timesheet |
Project Controls
Assign Cost Codes
Endpoint: jc-rest-api/rest/1/jcjobcostcodes
Notes: Modified to remove Company Name and Job Name to optimize.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Removed Attribute | GjcatCompName, GjcatJobName | GET | 22 | Job Cost Codes (Job Phases) |
Change Items (PCI/OCO)
Endpoint: cm-rest-api/rest/1/cmdetail
Notes: Removed 'Phasedate' parameter from finders, to standardize with other API finders.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Removed Finders | selectCostCatCodes: phaseDate, selectByphaseDate: phaseDate | GET | 22 | PCI Detail |
Core System
System User
Endpoint: sys-rest-api/rest/1/sduser
Notes: API depreciated.
| Version | Change | Description | Method | Patch | Reference |
|---|---|---|---|---|---|
| 1 | Depreciated | Replaced with API User. | All | 22 | User |