DELETE /v2/user-extension — Delete Record

Overview

This endpoint deletes a row from any UE table. You pass the table code and the object key values that identify the parent record. The API resolves the parent, builds the exact WHERE clause from the authoritative key values, and deletes the matching row. If the row does not exist, a 400 is returned — nothing is deleted.

Notes

Authentication and authorization are required.

tableCode is required in the request body. objectKey1 is required in the data map.

Key resolution works the same way as POST and PATCH. The supplied object keys are used to find the parent record via ORASEQ. The authoritative key values are then re-fetched from the base table and used to build the WHERE clause of the DELETE. Any extra fields in the data map beyond the parent object keys are also included in the WHERE clause — this lets you target a specific UE row when the table has its own additional key columns.

Before the DELETE runs, the API checks that all required fields for the UE table are accounted for in the data map. If any required field is missing, the request is rejected with a 400 and a list of what is missing.

If the DELETE affects zero rows (the UE row does not exist), that is also a 400 — the operation is not silently ignored.

The transaction is committed on success and rolled back on any error.

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 removing a UE row from an object record.

Request Body

Attributes

Response — 200 OK

Example

Request

DELETE {base_url}/sys-rest-api/jersey/v2/user-extension
Content-Type: application/json
Authorization: Basic {credentials}
{
  "tableCode": "CIITEM_K",
  "data": {
    "objectKey1": "01",
    "objectKey2": "BOLT-123"
  }
}

Response — 200 OK

{
  "status": "success",
  "tableCode": "CIITEM_K",
  "rowsAffected": 1,
  "message": "Successfully deleted 1 row.",
  "data": {
    "COMP_CODE": "01",
    "ITEM_CODE":  "BOLT-123"
  }
}

Error — Row Does Not Exist (400)

{
  "error": "No rows were deleted. The specified record may not exist."
}

Error — Required Fields Missing (400)

{
  "error": "Missing required fields for delete: [COMP_CODE, ITEM_CODE]"
}

Error Codes