Contents x
    Create a User Extension Field Value
    • 13 Jun 2025
    • 9 Minutes to read
    • Print
    • Dark
      Light
    Contents

    Create a User Extension Field Value

    • Updated on 13 Jun 2025
    • 9 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Post
    /sys-rest-api/rest/1/sdobjusrextvalue

    Overview

    User Extensions allow the functionality of the software to be extended through the creation of custom input fields. These input fields are attached to custom tables. The tables allow for storage and easy access of all miscellaneous information.

    Notes

    • Before working with a User Extension Field value, retrieve its definition using the User Extension Definition endpoint. Once the definition is established in CMiC, you can create, retrieve, or update the field’s value as needed

    UI Navigation

    System > User Extension > Field Maintenance

    Reference Article

    Body Parameters

    General Body Parameters

    CMiC UI FieldnameNameDescriptionTypeData LengthExampleRequired
    Schema NameUevUedSchemaNameStatic code 'DA'string30‘DA’Yes
    Table NameUevUedTableNameEnter the Object Type Table Name. In CMiC, object tables are database tables that store rows of records.

    Click here to view a list of Object Tables.    		string30‘PYEMPLOYEE_TABLE’Yes
    VUUIDUevVUuidThe VUuid attribute is the Unique row IDstring64E41D157899B9807FE0530100007F304FNo
    Create DateUevIuCreateDateThis field displays the date and time when any user-defined field (UDF) value was first assigned to a record. For example, if you initially set UEV_CODE1 for a record, that timestamp becomes the create date—even if additional UDF values (such as UEV_CODE2, UEV_NUM1, etc.) are added later.Datetime2018-09-25T11:58:09-04:00
    Update DateUevIuUpdateDateThis field shows the most recent date and time when any UDF value within the record was created or updated. Since all UDF values for a record are stored together, UevIuUpdateDate reflects the timestamp of the latest modification made to any of those fields.Datetime2025-01-27T17:52:51-05:00
    (Deprecated)UevObjectColumnThis field has been deprecated and should be left blank.string64-
    (Deprecated)UevObjectValueThis field has been deprecated and should be left blank.string4000-
    Object KeysUevObjectKeyPlease refer to the Object Keys Section below for more information………
    UEV CodesUevCodePlease refer to the UEV Code Section below for more information………
    UEV NumbersUevNumPlease refer to the UEV Number Section below for more information………
    UEV DatesUevDatePlease refer to the UEV Date Section below for more information………

    Object Keys

    The UEV Keys in the Object Table are unique identifiers used to retrieve specific records. Refer to the Object Key Tables for a comprehensive list of Object Types and their corresponding Keys.

    CMiC UI Fieldname

    Name

    Description

    Type

    Data Length

    Example

    Object Key 1

    UevObjectKey1

    Unique identifier for record retrieval.

    For example, when using PYEMPLOYEE_TABLE, Object Key 1 corresponds to Emp Number. In which case you would enter the Employee number (e.g. 1406)

    string

    30

    1406

    Object Key 2

    UevObjectKey2

    Unique identifier for record retrieval. For example, when using BPVENDORS, Object Key 2 corresponds to Bp Code. In which case you would enter the BP Code (e.g. ZZ)

    string

    30

    ZZ

    Object Key 3

    UevObjectKey3

    Unique identifier for record retrieval. For example, when using CMMAST, Object Key 3 corresponds to Cmm Code. In which case you would enter the Cmm Code (e.g. 0009EXT)

    string

    30

    0009EXT

    Object Key 4

    UevObjectKey4

    Unique identifier for record retrieval. For example, when using SCMAST, Object Key 4 corresponds to Change Code. In which case you would enter the Chagne Code (e.g. 001)

    string

    30

    001

    UEV Codes

    UEV Code represents a user-defined field (UDF) configured to store string values. All UevCode fields correspond to custom fields for the table specified in the ‘UevUedTableName’ field. Their definitions can be retrieved using the User Extension Definition endpoint. For more details on creating, updating, or reviewing values, see the Creating a User Extension Field Value guide.

    CMiC UI FieldnameNameDescriptionTypeData LengthExample
    Uev Code 1UevCode1User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, UevCode1 associated with the PYEMPLOYEE_TABLE might be defined in the User Extension Definition as the attribute "Driver License." In this case, you would store the driver's license information in that field (e.g. AW-1425-77888). Alternatively, UevCode1 could represent a different user-defined value depending on its configuration..    		string4000AW-1425-77888
    Uev Code 2UevCode2User-defined field. Refer to the User Extension Definition endpoint for details

    For example, UevCode2 associated with the PYEMPLOYEE_TABLE might be defined in the User Extension Definition as the attribute "Driver License." In this case, you would store the driver's license information in that field(e.g. AW-1425-77888). Alternatively, UevCode2 could represent a different user-defined value depending on its configuration.    		string4000AW-1425-77888
    Uev Code 3UevCode3User-defined field. Refer to the User Extension Definition endpoint for details

    For example, UevCode3 associated with the PYEMPLOYEE_TABLE might be defined in the User Extension Definition as the attribute "Driver License." In this case, you would store the driver's license information in that field (e.g. AW-1425-77888). Alternatively, UevCode3 could represent a different user-defined value depending on its configuration.    		string4000AW-1425-77888
    ……... (Additional UEV Codes follow the same structure)string4000…
    UEV Code 100UevCode100User-defined field. Refer to the User Extension Definition endpoint for details.

    For example, UevCode100 associated with the PYEMPLOYEE_TABLE might be defined in the User Extension Definition as the attribute "Driver License." In this case, you would store the driver's license information in that field (e.g. AW-1425-77888). Alternatively, UevCode100 could represent a different user-defined value depending on its configuration.    		string4000AW-1425-77888

    UEV Numbers

    Similar to UEV Codes, UEV Numbers represents a user-defined field (UDF) configured to store numeric values. All UevNum fields correspond to custom fields for the table specified in the ‘UevUedTableName’ field. Their definitions can be retrieved using the User Extension Definition endpoint. For more details on creating, updating, or reviewing values, see the Creating a User Extension Field Value guide.

    CMiC UI FieldnameNameDescriptionTypeData LengthExample
    UEV Number 1UevNum1User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevNum1 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Years of Service," you would store the employee's years of service as a numeric value (e.g., 10) in that field.    		number10
    UEV Number 2UevNum2User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevNum2 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Years of Service," you would store the employee's years of service as a numeric value (e.g., 10) in that field.    		number10
    UEV Number 3UevNum3User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevNum3 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Years of Service," you would store the employee's years of service as a numeric value (e.g., 10) in that field.    		number10
    ……… (Additional UEV Numbers follow the same structure)number……
    UEV Number 20UevNum20User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevNum20 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Years of Service," you would store the employee's years of service as a numeric value (e.g., 10) in that field.    		number10

    UEV Dates

    Similar to UEV Codes, UEV Dates represents a user-defined field (UDF) configured to store datetime values. All UevDate fields correspond to custom fields for the table specified in the ‘UevUedTableName’ field. Their definitions can be retrieved using the User Extension Definition endpoint. For more details on creating, updating, or reviewing values, see the Creating a User Extension Field Value guide.

    CMiC UI FieldnameNameDescriptionTypeData LengthExample
    UEV Date 1UevDate1User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevDate1 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Date of Birth," you would store the employee's date of birth as a Date value (e.g., 1994-07-31) in that field.    		Date1994-07-31
    UEV Date 2UevDate2User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevDate2 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Date of Birth," you would store the employee's date of birth as a Date value (e.g., 1994-07-31) in that field.    		Date1994-07-31
    UEV Date 3UevDate3User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevDate3 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Date of Birth," you would store the employee's date of birth as a Date value (e.g., 1994-07-31) in that field.    		Date1994-07-31
    ……… (Additional UEV Dates follow the same structure)Date
    UEV Date 20UevDate20User-defined field. Refer to the User Extension Definition endpoint for detail.

    For example, if UevDate20 in the PYEMPLOYEE_TABLE is defined in the User Extension Definition as the attribute "Date of Birth," you would store the employee's date of birth as a Date value (e.g., 1994-07-31) in that field.    		Date1994-07-31
    Security
    HTTP
    Type basic

    Basic authentication

    Header parameters
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceItem+json
    Body parameters
    object
    Example{ "UevUedSchemaName": "T", "UevUedTableName": "TEST", "UevObjectKey1": "test1", "UevObjectKey2": "test2", "UevObjectKey3": "test3", "UevObjectKey4": "test4", "UevVUuid": "" }
    Responses
    201

    Created

    Headers
    Content-Type
    string
    Exampleapplication/vnd.oracle.adf.resourceitem+json
    {
  "UevUedSchemaName": "T",
  "UevUedTableName": "TEST",
  "UevObjectKey1": "test1",
  "UevObjectKey2": "test2",
  "UevObjectKey3": "test3",
  "UevObjectKey4": "test4",
  "UevCode1": null,
  "UevCode2": null,
  "UevCode3": null,
  "UevCode4": null,
  "UevCode5": null,
  "UevCode6": null,
  "UevCode7": null,
  "UevCode8": null,
  "UevCode9": null,
  "UevCode10": null,
  "UevCode11": null,
  "UevCode12": null,
  "UevCode13": null,
  "UevCode14": null,
  "UevCode15": null,
  "UevCode16": null,
  "UevCode17": null,
  "UevCode18": null,
  "UevCode19": null,
  "UevCode20": null,
  "UevNum1": null,
  "UevNum2": null,
  "UevNum3": null,
  "UevNum4": null,
  "UevNum5": null,
  "UevNum6": null,
  "UevNum7": null,
  "UevNum8": null,
  "UevNum9": null,
  "UevNum10": null,
  "UevNum11": null,
  "UevNum12": null,
  "UevNum13": null,
  "UevNum14": null,
  "UevNum15": null,
  "UevNum16": null,
  "UevNum17": null,
  "UevNum18": null,
  "UevNum19": null,
  "UevNum20": null,
  "UevDate1": null,
  "UevDate2": null,
  "UevDate3": null,
  "UevDate4": null,
  "UevDate5": null,
  "UevDate6": null,
  "UevDate7": null,
  "UevDate8": null,
  "UevDate9": null,
  "UevDate10": null,
  "UevDate11": null,
  "UevDate12": null,
  "UevDate13": null,
  "UevDate14": null,
  "UevDate15": null,
  "UevDate16": null,
  "UevDate17": null,
  "UevDate18": null,
  "UevDate19": null,
  "UevDate20": null,
  "UevIuCreateDate": null,
  "UevIuUpdateDate": null,
  "UevCode21": null,
  "UevCode22": null,
  "UevCode23": null,
  "UevCode24": null,
  "UevCode25": null,
  "UevCode26": null,
  "UevCode27": null,
  "UevCode28": null,
  "UevCode29": null,
  "UevCode30": null,
  "UevCode31": null,
  "UevCode32": null,
  "UevCode33": null,
  "UevCode34": null,
  "UevCode35": null,
  "UevCode36": null,
  "UevCode37": null,
  "UevCode38": null,
  "UevCode39": null,
  "UevCode40": null,
  "UevCode41": null,
  "UevCode42": null,
  "UevCode43": null,
  "UevCode44": null,
  "UevCode45": null,
  "UevCode46": null,
  "UevCode47": null,
  "UevCode48": null,
  "UevCode49": null,
  "UevCode50": null,
  "UevCode51": null,
  "UevCode52": null,
  "UevCode53": null,
  "UevCode54": null,
  "UevCode55": null,
  "UevCode56": null,
  "UevCode57": null,
  "UevCode58": null,
  "UevCode59": null,
  "UevCode60": null,
  "UevCode61": null,
  "UevCode62": null,
  "UevCode63": null,
  "UevCode64": null,
  "UevCode65": null,
  "UevCode66": null,
  "UevCode67": null,
  "UevCode68": null,
  "UevCode69": null,
  "UevCode70": null,
  "UevCode71": null,
  "UevCode72": null,
  "UevCode73": null,
  "UevCode74": null,
  "UevCode75": null,
  "UevCode76": null,
  "UevCode77": null,
  "UevCode78": null,
  "UevCode79": null,
  "UevCode80": null,
  "UevCode81": null,
  "UevCode82": null,
  "UevCode83": null,
  "UevCode84": null,
  "UevCode85": null,
  "UevCode86": null,
  "UevCode87": null,
  "UevCode88": null,
  "UevCode89": null,
  "UevCode90": null,
  "UevCode91": null,
  "UevCode92": null,
  "UevCode93": null,
  "UevCode94": null,
  "UevCode95": null,
  "UevCode96": null,
  "UevCode97": null,
  "UevCode98": null,
  "UevCode99": null,
  "UevCode100": null,
  "UevObjectColumn": "",
  "UevObjectValue": "",
  "UevVUuid": "F37C0CE0515D4EF8E05316821FAC41AB",
  "links": [
    {
      "rel": "self",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sdobjusrextvalue/F37C0CE0515D4EF8E05316821FAC41AB",
      "name": "sdobjusrextvalue",
      "kind": "item"
    },
    {
      "rel": "canonical",
      "href": "http://mobtest.cmiccloudr12.com:80/cmictestrti/sys-rest-api/rest/1/sdobjusrextvalue/F37C0CE0515D4EF8E05316821FAC41AB",
      "name": "sdobjusrextvalue",
      "kind": "item"
    }
  ]
}
    object
    What's Next
    Contact Us
    Copyright © 2024 CMiC All Rights Reserved