> ## Documentation Index > Fetch the complete documentation index at: https://developers.cmicglobal.com/llms.txt > Use this file to discover all available pages before exploring further. # UpdateRecord > # PATCH /v2/user-extension — Update Record ## Overview This endpoint updates an existing row in any UE table. The request body follows the same shape as POST — `tableCode`, an optional `dateFormat`, and a `data` map containing the object keys and the UDF fields to update. The API resolves the parent record, validates the fields, and runs the UPDATE. On success it returns the updated row re-queried from the database. | Property | Value | | --- | --- | | URL | `{base_url}/sys-rest-api/jersey/v2/user-extension` | | Method | `PATCH` | | Consumes / Produces | `application/json` | | Success Status | `200 OK` | | Auth | Basic (`Authorization: Basic {credentials}`) | --- ## Notes Authentication and authorization are required. The request body and `data` map requirements are identical to POST. `tableCode` is required, `objectKey1` is required, and at least one non-key UDF field must be present in `data` — if you send nothing but object keys there is nothing to update and the request is rejected with a 400. Key resolution works the same way as POST. The object key values in the request are used to find the parent record via ORASEQ. The authoritative key values are then re-fetched from the base table, so the WHERE clause of the UPDATE always uses the exact values as stored in the parent. All UDF field values are validated and normalised by the database (LOV, case, date format) before the UPDATE runs. If any field fails, the whole request is rejected. Required key fields for the UE table are loaded from `da.sd#ue_table_fields` and used to build the WHERE clause of the UPDATE statement. UDF fields go into the SET clause. `dateFormat` defaults to `YYYY-MM-DD` if not supplied. After a successful update the row is re-queried and returned in the response. --- ## UI Navigation User Extension tables are attached to the parent object's own screen in CMiC. There is no standalone navigation path. This endpoint is the API equivalent of editing and saving UE fields on an existing object record. --- ## Request Body | Field | Type | Required | Description | | --- | --- | --- | --- | | `tableCode` | String | Yes | UE table code to update (e.g. `CIITEM_K`). | | `dateFormat` | String | No | Oracle date mask for date fields in `data`. Defaults to `YYYY-MM-DD`. | | `data` | Map | Yes | Must include `objectKey1` (and additional keys for composite-key tables) plus at least one UDF field to update. | | `data.objectKey1` | String | Yes | First business key of the parent record. | | `data.objectKey2` through `objectKey10` | String | Depends | Additional keys for composite-key objects. | | `data.{UDF_FIELD_CODE}` | String | At least one required | UDF field value to update. All supplied fields are written; fields omitted from the request are left unchanged. | --- ## Attributes ### Response — 200 OK | Field | Type | Description | Example | | --- | --- | --- | --- | | `status` | String | Always `success` on 200 | `success` | | `tableCode` | String | UE table code that was updated | `CIITEM_K` | | `rowsAffected` | Integer | Number of rows updated (normally 1) | `1` | | `message` | String | Confirmation message | `Successfully updated 1 row.` | | `data` | Map | The re-queried updated row. Column names prefixed with table code. System columns excluded. | | | `data.{TABLECODE}_COMP_CODE` | String | Company Code key column | `01` | | `data.{TABLECODE}_ITEM_CODE` | String | Item Code key column | `BOLT-123` | | `data.{TABLECODE}_{UDF_FIELD}` | String | Updated UDF field value (normalised) | `A` | | `data.UE__IU__UPDATE_DATE` | String (ISO 8601) | Row last update timestamp | `2026-06-30T15:00:00-04:00` | --- ## Example ### Request ``` PATCH {base_url}/sys-rest-api/jersey/v2/user-extension Content-Type: application/json Authorization: Basic {credentials} { "tableCode": "CIITEM_K", "dateFormat": "YYYY-MM-DD", "data": { "objectKey1": "01", "objectKey2": "BOLT-123", "UDF_RATING": "b", "UDF_REVIEW_DATE": "2026-07-15" } } ``` ### Response — 200 OK ``` { "status": "success", "tableCode": "CIITEM_K", "rowsAffected": 1, "message": "Successfully updated 1 row.", "data": { "CIITEM_K_COMP_CODE": "01", "CIITEM_K_ITEM_CODE": "BOLT-123", "CIITEM_K_UDF_NOTES": "Approved by Engineering", "CIITEM_K_UDF_RATING": "B", "CIITEM_K_UDF_REVIEW_DATE": "2026-07-15T00:00:00-04:00", "UE__IU__CREATE_DATE": "2026-06-30T10:30:00-04:00", "UE__IU__UPDATE_DATE": "2026-06-30T15:00:00-04:00" } } ``` Note: `UDF_NOTES` was not included in the PATCH request so its existing value `"Approved by Engineering"` is unchanged. `UDF_RATING` was normalised from `"b"` to `"B"`. ### Error — Nothing to Update (400) ``` { "error": "No fields (besides key fields) have been provided to update." } ``` --- ## Error Codes | HTTP | Error Code | Reason | | --- | --- | --- | | 400 | `SD-000380-ERR` | Request body is null or empty | | 400 | `SD-000381-ERR` | Request body is not valid JSON | | 400 | `SD-000375-ERR` | `tableCode` is blank or missing | | 400 | `SD-000382-ERR` | `data` map is null or empty | | 400 | `SD-000376-ERR` | Table code invalid or parent record not found | | 400 | `IllegalArgumentException` | No `objectKey1` in `data`; no non-key fields provided; a UDF field does not exist; UDF validation failed | | 500 | — | Unhandled database or server error — auto rollback | ## OpenAPI ````json PATCH /sys-rest-api/jersey/v2/user-extension { "openapi": "3.0.0", "info": { "title": "API Catalog", "description": "", "version": "1.0.0" }, "servers": [ { "url": "https://mobtest.cmiccloudr12.com/cmictestrti", "description": "CMIC API Server" } ], "security": [ { "cmicBasicAuth": [] } ], "tags": [ { "name": "Highlights" }, { "name": "Asset Management | Equipment" }, { "name": "Asset Management | Fixed Assets" }, { "name": "Asset Management | Purchase Order" }, { "name": "Asset Management | Inventory" }, { "name": "Asset Management | Requisition" }, { "name": "Asset Management | Purchase Change Order" }, { "name": "Bim Model" }, { "name": "Bim Model Revision" }, { "name": "Bim Tag Model" }, { "name": "Bim Tags" }, { "name": "Bim FileUpload Jersey" }, { "name": "Core System | Business Partners" }, { "name": "Core System | Business Partner Addresses" }, { "name": "Core System | Bank" }, { "name": "Core System | Currency" }, { "name": "Core System | Exchange Rates" }, { "name": "Core System | Global Table Text Codes" }, { "name": "Core System | Global Table Regions" }, { "name": "Core System | Terms" }, { "name": "Core System | System Contact" }, { "name": "Core System | Weight Measures" }, { "name": "Core System | Field User Defined Classifiers" }, { "name": "Core System | User Defined Classifiers by Object" }, { "name": "Core System | User Extension Definitions by Object" }, { "name": "Core System | User Extention Field Data Value" }, { "name": "Core System | User Extension Values by Object" }, { "name": "Core System | User System Role" }, { "name": "Core System | User Project Role" }, { "name": "Core System | Documents by Object" }, { "name": "Core System | Audit Status Log by Object" }, { "name": "Core System | Licensed Users" }, { "name": "Core System | Company Access" }, { "name": "Core System | Copy User Settings" }, { "name": "Core System | User Maintenance" }, { "name": "Core System | User Roles" }, { "name": "Core System | Security Groups" }, { "name": "Core System | Job/Project Security" }, { "name": "Core System | Weight Measure with Conversions Code" }, { "name": "Core System | Weight Measure Conversions Code" }, { "name": "Core System | User-defined-fields" }, { "name": "Core System | User-extension" }, { "name": "ECM and Workflow | Image Manager" }, { "name": "Financials | General Ledger" }, { "name": "Financials | Accounts Payable" }, { "name": "Financials | Accounts Receivable" }, { "name": "Preventative Maintenance | Issue Work Orders" }, { "name": "Preventative Maintenance | Issue Work Items" }, { "name": "Preventative Maintenance | Issue Work Budgets" }, { "name": "Preventative Maintenance | Issue Priorities" }, { "name": "Preventative Maintenance | Issue Status" }, { "name": "Preventative Maintenance | Issue Types" }, { "name": "Preventative Maintenance | Accumulative Equipment" }, { "name": "Preventative Maintenance | Work Orders" }, { "name": "Preventative Maintenance | Work Items" }, { "name": "Preventative Maintenance | Work Budgets" }, { "name": "Preventative Maintenance | Priorities" }, { "name": "Preventative Maintenance | Tasks" }, { "name": "HCM | UKG Pay Deductions" }, { "name": "HCM | UKG Pay Earnings" }, { "name": "HCM | UKG Pay Headers" }, { "name": "HCM | UKG Pay Taxes" }, { "name": "HCM | Payroll Geographical States" }, { "name": "HCM | Payroll Trades" }, { "name": "HCM | Payroll Union" }, { "name": "HCM | Payroll Pay Runs" }, { "name": "HCM | Payroll Pay Groups" }, { "name": "HCM | Payroll Tax" }, { "name": "HCM | Payroll Worker Compensation" }, { "name": "HCM | Payroll Work Locations" }, { "name": "HCM | Payroll Trade Pay Rates" }, { "name": "HCM | Payroll Union Pay Rates" }, { "name": "HCM | Payroll Job Pay Rates" }, { "name": "HCM | Payroll Master Benefits" }, { "name": "HCM | Payroll Master Deductions" }, { "name": "HCM | Payroll Ben/Ded/Leave Base Codes" }, { "name": "HCM | Payroll Ben/Ded Plans" }, { "name": "HCM | Payroll Ben/Ded Plan Options" }, { "name": "HCM | Payroll Company Benefits" }, { "name": "HCM | Payroll Company Deductions" }, { "name": "HCM | Payroll Vertex Geographic Locations" }, { "name": "HCM | Payroll Checks" }, { "name": "HCM | Payroll Timesheets" }, { "name": "HCM | Employee" }, { "name": "HCM | Employee (Minimum payload)" }, { "name": "HCM | Employee History" }, { "name": "HCM | Tax Exemptions" }, { "name": "HCM | Employee Tax Overrides" }, { "name": "HCM | Employee Pay Splits" }, { "name": "HCM | Employee Benefits" }, { "name": "HCM | Employee Clock In and Out" }, { "name": "HCM | Employee Deductions" }, { "name": "HCM | Employee Leaves" }, { "name": "HCM | Employee Leave History" }, { "name": "HCM | Employee Hour Types" }, { "name": "HCM | Employee Pay History" }, { "name": "HCM | Employee Work Statuses" }, { "name": "HCM | Employee Security Group" }, { "name": "HCM | Crewtime Crew" }, { "name": "HCM | Crewtime Employee Timesheet" }, { "name": "HCM | Crewtime Equipment Timesheet" }, { "name": "HCM | Crew Maintenance Activity Assignment" }, { "name": "HCM | Crew Maintenance Member Assignment" }, { "name": "HCM | Crew Maintenance Member Trade and Union Assignment" }, { "name": "HCM | Crew Maintenance Equipment Assignment" }, { "name": "HCM | Crew Maintenance Equipment Detail Assignment" }, { "name": "HCM | HR Requisitions" }, { "name": "HCM | HR Relations" }, { "name": "HCM | HR Employee Skills" }, { "name": "HCM | HR Incident" }, { "name": "HCM | HR Employee Relatives / Dependents" }, { "name": "HCM | HR Employee Positions" }, { "name": "HCM | HR Applicants" }, { "name": "HCM | HR Applications" }, { "name": "HCM | Vertex Location City" }, { "name": "HCM | HR Application History" }, { "name": "HCM | HR Dependent Benefits" }, { "name": "HCM | HR Dependent Deductions" }, { "name": "HCM | HR Employee Elected Plans" }, { "name": "HCM | HR Employee Training Certifications" }, { "name": "HCM | HR Trainings" }, { "name": "HCM | E-Timesheets" }, { "name": "HCM | System Contacts" }, { "name": "HCM | System User Payroll Security Group" }, { "name": "HCM | Payroll Timesheet Posting" }, { "name": "HCM | CrewTimesheet Posting" }, { "name": "HCM | HR Positions Master" }, { "name": "HCM | Payroll Pay Periods" }, { "name": "HCM | Payroll Rate Codes" }, { "name": "HCM | Payroll Overhead Codes and Rates" }, { "name": "HCM | Payroll Assigned Overhead to Jobs" }, { "name": "Materials Management | Material Sale Orders" }, { "name": "Materials Management | Material Sale Orders Details" }, { "name": "Materials Management | Truck Rate Detail" }, { "name": "Opportunity Management | Competitors" }, { "name": "Opportunity Management | Opportunities" }, { "name": "Opportunity Management | Revenue Details" }, { "name": "Opportunity Management | Opportunity History" }, { "name": "Opportunity Management | Organization" }, { "name": "Project Controls | Job Billing" }, { "name": "Project Controls | Job Cost" }, { "name": "Project Controls | PCI Details" }, { "name": "Project Controls | Unposted PCI Details" }, { "name": "Project Controls | PCI Headers" }, { "name": "Project Controls | Owner Change Orders" }, { "name": "Project Controls | CM Statuses" }, { "name": "Project Controls | CM Types" }, { "name": "Project Controls | CM Vendor Details" }, { "name": "Project Controls | Post PCI" }, { "name": "Project Management | Uploading Documents" }, { "name": "Project Management | Downloading Documents" }, { "name": "Project Management | Foreign Bid Item Imports" }, { "name": "Project Management | Communications" }, { "name": "Project Management | Daily Journals" }, { "name": "Project Management | Communications Types" }, { "name": "Project Management | Daily Journal Daily Work Plans" }, { "name": "Project Management | Daily Journal Field Forces" }, { "name": "Project Management | Daily Journal Labour" }, { "name": "Project Management | Daily Journal Materials" }, { "name": "Project Management | Daily Journal Owner Equipment" }, { "name": "Project Management | Daily Journal Quality Control" }, { "name": "Project Management | Daily Journal Tasks" }, { "name": "Project Management | Daily Journal Trade Equipment" }, { "name": "Project Management | Daily Journal Transactions" }, { "name": "Project Management | Daily Journal User Defined Data" }, { "name": "Project Management | Daily Journal Visitors" }, { "name": "Project Management | Daily Journal Bill Details" }, { "name": "Project Management | Field Work Directives" }, { "name": "Project Management | Contract Types" }, { "name": "Project Management | Company Contacts" }, { "name": "Project Management | Distribution BCC" }, { "name": "Project Management | Distribution CC" }, { "name": "Project Management | Field Work Directive Statuses" }, { "name": "Project Management | Issues" }, { "name": "Project Management | Key Players" }, { "name": "Project Management | Meetings" }, { "name": "Project Management | Meeting Attendees" }, { "name": "Project Management | Meeting Item Statuses" }, { "name": "Project Management | Meeting Tracks" }, { "name": "Project Management | Notes" }, { "name": "Project Management | Projects" }, { "name": "Project Management | Project Items" }, { "name": "Project Management | Project Item Phase Segment Sums" }, { "name": "Project Management | Project Partners" }, { "name": "Project Management | Notices" }, { "name": "Project Management | Notice Statuses" }, { "name": "Project Management | Owner JS Query" }, { "name": "Project Management | PCI Real Locations" }, { "name": "Project Management | Project Contacts" }, { "name": "Project Management | RFIs (Requests for Information)" }, { "name": "Project Management | RFI Statuses" }, { "name": "Project Management | Submittal Packages" }, { "name": "Project Management | Submittal Package Details" }, { "name": "Project Management | Submittal Package Status" }, { "name": "Project Management | Submittals" }, { "name": "Project Management | Submittal Status" }, { "name": "Project Management | Transmittals" }, { "name": "Project Management | Subcontract Headers" }, { "name": "Project Management | Subcontract Schedules" }, { "name": "Project Management | Subcontract Sechedule Phase Segment Sums" }, { "name": "Project Management | User Roles" }, { "name": "Project Management | Punchlists" }, { "name": "Project Management | Punchlist Details" }, { "name": "Project Management | Punchlist Statuses" }, { "name": "Project Management | Meeting Items" }, { "name": "Project Management | Self Perform Vendor" }, { "name": "Project Management | Submittal Types" }, { "name": "Project Management | Assign contact and partner to project" }, { "name": "Project Management | Subcontract Prequal" }, { "name": "Project Management | Bid Item Package" } ], "paths": { "/sys-rest-api/jersey/v2/user-extension": { "patch": { "tags": [ "Core System | User-extension" ], "summary": "UpdateRecord", "description": "# PATCH /v2/user-extension — Update Record\n\n## Overview\n\nThis endpoint updates an existing row in any UE table. The request body follows the same shape as POST — `tableCode`, an optional `dateFormat`, and a `data` map containing the object keys and the UDF fields to update. The API resolves the parent record, validates the fields, and runs the UPDATE. On success it returns the updated row re-queried from the database.\n\n| Property | Value |\n| --- | --- |\n| URL | `{base_url}/sys-rest-api/jersey/v2/user-extension` |\n| Method | `PATCH` |\n| Consumes / Produces | `application/json` |\n| Success Status | `200 OK` |\n| Auth | Basic (`Authorization: Basic {credentials}`) |\n\n---\n\n## Notes\n\nAuthentication and authorization are required.\n\nThe request body and `data` map requirements are identical to POST. `tableCode` is required, `objectKey1` is required, and at least one non-key UDF field must be present in `data` — if you send nothing but object keys there is nothing to update and the request is rejected with a 400.\n\nKey resolution works the same way as POST. The object key values in the request are used to find the parent record via ORASEQ. The authoritative key values are then re-fetched from the base table, so the WHERE clause of the UPDATE always uses the exact values as stored in the parent.\n\nAll UDF field values are validated and normalised by the database (LOV, case, date format) before the UPDATE runs. If any field fails, the whole request is rejected.\n\nRequired key fields for the UE table are loaded from `da.sd#ue_table_fields` and used to build the WHERE clause of the UPDATE statement. UDF fields go into the SET clause.\n\n`dateFormat` defaults to `YYYY-MM-DD` if not supplied.\n\nAfter a successful update the row is re-queried and returned in the response.\n\n---\n\n## UI Navigation\n\nUser Extension tables are attached to the parent object's own screen in CMiC. There is no standalone navigation path. This endpoint is the API equivalent of editing and saving UE fields on an existing object record.\n\n---\n\n## Request Body\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tableCode` | String | Yes | UE table code to update (e.g. `CIITEM_K`). |\n| `dateFormat` | String | No | Oracle date mask for date fields in `data`. Defaults to `YYYY-MM-DD`. |\n| `data` | Map | Yes | Must include `objectKey1` (and additional keys for composite-key tables) plus at least one UDF field to update. |\n| `data.objectKey1` | String | Yes | First business key of the parent record. |\n| `data.objectKey2` through `objectKey10` | String | Depends | Additional keys for composite-key objects. |\n| `data.{UDF_FIELD_CODE}` | String | At least one required | UDF field value to update. All supplied fields are written; fields omitted from the request are left unchanged. |\n\n---\n\n## Attributes\n\n### Response — 200 OK\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| `status` | String | Always `success` on 200 | `success` |\n| `tableCode` | String | UE table code that was updated | `CIITEM_K` |\n| `rowsAffected` | Integer | Number of rows updated (normally 1) | `1` |\n| `message` | String | Confirmation message | `Successfully updated 1 row.` |\n| `data` | Map | The re-queried updated row. Column names prefixed with table code. System columns excluded. | |\n| `data.{TABLECODE}_COMP_CODE` | String | Company Code key column | `01` |\n| `data.{TABLECODE}_ITEM_CODE` | String | Item Code key column | `BOLT-123` |\n| `data.{TABLECODE}_{UDF_FIELD}` | String | Updated UDF field value (normalised) | `A` |\n| `data.UE__IU__UPDATE_DATE` | String (ISO 8601) | Row last update timestamp | `2026-06-30T15:00:00-04:00` |\n\n---\n\n## Example\n\n### Request\n\n```\nPATCH {base_url}/sys-rest-api/jersey/v2/user-extension\nContent-Type: application/json\nAuthorization: Basic {credentials}\n{\n \"tableCode\": \"CIITEM_K\",\n \"dateFormat\": \"YYYY-MM-DD\",\n \"data\": {\n \"objectKey1\": \"01\",\n \"objectKey2\": \"BOLT-123\",\n \"UDF_RATING\": \"b\",\n \"UDF_REVIEW_DATE\": \"2026-07-15\"\n }\n}\n\n ```\n\n### Response — 200 OK\n\n```\n{\n \"status\": \"success\",\n \"tableCode\": \"CIITEM_K\",\n \"rowsAffected\": 1,\n \"message\": \"Successfully updated 1 row.\",\n \"data\": {\n \"CIITEM_K_COMP_CODE\": \"01\",\n \"CIITEM_K_ITEM_CODE\": \"BOLT-123\",\n \"CIITEM_K_UDF_NOTES\": \"Approved by Engineering\",\n \"CIITEM_K_UDF_RATING\": \"B\",\n \"CIITEM_K_UDF_REVIEW_DATE\": \"2026-07-15T00:00:00-04:00\",\n \"UE__IU__CREATE_DATE\": \"2026-06-30T10:30:00-04:00\",\n \"UE__IU__UPDATE_DATE\": \"2026-06-30T15:00:00-04:00\"\n }\n}\n\n ```\n\nNote: `UDF_NOTES` was not included in the PATCH request so its existing value `\"Approved by Engineering\"` is unchanged. `UDF_RATING` was normalised from `\"b\"` to `\"B\"`.\n\n### Error — Nothing to Update (400)\n\n```\n{\n \"error\": \"No fields (besides key fields) have been provided to update.\"\n}\n\n ```\n\n---\n\n## Error Codes\n\n| HTTP | Error Code | Reason |\n| --- | --- | --- |\n| 400 | `SD-000380-ERR` | Request body is null or empty |\n| 400 | `SD-000381-ERR` | Request body is not valid JSON |\n| 400 | `SD-000375-ERR` | `tableCode` is blank or missing |\n| 400 | `SD-000382-ERR` | `data` map is null or empty |\n| 400 | `SD-000376-ERR` | Table code invalid or parent record not found |\n| 400 | `IllegalArgumentException` | No `objectKey1` in `data`; no non-key fields provided; a UDF field does not exist; UDF validation failed |\n| 500 | — | Unhandled database or server error — auto rollback |", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "example": { "tableCode": "CIITEM_K", "data": { "objectKey1": "CL02", "objectKey2": "SAND", "NUMBEROKEY": "10", "CLTEST": "123" } } } } } }, "responses": { "200": { "description": "OK", "headers": { "Content-Type": { "schema": { "type": "string", "example": "application/json" } } }, "content": { "text/plain": { "schema": { "type": "string" }, "example": "{\n \"status\": \"success\",\n \"tableCode\": \"CIITEM_K\",\n \"rowsAffected\": 1,\n \"message\": \"Successfully updated 1 row.\",\n \"data\": {\n \"COMP_CODE\": \"ZZ\",\n \"ITEM_CODE\": \"DIESEL\",\n \"NUMBEROKEY\": \"22\",\n \"AAA\": \"HelloCMIC\",\n \"UE__IU__CREATE_DATE\": \"2026-06-24T21:48:19-04:00\",\n \"UE__IU__UPDATE_DATE\": \"2026-06-25T15:25:06-04:00\",\n \"CLTEST\": null\n }\n}" } } } } } } }, "components": { "securitySchemes": { "cmicBasicAuth": { "type": "http", "scheme": "basic", "description": "Basic authentication" } } } } ````