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.

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

Attributes

Response — 200 OK

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