FieldDefinitions

Fetch a field definition.

Changed on
get/v2/fielddefinitions/{id}

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/v2/fielddefinitions/{id}
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idinteger required

The field definition unqiue Id.

Response

A model representing the field definition.

idinteger

The ID of this record.

codestring

The field code without any prefix. E.g. "F1".

descriptionstring
full_codestring

The fully qualified field code as used in templates. E.g. "BXF1".

namestring
type'booking' | 'property' | 'account' | 'owner' | 'contact'

The type of records to which this field applies.

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      api operation id FieldDefinitions_Get2 removed and replaced with get-fielddefinitions-id