> ## 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.

# getDefinition

> # GET /v2/user-extension/definition/{tableCode} — Get Key Definitions

## Overview

This endpoint tells you what `objectKey1`, `objectKey2`, and any additional key slots mean for a given UE table code. Call this before making a POST, PATCH, or DELETE if you are unsure which business key values to pass for an unfamiliar table.

It returns the parent object table name and the ordered list of business key column names so you know exactly what each slot represents before making a data call.

| Property | Value |
| --- | --- |
| URL | `{base_url}/sys-rest-api/jersey/v2/user-extension/definition/{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, not as a query string.

If the table code does not exist or the parent object is not supported by the UE API, the endpoint returns a 400.

This is a metadata-only call. Nothing is created, modified, or deleted.

---

## 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 confirm the key structure of a table code before working with it.

---

## Finders

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `tableCode` | Path | Yes | The UE table code to look up (e.g. `CIITEM_K`, `PROJ_EXT`, `JCJOB_K`). |

**Examples:**

Look up key definitions for a Cost Item extension table:

```
GET .../v2/user-extension/definition/CIITEM_K

 ```

Look up key definitions for a Project extension table:

```
GET .../v2/user-extension/definition/PROJ_EXT

 ```

---

## Attributes

### Response

| Field | Type | Description | Example |
| --- | --- | --- | --- |
| `tableCode` | String | The table code that was looked up | `CIITEM_K` |
| `objectTable` | String | Parent object table this UE table belongs to | `CIITEM` |
| `keyCount` | Integer | Number of business key columns for this object | `2` |
| `keys` | Array | Ordered list of key slot definitions |  |
| `keys[].position` | Integer | Key slot number (1-based). Position 1 maps to `objectKey1`, position 2 to `objectKey2`, and so on. | `1` |
| `keys[].columnName` | String | Actual database column name for this key slot | `CIITEM_COMP_CODE` |
| `keys[].label` | String | Human-readable label for this key slot | `Company Code` |

---

## Example

### Request — Cost Item extension

```
GET {base_url}/sys-rest-api/jersey/v2/user-extension/definition/CIITEM_K
Authorization: Basic {credentials}

 ```

### Response — 200 OK

```
{
  "tableCode": "CIITEM_K",
  "objectTable": "CIITEM",
  "keyCount": 2,
  "keys": [
    { "position": 1, "columnName": "CIITEM_COMP_CODE", "label": "Company Code" },
    { "position": 2, "columnName": "CIITEM_ITEM_CODE", "label": "Item Code"    }
  ]
}

 ```

This tells you that when calling POST, PATCH, or DELETE for table code `CIITEM_K`:

- `objectKey1` = Company Code (e.g. `01`)
    
- `objectKey2` = Item Code (e.g. `BOLT-123`)
    

### Request — Project extension

```
GET {base_url}/sys-rest-api/jersey/v2/user-extension/definition/PROJ_EXT
Authorization: Basic {credentials}

 ```

### Response — 200 OK

```
{
  "tableCode": "PROJ_EXT",
  "objectTable": "PROJECT",
  "keyCount": 2,
  "keys": [
    { "position": 1, "columnName": "PROJ_COMP_CODE", "label": "Company Code"   },
    { "position": 2, "columnName": "PROJ_NUM",        "label": "Project Number" }
  ]
}

 ```

### Error — Invalid Table Code (400)

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

 ```

---

## 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 |
| 500 | — | Unhandled server error |

## OpenAPI

