Skip to main content

ConnectorEntityFieldInput

Input

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"] }
input ConnectorEntityFieldInput {
defaultValue: ConnectorEntityFieldValueInput
hidden: Boolean
label: String
name: String
options: GraphQLJSON
readOnly: Boolean
relationship: ConnectorEntityFieldRelationshipInput
required: Boolean
type: ConnectorEntityFieldTypeInput
unique: Boolean
value: ConnectorEntityFieldValueInput
}

Input fields​

FieldTypeDefaultDescription
defaultValueConnectorEntityFieldValueInput
hiddenBoolean
labelString
nameString
optionsGraphQLJSONFree-form JSON; see the example in the type description.
readOnlyBoolean
relationshipConnectorEntityFieldRelationshipInput
requiredBoolean
typeConnectorEntityFieldTypeInput
uniqueBoolean
valueConnectorEntityFieldValueInput

Used by​