19 fields · Last revised 8/15/2024
8/15/2024| Field | Definition | Type | Usage |
|---|
| Field | Definition | Type | Usage |
|---|---|---|---|
| Collection Yes/No CollectionYN | Boolean field describing whether a given field is a collection. | Boolean | 0% |
| Definition Definition | The human-friendly definition of the given field. | String | — |
| Expandable Yes/No ExpandableYN | Boolean field describing whether a given field is expandable. | Boolean | — |
| Feed Types FeedTypes | A list of feeds that the given field is part of. | String List, Multi | — |
| Field Key FieldKey | The key used to uniquely identify the field. | String | 2% |
| Field Name 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... more | String | 2% |
| Length Length | Numeric length of data in field. | Number | 0% |
| Lookup Name LookupName | Identifies which sets of standard or local lookups are referenced in the Lookup Resource. | String | 1% |
| Model Key ModelKey | The key of the related model that the given field belongs to. | String | 0% |
| Modification Timestamp ModificationTimestamp | The timestamp when the field metadata item was last modified. This is used to help rebuild caches when metadata items change so consumers don't have... more | Timestamp | 2% |
| Nullable Yes/No NullableYN | Boolean field describing whether a given field is nullable. | Boolean | 0% |
| Orderable Yes/No OrderableYN | Boolean value describing whether something is orderable. | Boolean | 0% |
| Precision Precision | The total number of significant digits stored, both to the left and right of the decimal point. | Number | 0% |
| Readable Yes/No ReadableYN | Boolean value describing whether something is readable. | Boolean | — |
| Resource Name ResourceName | The name of the resource the field belongs to. This will be a RESO Standard Name, when applicable, but may also be a local resource name (e.g.,... more | String | 2% |
| Scale Scale | The number of digits to the right of the decimal point. | Number | 1% |
| Searchable Yes/No SearchableYN | Boolean value describing whether something is searchable. | Boolean | 0% |
| Type Type | The transport-specific data type. | String List, Multi | 0% |
| Updatable Yes/No UpdatableYN | Boolean value describing whether something is updatable. | Boolean | — |