Field
The resource Field provides metadata about available fields in the data model, including field names, types, and descriptions.
This resource or some of its fields may not be available depending on your configuration.
This resource supports translations.
| Field name | Description | |
|---|---|---|
| # | CollectionYN | Indicates whether the field is part of a collection (Yes/No). |
| # | DisplayName | The user-friendly name of the field displayed in the UI. |
| # | EntityEventSequence | A unique, system-wide ID that can be used to represent the sequence in which an EntityEvent occurred in a given system. |
| # | FieldKey | The unique identifier assigned to each record in the system. |
| # | FieldName | The name of the field as expressed in the payload. For OData APIs, this field MUST meet certain naming requirements and should be consistent with what’s advertised in the OData XML metadata (to be verified in certification). For example, “ListPrice.” |
| # | Length | The maximum number of characters allowed for the field. |
| # | LookupName | Indicates what lookup this field refers to (if any). |
| # | ModelKey | The unique identifier of the model. |
| # | ModificationTimestamp | The date and time when the record was last modified. |
| # | NullableYN | Indicates whether the field can be null (Yes/No). |
| # | OrderableYN | Specifies whether the field can be used for sorting (Yes/No). |
| # | Precision | The total number of significant digits for numeric fields. |
| # | Scale | The number of digits to the right of the decimal point for numeric fields. |
| # | SearchableYN | Indicates whether the field can be used for filtering (Yes/No). |
| # | Type | The data type of the field (e.g., String, Integer, Date). |
| # | UpdatableYN | Indicates whether the field can be updated after creation (Yes/No). |
| # | Translations | The translations of the resource. This is a navigation field to Translation. |