OBJECT

CustomEntityRelationEntity

Custom relation that links records of two entities through a pair of relation fields, one on each side.

link GraphQL Schema definition

  • type CustomEntityRelationEntity {
  • # True when the record is protected against deletion because it must always exist
  • # in the space. Deleting a record that is not protected can still fail on other
  • # checks. Read-only.
  • isDeleteProtected: Boolean!
  • # True when the record has unpublished draft changes, including pending
  • # translation changes, that can be published.
  • hasDraft: Boolean
  • # Unique identifier of entity.
  • id: ID!
  • # Specifies if the entity is considered deleted.
  • isDeleted: Boolean
  • # Last modification time.
  • modified: DateTime
  • # Creation time.
  • created: DateTime
  • # Lookup field on the first side of the custom relation: the lookup field the
  • # relation was created from.
  • field1: FieldEntity
  • # Lookup field on the second side of the custom relation, created automatically on
  • # the linked entity.
  • field2: FieldEntity
  • # Condition limiting which records of the field_1 entity can be selected in
  • # field_2, as a JSON object conforming to the `FieldFilter` type; empty for no
  • # restriction.
  • entityFilter1: JSONString
  • # Condition limiting which records of the field_2 entity can be selected in
  • # field_1, as a JSON object conforming to the `FieldFilter` type; empty for no
  • # restriction.
  • entityFilter2: JSONString
  • # Id of the lookup field on the first side of the custom relation.
  • field1Id: ID!
  • # Id of the lookup field on the second side of the custom relation.
  • field2Id: ID!
  • # When true, one of the records linked through the relation can be marked as
  • # primary. Cannot be switched back to false once enabled.
  • hasIsPrimary: Boolean
  • # When true, field2 offers only records related to the record being edited. Not
  • # supported yet; must be false.
  • showRelated1: Boolean
  • # When true, field1 offers only records related to the record being edited (e.g.
  • # the contacts of its account).
  • showRelated2: Boolean
  • # When true, the records linked through field1 are shown in a tab named tabName1.
  • showTab1: Boolean!
  • # When true, the records linked through field2 are shown in a tab named tabName2.
  • showTab2: Boolean!
  • # Name of the tab that shows the records linked through field1.
  • tabName1: String!
  • # Name of the tab that shows the records linked through field2.
  • tabName2: String!
  • # True when the entity configuration is published; false while it exists only as
  • # an unpublished draft.
  • isPublished: Boolean
  • # Revision when entity was lastly changed.
  • revision: Int
  • # Permissions the current user has on this record, out of the requested ones.
  • #
  • # Arguments
  • # permissions: Permissions to check; the result lists those the
  • # current user has.
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }

link Require by