# CustomFieldConfiguration

Represents the custom field definition configuration.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**availableForAll** | **boolean** | `TRUE` if a custom field is available for all objects, `FALSE` otherwise. | [optional] [default to undefined]
**_default** | **boolean** |  | [optional] [default to undefined]
**dependentFieldId** | **string** | Can be defined only for selection custom field definitions. Indicates the parent custom field definition on which the dependency is based upon. | [optional] [default to undefined]
**displaySettings** | [**DisplaySettings**](DisplaySettings.md) |  | [default to undefined]
**editRights** | [**AccessRights**](AccessRights.md) |  | [optional] [default to undefined]
**id** | **string** | The user-defined ID, which is globally unique. | [default to undefined]
**required** | **boolean** |  | [optional] [default to undefined]
**searchIndexes** | **{ [key: string]: number; }** | The search index information for the custom field definition. empty if field is not searchable | [optional] [default to undefined]
**selectionOptions** | [**Array<SelectionOption>**](SelectionOption.md) | 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. | [optional] [default to undefined]
**state** | **string** | Indicates whether the custom field definition is active or inactive. | [default to undefined]
**type** | **string** | The type of custom field definition. | [default to undefined]
**usage** | [**Array<Usage>**](Usage.md) | 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 the`required` 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. | [optional] [default to undefined]
**validationRules** | [**ValidationRules**](ValidationRules.md) |  | [optional] [default to undefined]
**viewRights** | [**AccessRights**](AccessRights.md) |  | [optional] [default to undefined]

## Example

```typescript
import { CustomFieldConfiguration } from './api';

const instance: CustomFieldConfiguration = {
    availableForAll,
    _default,
    dependentFieldId,
    displaySettings,
    editRights,
    id,
    required,
    searchIndexes,
    selectionOptions,
    state,
    type,
    usage,
    validationRules,
    viewRights,
};
```

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)