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 | The human-friendly definition of the given field. |
| DisplayName | String | 100 | DisplayName |
| 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 | Numeric length of data in field. |
| LookupName | String | 100 | Identifies which sets of standard or local lookups are referenced in the Lookup Resource. |
| ModelKey InKey | String | 20 | The key of the related model that the given field belongs to. |
| 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 | The total number of significant digits stored, both to the left and right of the decimal point. |
| RESOStandardYN | Boolean | RESOStandardYN | |
| ResourceName | String | 100 | 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., "Property"). |
| SystemReferenceCount | Int64 | 10 | SystemReferenceCount |
| SystemReferences | String | 8000 | SystemReferences |
| Type | String | 30 | The transport-specific data type. |