POST /v2/user-extension - Insert Record

Overview

This endpoint inserts a new row into any UE table. You pass the table code, the object key values that identify the parent record, and the UDF field values to write. The API validates the parent record exists, re-fetches the authoritative key values from the parent table, validates every UDF field, and then inserts the row. On success it returns the newly inserted row as re-queried from the database.

Notes

Authentication and authorization are required.

tableCode must be present in the request body. If it is blank or missing the request is rejected immediately.

The data map must contain at least objectKey1. Additional object keys (objectKey2 through objectKey10) are required for composite-key tables.

The object key values you send are used only to locate the parent record. The values that actually get written into the UE row are re-fetched from the parent table using the resolved ORASEQ. This means the inserted row will always have the correct casing, padding, and formatting as stored in the parent — not whatever the caller typed.

Every UDF field value is validated and normalised before the insert runs. If any field fails validation (wrong LOV value, wrong case, unparseable date) the entire request is rejected and nothing is written.

dateFormat defaults to YYYY-MM-DD if not supplied. It controls how date field values in the data map are interpreted.

After a successful insert the row is re-queried from the physical UE table and returned in the response. If the re-query fails, the response falls back to the resolved input values — the row was still inserted and committed.

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 filling in the UE fields on an object's record and saving.

Request Body

Attributes

Response — 201 Created

Example

Request

POST {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_NOTES":       "Approved by Engineering",
    "UDF_RATING":      "a",
    "UDF_REVIEW_DATE": "2026-06-30"
  }
}

Response — 201 Created

{
  "status": "success",
  "tableCode": "CIITEM_K",
  "rowsAffected": 1,
  "message": "Successfully inserted 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":      "A",
    "CIITEM_K_UDF_REVIEW_DATE": "2026-06-30T00:00:00-04:00",
    "UE__IU__CREATE_DATE":      "2026-06-30T10:30:00-04:00",
    "UE__IU__UPDATE_DATE":      "2026-06-30T10:30:00-04:00"
  }
}

Note: UDF_RATING was sent as "a" but the field is configured with uppercase case flag, so the API normalised it to "A" before inserting.

Error — Parent Record Not Found (400)

{
  "error": "SD-000376-ERR: Master record does not exist for the given key values."
}

Error Codes