Skip to main content

Customfieldconfiguration

Represents the custom field definition configuration.

availableForAllboolean

TRUE if a custom field is available for all objects, FALSE otherwise.

defaultboolean
dependentFieldIdstring

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

displaySettings objectrequired

Represents the display settings of a custom field definition.

descriptionstring

The user-provided description of the custom field definition.

displayNamestringrequired

The user-provided name of the custom field definition.

fieldSizestringrequired

The custom field value display size in the UI.

Possible values: [SHORT, LONG]

editRights object

Represents the access rights configuration.

allUsersboolean

TRUE if the configuration can be viewed or edited by all users, FALSE if only the users with the specified roles can view or edit the configuration.

rolesstring[]
idstringrequired

The user-defined ID, which is globally unique.

requiredboolean
searchIndexes object

The search index information for the custom field definition. empty if field is not searchable

property name*integer<int32>

The search index information for the custom field definition. empty if field is not searchable

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[]required

    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.

    selectionIdstringrequired

    The system-generated ID of the option.

    valuestringrequired

    The name of the option.

  • ]
    • forSelectionIdstring

    The ID for the parent selection custom field value. Can only be set if the custom field has the dependent field defined.

  • ]
    • statestringrequired

    Indicates whether the custom field definition is active or inactive.

    Possible values: [ACTIVE, INACTIVE]

    typestringrequired

    The type of custom field definition.

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

    usage object[]

    Defines the usage at the record type level. The custom field definition is going to be available only for the record types that are referenced in the list by ID. Mutually exclusive with usage defined on custom field definition level by therequired and default properties. For selection custom field definitions that have a dependentFieldId set, the usage is inherited from the dependent field and must not be defined.

  • Array [
    • defaultboolean
    idstring

    The user-defined ID of the associated entity. The ID must already exist.

    requiredboolean
  • ]
    • validationRules 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 access rights configuration.

    allUsersboolean

    TRUE if the configuration can be viewed or edited by all users, FALSE if only the users with the specified roles can view or edit the configuration.

    rolesstring[]
    Customfieldconfiguration
    {
      "availableForAll": true,
      "default": true,
      "dependentFieldId": "string",
      "displaySettings": {
        "description": "string",
        "displayName": "string",
        "fieldSize": "SHORT"
      },
      "editRights": {
        "allUsers": true,
        "roles": [
          "string"
        ]
      },
      "id": "string",
      "required": true,
      "searchIndexes": {},
      "selectionOptions": [
        {
          "availableOptions": [
            {
              "score": 0,
              "selectionId": "string",
              "value": "string"
            }
          ],
          "forSelectionId": "string"
        }
      ],
      "state": "ACTIVE",
      "type": "FREE_TEXT",
      "usage": [
        {
          "default": true,
          "id": "string",
          "required": true
        }
      ],
      "validationRules": {
        "unique": true,
        "validationPattern": "string"
      },
      "viewRights": {
        "allUsers": true,
        "roles": [
          "string"
        ]
      }
    }