Skip to main content

Customfieldmeta

Represents a custom field definition.

availableForstring

The entity type the custom field definition is associated with.

Possible values: [CLIENT, GROUP, CREDIT_ARRANGEMENT, LOAN_ACCOUNT, GUARANTOR, ASSET, DEPOSIT_ACCOUNT, DEPOSIT_PRODUCT, TRANSACTION_CHANNEL, TRANSACTION_TYPE, BRANCH, CENTRE, USER]

creationDatestring<date-time>

The date the custom field definition was created.

Example: 2016-09-06T13:37:50+03:00
dependentFieldKeystring

Can be defined only for selection custom field definitions. Indicates the parent custom field definition on which the dependency is based upon.

displaySettings object

Represents the display settings of a custom field definition.

builtInIdstring

The original ID of the built-in custom field definition.

Possible values: [FIRST_NAME, MIDDLE_NAME, LAST_NAME, BIRTHDATE, GENDER, MOBILE_PHONE, MOBILE_PHONE_2, HOME_PHONE, EMAIL_ADDRESS]

descriptionstring

The user-provided description of the custom field definition.

displayNamestring

The user-provided name of the custom field definition.

fieldSizestring

The custom field value display size in the UI.

Possible values: [SHORT, LONG]

positioninteger<int32>

The custom field definition position in the custom field set.

editRights object

Represents the edit rights for custom field values for a particular custom field definition.

allUsersboolean

TRUE if custom field values of a custom field definition can be edited by all users, FALSE if custom field values of a custom field definition can only be edited by users with the specified roles.

rolesstring[]

The list of IDs of the roles that have edit rights for the custom field values of a custom field definition if it is not accessible by all users.

encodedKeystring

The encoded key of the entity, generated, globally unique

idstring

The user-defined ID, which is globally unique.

lastModifiedDatestring<date-time>

The date the latest update was performed for this custom field definition.

Example: 2016-09-06T13:37:50+03:00
selectionOptions object[]

Can be defined only for selection custom field definitions. Indicates that the field has predefined selections and only those can be used to populate it.

  • Array [
    • availableOptions object[]

    The list of options that that are available for the dependent selection custom field value based on the selected parent custom field value.

  • Array [
    • scorenumber

    The score of the option.

    selectionKeystring

    The system-generated ID of the option.

    valuestring

    The name of the option.

  • ]
    • forSelectionKeystring

    The key for the parent selection custom field value.

    forValuestring

    The parent selection custom field value.

  • ]
    • statestring

    Indicates whether the custom field definition is active or inactive.

    Possible values: [ACTIVE, INACTIVE]

    typestring

    The type of custom field definition.

    Possible values: [FREE_TEXT, SELECTION, NUMBER, CHECKBOX, DATE, DATE_TIME, CLIENT_LINK, GROUP_LINK, USER_LINK]

    usage object[]

    Represents the usage settings of a custom field definition.

  • Array [
    • defaultboolean

    TRUE if the field is displayed by default on create or edit pages for this record type, FALSE otherwise.

    objectKeystring

    The key of the record type.

    requiredboolean

    TRUE if the field is required for this record type, FALSE otherwise.

  • ]
    • valueValidationSettings object

    Represents the settings for field input validation.

    uniqueboolean

    TRUE if this field does not allow duplicate values, FALSE otherwise.

    validationPatternstring

    The expected format for the input.

    viewRights object

    Represents the view rights for custom field values for a particular custom field definition.

    allUsersboolean

    TRUE if custom field values of a custom field definition can be viewed by all users, FALSE if custom field values of a custom field definition can only be viewed by users with the specified roles.

    rolesstring[]

    Lists the IDs of the roles that have view rights for the custom field values of a custom field definition if it is not accessible by all users.

    Customfieldmeta
    {
      "availableFor": "CLIENT",
      "creationDate": "2016-09-06T13:37:50+03:00",
      "dependentFieldKey": "string",
      "displaySettings": {
        "builtInId": "FIRST_NAME",
        "description": "string",
        "displayName": "string",
        "fieldSize": "SHORT",
        "position": 0
      },
      "editRights": {
        "allUsers": true,
        "roles": [
          "string"
        ]
      },
      "encodedKey": "string",
      "id": "string",
      "lastModifiedDate": "2016-09-06T13:37:50+03:00",
      "selectionOptions": [
        {
          "availableOptions": [
            {
              "score": 0,
              "selectionKey": "string",
              "value": "string"
            }
          ],
          "forSelectionKey": "string",
          "forValue": "string"
        }
      ],
      "state": "ACTIVE",
      "type": "FREE_TEXT",
      "usage": [
        {
          "default": true,
          "objectKey": "string",
          "required": true
        }
      ],
      "valueValidationSettings": {
        "unique": true,
        "validationPattern": "string"
      },
      "viewRights": {
        "allUsers": true,
        "roles": [
          "string"
        ]
      }
    }