OBJECT

ReportSiblingBox

Box of a report table that shows columns from records related to the main box.

link GraphQL Schema definition

  • type ReportSiblingBox implements ReportBoxInterface, VisibleBoxInterface, SiblingBoxInterface {
  • # Unique identifier of the box within the report structure.
  • id: ID!
  • # Id of the opportunity value field the report uses for amount calculations, such
  • # as won amounts compared with targets; applied only when the box entity is
  • # Opportunity or LeadOppty.
  • calculationFieldId: ID
  • # Entity type whose records this box reports on, such as Account, Lead or
  • # Opportunity.
  • entityType: EntityNameEnum!
  • # API name of the entity for this box; set for custom entities to identify which
  • # one is used.
  • entityApiName: String
  • # List of possible entity subtypes of entityType, if entity type is abstract you
  • # can supply with entityTypes of all children of abstract entity
  • entitySubtypes: [EntitySubtypeItem!]
  • # Name of the box, shown as the heading above the box's columns in printed and
  • # exported reports.
  • name: String!
  • # An ordered list of field ID to display with width and color information from box
  • # source
  • displayFields: [DisplayFieldItem!]!
  • # Identifier of the lookup field that links this sibling box to its parent box;
  • # set when the relation is defined through a specific lookup field.
  • lookupFieldId: UUID
  • # How records in this sibling box relate to the parent box, either an aggregation
  • # over related records or a predefined hardcoded relation.
  • relation: SiblingBoxRelationType
  • }

link Require by

This element is not required by anyone