OBJECT

ReportEntity

link GraphQL Schema definition

  • type ReportEntity {
  • # Tells if the entity instance is protected against delete (Entities that need to
  • # be present in the system at any time). Delete action still may fail if entity is
  • # deletable, due some other additional validations.
  • isDeleteProtected: 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
  • # User who owns the report or dashboard.
  • owner: ClientEntity
  • # Report folder this report is filed under (default folder when empty).
  • reportsFolder: ReportFolderEntity
  • # Specific record this report is synchronized to. Set only when sync_enabled is
  • # true.
  • syncEntity: ProfileEntity
  • # Public access token used in shareable report URLs. Empty when public sharing is
  • # not configured for the report.
  • accessLink: String
  • # AI assistant conversation associated with the report (e.g. records of AI-driven
  • # report generation).
  • aiConversation: [AiConversationItem!]
  • # Free-text description shown alongside the report.
  • description: String
  • # Name of the entity and its default text representation.
  • name: String!
  • # Id of the owning user.
  • ownerId: ID!
  • # Id of the parent report folder.
  • reportsFolderId: ID!
  • settings: ReportSettings!
  • # Field whose values are strictly defined with an enumeration of values.
  • shareMode: ShareModeEnum
  • # Bit flags fine-tuning sharing behavior (e.g. allow editing for shared users).
  • shareModeParams: Int
  • # When true, name and settings are kept in sync with the linked screen profile;
  • # when false, the report is detached from profile sync.
  • syncEnabled: Boolean
  • # Id of the synchronized record.
  • syncEntityId: ID
  • # Field whose values are strictly defined with an enumeration of values.
  • type: ReportTypeEnum!
  • # Revision when entity was lastly changed.
  • revision: Int
  • schedule: ReportScheduleEntity
  • # True when the current user has marked this report as a favorite (see
  • # ClientFavorite).
  • isFavorite: Boolean!
  • # Sales units granted shared access to this report (custom share mode).
  • #
  • # Arguments
  • # filter: Filter SalesUnit relations by target SalesUnit
  • # attributes.
  • # filterEdge: Filter ReportSharingSalesUnitRelation relations by
  • # edge (relation) ReportSharingSalesUnitRelation attributes.
  • # orderBy: Order SalesUnit relations by target SalesUnit
  • # attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • sharingUnits(
  • filter: SalesUnitFilterInput,
  • filterEdge: ReportSharingSalesUnitRelationFilterInput,
  • orderBy: [SalesUnitOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ReportSharingSalesUnitRelationEntityConnection
  • # Users granted shared access to this report (custom share mode).
  • #
  • # Arguments
  • # filter: Filter Client relations by target Client attributes.
  • # filterEdge: Filter ReportSharingClientRelation relations by
  • # edge (relation) ReportSharingClientRelation attributes.
  • # orderBy: Order Client relations by target Client attributes.
  • # includeDeleted: Returns deleted target records as well. Default
  • # is true.
  • # before: Cursor until which to take entities to result set.
  • # after: Cursor after which to start taking entities to result
  • # set.
  • # first: Number of entities to return from beginning of the
  • # result set.
  • # last: Return only the "last" number of entities from result
  • # set.
  • sharingClients(
  • filter: ClientFilterInput,
  • filterEdge: ReportSharingClientRelationFilterInput,
  • orderBy: [ClientOrderByInput!],
  • includeDeleted: Boolean,
  • before: String,
  • after: String,
  • first: Int,
  • last: Int
  • ): ReportSharingClientRelationEntityConnection
  • # Checks which permissions current user has on concrete entity instance.
  • #
  • # Arguments
  • # permissions: [Not documented]
  • instancePermissions(permissions: [EntityPermsEnum!]!): [EntityPermsEnum!]!
  • }