Press CTRL+K to open search

getAllRecords

  • Published on Oct 7, 2026
Prev Next
Get
/sys-rest-api/jersey/v2/user-extension/CIITEM_K

GET /v2/user-extension/

Overview

Queries rows from a User Extension (UE) table. Supports optional column filters and audit date filtering. Filters may be supplied as raw frontend field names or as generic objectKey placeholders — the endpoint resolves either form to the correct columns at runtime. Call GET /v2/user-extension/definition/{tableCode} first if you need to know what objectKey1, objectKey2, etc. map to for a given table. | Property | Value | |---|---| | URL | {base_url}/sys-rest-api/jersey/v2/user-extension/{tableCode} | | Method | GET | | Produces | application/json | | Success Status | 200 OK | | Auth | Basic (Authorization: Basic {credentials}) |

Notes

  • Authentication and authorization are required.

  • tableCode is a path parameter — it goes directly in the URL.

  • whereVariables accepts two filter styles — raw field names or generic objectKey slots. Both styles can coexist in the same request.

  • When objectKey filters are supplied the endpoint resolves them to authoritative key values by querying the parent base table; raw field-name filters bypass that resolution step.

  • When no rows are found items is omitted and a message field is returned instead.

  • masterTableCode is only populated in the response when at least one objectKey filter was provided; otherwise it is null.

UI Navigation

User Extension tables are attached to the parent object's own screen in CMiC. There is no standalone navigation path. Use this endpoint to query data from any UE table by its table code.

Finders / Query Parameters

Parameter Type Required Default Description
tableCode Path Yes — UE table code (e.g. CIITEM_K, PROJ_EXT).
auditDate Query No — Return only rows whose UE__IU__CREATE_DATE or UE__IU__UPDATE_DATE is on or after this date. Format must match dateFormat.
dateFormat Query No YYYY-MM-DD Oracle date format mask used to parse auditDate and any date filter values in whereVariables.
whereVariables Query No — Semicolon-delimited filter pairs: FIELD=VALUE;FIELD=VALUE. Accepts raw frontend field names or generic objectKey1–objectKey10 slot names.

whereVariables Filter Styles

Style 1 — Raw field names (use exact frontend column names from the UE table):

whereVariables=COMP_CODE=01;ITEM_CODE=BOLT-123

Style 2 — Generic objectKey slots (resolved automatically via key mapping):

whereVariables=objectKey1=01;objectKey2=BOLT-123

Both styles may be combined in one request. When objectKey values are present the endpoint performs a key-validation and resolution round-trip before executing the query.

Attributes

Response Fields

Field Type Description Example
tableCode String The UE table code that was queried CIITEM_K
masterTableCode String Parent object table; populated only when objectKey filters were used, otherwise null CIITEM
count Integer Number of rows returned 2
items Array List of row maps; each map is a { "COLUMN_NAME": "value" } object. Omitted when count is 0. —
message String Informational message when no rows are found; omitted when rows are returned "There is no data in this UE table."

Examples

Request — filter by raw field names

GET {base_url}/sys-rest-api/jersey/v2/user-extension/CIITEM_K?whereVariables=COMP_CODE=01;ITEM_CODE=BOLT-123
Authorization: Basic {credentials}

Response — 200 OK (rows found)

{
  "tableCode": "CIITEM_K",
  "masterTableCode": null,
  "count": 1,
  "items": [
    {
      "COMP_CODE": "01",
      "ITEM_CODE": "BOLT-123",
      "UE_CODE1":  "STEEL",
      "UE_CODE2":  "FASTENER",
      "UE_NUM1":   "12.50",
      "UE_DATE1":  "2025-01-15"
    }
  ]
}

Request — filter by objectKey slots

GET {base_url}/sys-rest-api/jersey/v2/user-extension/CIITEM_K?whereVariables=objectKey1=01;objectKey2=BOLT-123
Authorization: Basic {credentials}

Response — 200 OK (rows found, objectKey resolution performed)

{
  "tableCode": "CIITEM_K",
  "masterTableCode": "CIITEM",
  "count": 1,
  "items": [
    {
      "COMP_CODE": "01",
      "ITEM_CODE": "BOLT-123",
      "UE_CODE1":  "STEEL",
      "UE_CODE2":  "FASTENER",
      "UE_NUM1":   "12.50",
      "UE_DATE1":  "2025-01-15"
    }
  ]
}

Request — with audit date filter

GET {base_url}/sys-rest-api/jersey/v2/user-extension/CIITEM_K?auditDate=2025-01-01&dateFormat=YYYY-MM-DD
Authorization: Basic {credentials}

