OBJECT

Parameter

link GraphQL Schema definition

  • type Parameter {
  • # Unique identifier used by the metadata API. Not the same as the numeric ID used
  • # on server
  • id: ID!
  • # Name of parameter
  • name: String
  • # Name of the parameter's parent
  • parentName: String
  • # Published data source that contains this parameter
  • datasource: PublishedDatasource
  • # The bin field that references this parameter
  • #
  • # 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.
  • referencedByBins(
  • filter: BinField_Filter,
  • orderBy: BinFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [BinField]
  • # The bin field that references this parameter
  • #
  • # 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.
  • referencedByBinsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: BinField_Filter,
  • orderBy: BinFieldSortOrder,
  • permissionMode: PermissionMode
  • ): BinFieldsConnection
  • # The calculated field that references this parameter
  • #
  • # 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.
  • referencedByCalculations(
  • filter: CalculatedField_Filter,
  • orderBy: CalculatedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [CalculatedField]
  • # The calculated field that references this parameter
  • #
  • # 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.
  • referencedByCalculationsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: CalculatedField_Filter,
  • orderBy: CalculatedFieldSortOrder,
  • permissionMode: PermissionMode
  • ): CalculatedFieldsConnection
  • # The set field that this parameter references
  • #
  • # 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.
  • referencedBySets(
  • filter: SetField_Filter,
  • orderBy: SetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): [SetField]
  • # The set field that this parameter references
  • #
  • # 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.
  • referencedBySetsConnection(
  • after: String,
  • first: Int,
  • offset: Int,
  • filter: SetField_Filter,
  • orderBy: SetFieldSortOrder,
  • permissionMode: PermissionMode
  • ): SetFieldsConnection
  • # Workbook that contains this parameter
  • workbook: Workbook
  • }