INTERFACE

CanHaveLabels

A content item that can have labels.
Available in Tableau Cloud March 2023 / Server 2023.1 and later.

link GraphQL Schema definition

  • interface CanHaveLabels {
  • # Unique identifier used by the metadata API. Not the same as the numeric ID used
  • # on server
  • id: ID!
  • # The name of the asset
  • name: String
  • # Locally unique identifier used for the REST API on the Tableau Server
  • luid: String!
  • # The labels on a content item. Available in Tableau Cloud March 2023 / Server
  • # 2023.1 and later.
  • #
  • # Arguments
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • labels(
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): [Label!]!
  • # The labels on a content item. Available in Tableau Cloud March 2023 / Server
  • # 2023.1 and later.
  • #
  • # Arguments
  • # after: The cursor to receive the next page of objects. If no
  • # cursor is supplied it will start at the beginning of the list. Offset can not be
  • # set at the same time. This is the preferred API to use if possible as it is
  • # faster.
  • # first: Maximum number of objects to be returned in a page. The
  • # default is 100
  • # offset: The number of entries to offset the start of the page
  • # by. If no offset is supplied it will start at the beginning of the list. After
  • # can not be set at the same time.
  • # filter: Filter by GraphQL field and given value
  • # orderBy: Sort by given fields. The sort orders defined first in
  • # the list will take priority. If there are no given sort orders or a tie on the
  • # final sorted field then the resulting set will be sorted by ID in ascending
  • # order.
  • # permissionMode: Results filtering mode.
  • labelsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: Label_Filter,
  • orderBy: LabelSortOrder,
  • permissionMode: PermissionMode
  • ): LabelsConnection
  • }