Field
GET
/trestle/odata/Field
GET
/trestle/rets/search?SearchType=Field&Class=Field
FieldKey is the primary key and uniquely identifies records in the Field resource.
The following fields are considered InKeyIndex fields and may be queried in batches up to 300,000 at a time:
FieldKey, ModelKey, ModificationTimestamp.
Fields
| Field | Type | Size | Description |
|---|---|---|---|
| Definition | String | 8000 | Definition |
| DisplayName | String | 100 | The display name for the field. SHOULD be provided in all cases where the use of display names is needed, even if the display name is the same as the underlying field name. The DisplayName MAY be a RESO Standard Display Name or a local one. |
| FieldKey Key InKey | String | 20 | The key used to uniquely identify the Field. |
| FieldName | String | 100 | 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 | Int64 | 10 | Length |
| LookupName | String | 100 | LookupName |
| ModelKey InKey | String | 20 | ModelKey |
| ModificationTimestamp InKey | DateTimeOffset | 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 to re-pull and reprocess the entire set of metadata when only a small number of changes have been made. | |
| NumOccurrences | Int64 | NumOccurrences | |
| Precision | Int64 | 10 | Precision |
| RESOStandardYN | Boolean | RESOStandardYN | |
| ResourceName | String | 100 | The name of the resource the field belongs to. This will be a RESO Standard Name, such as "Property", but may also be a non-standard local resource name. |
| SystemReferenceCount | Int64 | 10 | SystemReferenceCount |
| SystemReferences | String | 8000 | SystemReferences |
| Type | String | 30 | Type |