INPUT_OBJECT

LookupPropertyParams

Definition of a lookup field: the entity it links to, which records can be selected and the tab that shows the linked records.

link GraphQL Schema definition

  • input LookupPropertyParams {
  • # Entity the lookup field links to; CustomEntity for a custom entity (see
  • # entityApiName).
  • entityType: LookupEntityTypeEnum
  • # Name of the tab that shows the records linked through this field.
  • tabName: String!
  • # Condition limiting which records can be selected in the field.
  • filter: FieldFilterParams
  • # When true, the field offers only records related to the record being edited
  • # (e.g. the contacts of its account). Allowed only from Account (to Account,
  • # Contact, Opportunity, Task, Appointment), Contact, Project (to Opportunity,
  • # Task, Appointment), Lead / Opportunity (to Task, Appointment), Quote (to
  • # Opportunity, Account, Contact, Task, Appointment) and a custom entity (to
  • # Account, Contact, Task, Appointment, Project, Quote); any entity may target a
  • # custom entity. Elsewhere it must be false.
  • showRelated: Boolean!
  • # API name of the linked custom entity when entityType is CustomEntity; null
  • # otherwise.
  • entityApiName: String
  • # Id of the matching lookup field on the linked entity, which shows the same links
  • # from the other side. Set by the server; ignored on input.
  • oppositeLookupFieldId: UUID
  • # When true, one of the linked records can be marked as primary. Cannot be
  • # switched back to false once enabled.
  • hasPrimaryRelation: Boolean
  • }