Response — 200 OK (no rows found)

{
  "tableCode": "CIITEM_K",
  "masterTableCode": null,
  "count": 0,
  "message": "There is no data in this UE table."
}

Error — Invalid Table Code (400)

{
  "error": "SD-000376-ERR: Table code 'XYZ' is not valid or the object is not supported."
}

Error — Malformed whereVariables (400)

{
  "error": "Filter variable 'BADTOKEN' does not contain '=' delimiter."
}

Error Codes

HTTP Error Code Reason
400 SD-000375-ERR tableCode path parameter is blank or missing
400 SD-000376-ERR Table code does not exist or the parent object is not supported by the UE API
400 — whereVariables contains a token without an = delimiter
400 — No key mapping found in ue_master_table_tn for the resolved master table
500 — Unhandled server error
Security
HTTP
Type basic

Basic authentication

Responses
200

OK

Headers
Content-Type
string
Exampleapplication/json
example-0

getAllRecords

"{\n    \"tableCode\": \"CIITEM_K\",\n    \"masterTableCode\": \"CIITEM\",\n    \"count\": 20,\n    \"items\": [\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"8\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-28T13:22:25-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"9\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-28T13:22:35-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"20\",\n            \"AAA\": \"YashBhavsar@\",\n            \"UE__IU__CREATE_DATE\": \"2026-06-22T23:56:15-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"15\",\n            \"AAA\": \"YashBhavsar@\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-29T11:38:31-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"3\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T20:13:27-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"14\",\n            \"AAA\": \"YashBhavsar@\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-29T11:38:20-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"18\",\n            \"AAA\": \"YashBha\",\n            \"UE__IU__CREATE_DATE\": \"2026-06-02T12:01:09-04:00\",\n            \"UE__IU__UPDATE_DATE\": \"2026-06-23T00:02:11-04:00\",\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"CL02\",\n            \"ITEM_CODE\": \"SAND\",\n            \"NUMBEROKEY\": \"10\",\n            \"AAA\": \"TestValue\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-22T14:33:45-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": \"SomeData\"\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"19\",\n            \"AAA\": \"YashBhavsar@\",\n            \"UE__IU__CREATE_DATE\": \"2026-06-03T11:20:28-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"2\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T16:48:25-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"CL02\",\n            \"ITEM_CODE\": \"1010209\",\n            \"NUMBEROKEY\": \"1\",\n            \"AAA\": \"Carrie\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-15T15:07:54-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"CL02\",\n            \"ITEM_CODE\": \"1010209\",\n            \"NUMBEROKEY\": \"2\",\n            \"AAA\": \"Test 2\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-15T15:07:54-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"CL02\",\n            \"ITEM_CODE\": \"ACTU0026\",\n            \"NUMBEROKEY\": \"1\",\n            \"AAA\": \"API Test 1\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-15T15:09:39-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"CL02\",\n            \"ITEM_CODE\": \"ACTU0026\",\n            \"NUMBEROKEY\": \"2\",\n            \"AAA\": \"API Test 2\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-15T15:09:39-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"4\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T23:47:32-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"5\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T23:47:56-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"6\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T23:50:48-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"7\",\n            \"AAA\": \"Yash\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-27T23:53:22-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"10\",\n            \"AAA\": \"YashBhavsar\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-28T13:44:26-04:00\",\n            \"UE__IU__UPDATE_DATE\": \"2026-05-28T14:09:13-04:00\",\n            \"CLTEST\": null\n        },\n        {\n            \"COMP_CODE\": \"ZZ\",\n            \"ITEM_CODE\": \"DIESEL\",\n            \"NUMBEROKEY\": \"17\",\n            \"AAA\": \"YashBhavsar@\",\n            \"UE__IU__CREATE_DATE\": \"2026-05-29T18:44:57-04:00\",\n            \"UE__IU__UPDATE_DATE\": null,\n            \"CLTEST\": null\n        }\n    ],\n    \"message\": null\n}"
example-1

getSpecificRecord

"{\n    \"tableCode\": \"POSUMM\",\n    \"masterTableCode\": \"POSUMMARY\",\n    \"count\": 1,\n    \"items\": [\n        {\n            \"POPF1\": \"yash\",\n            \"POPF2\": null,\n            \"UE__IU__CREATE_DATE\": \"2026-06-25T14:06:38-04:00\",\n            \"UE__IU__UPDATE_DATE\": null\n        }\n    ],\n    \"message\": null\n}"
string
Contact Us
Copyright © 2024 CMiC All Rights Reserved