OBJECT
Sheet

A sheet contained in a published workbook.
GraphQL Schema definition

type Sheet implements View, Taggable {
#   Unique identifier used by the metadata API.  Not the same as the numeric ID used 
#   on server
id: ID! 
#   Name shown in server and desktop clients
name: String 
#   Unique ID for the sheet generated for and stored within the workbook, survives 
#   renames, and is used for internal processes
documentViewId: String 
#   Locally unique identifier used for the REST API on the Tableau Server (Blank if 
#   worksheet is hidden in Workbook)
luid: String! 
#   Server path to sheet
path: String 
#   Time the sheet was created
createdAt: DateTime! 
#   Time the sheet was updated
updatedAt: DateTime! 
#   Index of view; the order it appears in the workbook
index: Int 
#   Tags associated with the view
# 
# 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.
tags(filter: Tag_Filter, orderBy: TagSortOrder): [Tag!]! 
#   Tags associated with the view
# 
# 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.
tagsConnection(
after: String,
first: Int,
offset: Int,
filter: Tag_Filter,
orderBy: TagSortOrder
): TagsConnection 
#   Calculated fields which were created on this sheet, e.g. in the rows or columns 
#   shelves and which may not be used on other sheets that use this embedded data 
#   source
# 
# 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.
worksheetFields(
filter: CalculatedField_Filter,
orderBy: CalculatedFieldSortOrder,
permissionMode: PermissionMode
): [CalculatedField] 
#   Calculated fields which were created on this sheet, e.g. in the rows or columns 
#   shelves and which may not be used on other sheets that use this embedded data 
#   source
# 
# 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.
worksheetFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: CalculatedField_Filter,
orderBy: CalculatedFieldSortOrder,
permissionMode: PermissionMode
): CalculatedFieldsConnection 
#   Fields that are contained in an embedded data source and are also referenced by 
#   the worksheet. If a worksheet uses calculated fields (or any other 
#   FieldReferencingField), this list will also include all of the referenced 
#   fields.
# 
# 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.
datasourceFields(
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): [Field] 
#   Fields that are contained in an embedded data source and are also referenced by 
#   the worksheet. If a worksheet uses calculated fields (or any other 
#   FieldReferencingField), this list will also include all of the referenced 
#   fields.
# 
# 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.
datasourceFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): FieldsConnection 
#   All fields in the collection worksheetFields as well as the fields in 
#   datasourceFields used directly by this sheet. If the worksheet uses calculated 
#   fields this list will not include referenced fields that are not directly used 
#   by the sheet.
# 
# 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.
sheetFieldInstances(
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): [Field] 
#   All fields in the collection worksheetFields as well as the fields in 
#   datasourceFields used directly by this sheet. If the worksheet uses calculated 
#   fields this list will not include referenced fields that are not directly used 
#   by the sheet.
# 
# 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.
sheetFieldInstancesConnection(
after: String,
first: Int,
offset: Int,
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): FieldsConnection 
#   Data quality warnings upstream from this sheet
# 
# 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.
upstreamDataQualityWarnings(
filter: DataQualityWarning_Filter,
orderBy: DataQualityWarningSortOrder,
permissionMode: PermissionMode
): [DataQualityWarning!]! 
#   Data quality warnings upstream from this sheet
# 
# 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.
upstreamDataQualityWarningsConnection(
after: String,
first: Int,
offset: Int,
filter: DataQualityWarning_Filter,
orderBy: DataQualityWarningSortOrder,
permissionMode: PermissionMode
): DataQualityWarningsConnection 
#   Labels upstream from this sheet. 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.
upstreamLabels(
filter: Label_Filter,
orderBy: LabelSortOrder,
permissionMode: PermissionMode
): [Label!]! 
#   Labels upstream from this sheet. 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.
upstreamLabelsConnection(
after: String,
first: Int,
offset: Int,
filter: Label_Filter,
orderBy: LabelSortOrder,
permissionMode: PermissionMode
): LabelsConnection 
#   Parent embedded data source of this sheet
# 
# 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.
parentEmbeddedDatasources(
filter: EmbeddedDatasource_Filter,
orderBy: EmbeddedDatasourceSortOrder,
permissionMode: PermissionMode
): [EmbeddedDatasource!]! 
#   Parent embedded data source of this sheet
# 
# 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.
parentEmbeddedDatasourcesConnection(
after: String,
first: Int,
offset: Int,
filter: EmbeddedDatasource_Filter,
orderBy: EmbeddedDatasourceSortOrder,
permissionMode: PermissionMode
): EmbeddedDatasourcesConnection 
#   The workbook that contains this view
workbook: Workbook 
#   Dashboards that contain this sheet
# 
# 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.
containedInDashboards(
filter: Dashboard_Filter,
orderBy: DashboardSortOrder,
permissionMode: PermissionMode
): [Dashboard] 
#   Dashboards that contain this sheet
# 
# 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.
containedInDashboardsConnection(
after: String,
first: Int,
offset: Int,
filter: Dashboard_Filter,
orderBy: DashboardSortOrder,
permissionMode: PermissionMode
): DashboardsConnection 
#   The Metrics that reference this View
# 
# 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.
referencedByMetrics(
filter: Metric_Filter,
orderBy: MetricSortOrder,
permissionMode: PermissionMode
): [Metric] 
#   The Metrics that reference this View
# 
# 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.
referencedByMetricsConnection(
after: String,
first: Int,
offset: Int,
filter: Metric_Filter,
orderBy: MetricSortOrder,
permissionMode: PermissionMode
): MetricsConnection 
#   The databases that are upstream of this sheet
# 
# 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.
upstreamDatabases(
filter: Database_Filter,
orderBy: DatabaseSortOrder,
permissionMode: PermissionMode
): [Database] 
#   The databases that are upstream of this sheet
# 
# 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.
upstreamDatabasesConnection(
after: String,
first: Int,
offset: Int,
filter: Database_Filter,
orderBy: DatabaseSortOrder,
permissionMode: PermissionMode
): DatabasesConnection 
#   The data sources that are upstream of this sheet
# 
# 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.
upstreamDatasources(
filter: Datasource_Filter,
orderBy: DatasourceSortOrder,
permissionMode: PermissionMode
): [Datasource] 
#   The data sources that are upstream of this sheet
# 
# 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.
upstreamDatasourcesConnection(
after: String,
first: Int,
offset: Int,
filter: Datasource_Filter,
orderBy: DatasourceSortOrder,
permissionMode: PermissionMode
): DatasourcesConnection 
#   The tables that are upstream of this sheet
# 
# 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.
upstreamTables(
filter: Table_Filter,
orderBy: TableSortOrder,
permissionMode: PermissionMode
): [Table] 
#   The tables that are upstream of this sheet
# 
# 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.
upstreamTablesConnection(
after: String,
first: Int,
offset: Int,
filter: Table_Filter,
orderBy: TableSortOrder,
permissionMode: PermissionMode
): TablesConnection 
#   The fields that are upstream of this sheet
# 
# 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.
upstreamFields(
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): [Field]! 
#   The fields that are upstream of this sheet
# 
# 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.
upstreamFieldsConnection(
after: String,
first: Int,
offset: Int,
filter: Field_Filter,
orderBy: FieldSortOrder,
permissionMode: PermissionMode
): FieldsConnection 
#   The flows that are upstream of this sheet
# 
# 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.
upstreamFlows(
filter: Flow_Filter,
orderBy: FlowSortOrder,
permissionMode: PermissionMode
): [Flow] 
#   The flows that are upstream of this sheet
# 
# 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.
upstreamFlowsConnection(
after: String,
first: Int,
offset: Int,
filter: Flow_Filter,
orderBy: FlowSortOrder,
permissionMode: PermissionMode
): FlowsConnection 
#   The columns that are upstream of this sheet
# 
# 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.
upstreamColumns(
filter: Column_Filter,
orderBy: ColumnSortOrder,
permissionMode: PermissionMode
): [Column]! 
#   The columns that are upstream of this sheet
# 
# 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.
upstreamColumnsConnection(
after: String,
first: Int,
offset: Int,
filter: Column_Filter,
orderBy: ColumnSortOrder,
permissionMode: PermissionMode
): ColumnsConnection 
}
Sheet

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
