GraphQL GraphQL OBJECT

BiBookmark

Preconfigured or created Bookmark in the Business Intelligence (BI). Bookmarks are used to quickly access customized or commonly-used reports.

link Definition

  • type BiBookmark {
  • # Name of the bookmark.
  • appellation: String! @deprecated( reason: "Obsolete field, please use field 'name' instead." )
  • # Name of the bookmark.
  • name: String!
  • # ID that corresponds to the position of the bookmark in a folder.
  • position: Long!
  • # Unique ID of a bookmark or folder (personal or account), or the ID of a default
  • # bookmark.
  • id: Long!
  • # ID of the folder where the bookmark is located.
  • parentId: Int
  • # Type of bookmark. Possible values are Default, Personal, and Account.
  • bookmarkType: BookmarkType
  • # Any tags associated with a bookmark. These can be set up using the
  • # updateBIBookmark mutation object.
  • tags: [String]
  • # Bookmark is tree folder when true, executable report bookmark otherwise.
  • isFolder: Boolean
  • # Report that is bookmarked in the BI.
  • #
  • # Arguments
  • # absoluteDateTimeFilter: Adaptation of the timeframe.
  • biReport(absoluteDateTimeFilter: AbsoluteDateTimeFilter): BiReport
  • # Client accounts that are linked to the bookmark.
  • relatedClients: [Client]
  • }