ConnectorEntityField

Object

A typed column of an entity. options is free-form JSON owned by the connector SDK. Today it carries the allow-list of target types for an ENTITY_REF field:

{ "allowedTypes": ["Floor", "Building"] }

type ConnectorEntityField {
  defaultValue: ConnectorEntityFieldValue
  hidden: Boolean
  label: String
  name: String
  options: GraphQLJSON
  readOnly: Boolean
  relationship: ConnectorEntityFieldRelationship
  required: Boolean
  type: ConnectorEntityFieldType
  unique: Boolean
  value: ConnectorEntityFieldValue
}

Fields

Field	Type	Description
defaultValue	ConnectorEntityFieldValue
hidden	Boolean
label	String
name	String
options	GraphQLJSON	Free-form JSON; see the example in the type description.
readOnly	Boolean
relationship	ConnectorEntityFieldRelationship
required	Boolean
type	ConnectorEntityFieldType
unique	Boolean
value	ConnectorEntityFieldValue

Used by

• ConnectorEntity.fields (field)