````json GET /sys-rest-api/jersey/v2/user-extension/definition/CIITEM_K
{
  "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/definition/CIITEM_K": {
      "get": {
        "tags": [
          "Core System | User-extension"
        ],
        "summary": "getDefinition",
        "description": "# GET /v2/user-extension/definition/{tableCode} — Get Key Definitions\n\n## Overview\n\nThis endpoint tells you what `objectKey1`, `objectKey2`, and any additional key slots mean for a given UE table code. Call this before making a POST, PATCH, or DELETE if you are unsure which business key values to pass for an unfamiliar table.\n\nIt returns the parent object table name and the ordered list of business key column names so you know exactly what each slot represents before making a data call.\n\n| Property | Value |\n| --- | --- |\n| URL | `{base_url}/sys-rest-api/jersey/v2/user-extension/definition/{tableCode}` |\n| Method | `GET` |\n| 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\n`tableCode` is a path parameter — it goes directly in the URL, not as a query string.\n\nIf the table code does not exist or the parent object is not supported by the UE API, the endpoint returns a 400.\n\nThis is a metadata-only call. Nothing is created, modified, or deleted.\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. Use this endpoint to confirm the key structure of a table code before working with it.\n\n---\n\n## Finders\n\n| Parameter | Type | Required | Description |\n| --- | --- | --- | --- |\n| `tableCode` | Path | Yes | The UE table code to look up (e.g. `CIITEM_K`, `PROJ_EXT`, `JCJOB_K`). |\n\n**Examples:**\n\nLook up key definitions for a Cost Item extension table:\n\n```\nGET .../v2/user-extension/definition/CIITEM_K\n\n ```\n\nLook up key definitions for a Project extension table:\n\n```\nGET .../v2/user-extension/definition/PROJ_EXT\n\n ```\n\n---\n\n## Attributes\n\n### Response\n\n| Field | Type | Description | Example |\n| --- | --- | --- | --- |\n| `tableCode` | String | The table code that was looked up | `CIITEM_K` |\n| `objectTable` | String | Parent object table this UE table belongs to | `CIITEM` |\n| `keyCount` | Integer | Number of business key columns for this object | `2` |\n| `keys` | Array | Ordered list of key slot definitions |  |\n| `keys[].position` | Integer | Key slot number (1-based). Position 1 maps to `objectKey1`, position 2 to `objectKey2`, and so on. | `1` |\n| `keys[].columnName` | String | Actual database column name for this key slot | `CIITEM_COMP_CODE` |\n| `keys[].label` | String | Human-readable label for this key slot | `Company Code` |\n\n---\n\n## Example\n\n### Request — Cost Item extension\n\n```\nGET {base_url}/sys-rest-api/jersey/v2/user-extension/definition/CIITEM_K\nAuthorization: Basic {credentials}\n\n ```\n\n### Response — 200 OK\n\n```\n{\n  \"tableCode\": \"CIITEM_K\",\n  \"objectTable\": \"CIITEM\",\n  \"keyCount\": 2,\n  \"keys\": [\n    { \"position\": 1, \"columnName\": \"CIITEM_COMP_CODE\", \"label\": \"Company Code\" },\n    { \"position\": 2, \"columnName\": \"CIITEM_ITEM_CODE\", \"label\": \"Item Code\"    }\n  ]\n}\n\n ```\n\nThis tells you that when calling POST, PATCH, or DELETE for table code `CIITEM_K`:\n\n- `objectKey1` = Company Code (e.g. `01`)\n    \n- `objectKey2` = Item Code (e.g. `BOLT-123`)\n    \n\n### Request — Project extension\n\n```\nGET {base_url}/sys-rest-api/jersey/v2/user-extension/definition/PROJ_EXT\nAuthorization: Basic {credentials}\n\n ```\n\n### Response — 200 OK\n\n```\n{\n  \"tableCode\": \"PROJ_EXT\",\n  \"objectTable\": \"PROJECT\",\n  \"keyCount\": 2,\n  \"keys\": [\n    { \"position\": 1, \"columnName\": \"PROJ_COMP_CODE\", \"label\": \"Company Code\"   },\n    { \"position\": 2, \"columnName\": \"PROJ_NUM\",        \"label\": \"Project Number\" }\n  ]\n}\n\n ```\n\n### Error — Invalid Table Code (400)\n\n```\n{\n  \"error\": \"SD-000376-ERR: Table code 'XYZ' is not valid or the object is not supported.\"\n}\n\n ```\n\n---\n\n## Error Codes\n\n| HTTP | Error Code | Reason |\n| --- | --- | --- |\n| 400 | `SD-000375-ERR` | `tableCode` path parameter is blank or missing |\n| 400 | `SD-000376-ERR` | Table code does not exist or the parent object is not supported by the UE API |\n| 500 | — | Unhandled server error |",
        "responses": {
          "200": {
            "description": "OK",
            "headers": {
              "Content-Type": {
                "schema": {
                  "type": "string",
                  "example": "application/json"
                }
              }
            },
            "content": {
              "text/plain": {
                "schema": {
                  "type": "string"
                },
                "example": "{\n    \"tableCode\": \"CIITEM_K\",\n    \"masterTableCode\": \"CIITEM\",\n    \"objectKeys\": [\n        {\n            \"objectKey\": \"objectKey1\",\n            \"objectKeyName\": \"CIITEM_COMP_CODE\"\n        },\n        {\n            \"objectKey\": \"objectKey2\",\n            \"objectKeyName\": \"CIITEM_ITEM_CODE\"\n        }\n    ]\n}"
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "cmicBasicAuth": {
        "type": "http",
        "scheme": "basic",
        "description": "Basic authentication"
      }
    }
  }
}
````