Skip to main content

SalesforceLookupField

One lookup (reference) field, expanded with the fields of the objects it can point at.

type SalesforceLookupField {
  name: String!
  label: String
  relationshipName: String
  referenceTo: [String]
  referencedObjectFields: [[SalesforceField]]
  nillable: Boolean
  custom: Boolean
  inlineHelpText: String
}

Fields​

SalesforceLookupField.name ● String! non-null scalar​

API name of the lookup field. For an extra object pulled in by the workspace's configured objects-to-sync, this is that object's own API name instead.

SalesforceLookupField.label ● String scalar​

Display label of the lookup field.

SalesforceLookupField.relationshipName ● String scalar​

Salesforce relationship name used to traverse the lookup in SOQL.

SalesforceLookupField.referenceTo ● [String] list scalar​

API names of the objects this lookup can point at.

SalesforceLookupField.referencedObjectFields ● [[SalesforceField]] list object​

Field metadata for each entry in referenceTo, in the same order. An entry is null when that object could not be described, and is restricted to custom fields when customObjectsOnly is set.

SalesforceLookupField.nillable ● Boolean scalar​

True when the lookup accepts null.

SalesforceLookupField.custom ● Boolean scalar​

True when the lookup is a custom (non-standard) field.

SalesforceLookupField.inlineHelpText ● String scalar​

Salesforce inline help text for the lookup field, when set.

Member Of​

SalesforceLookupFieldsResponse object