Logo of FrontifyDeveloper portalArrow to the right
GraphQL reference
Object type

Catalog

No description
Implemented interfaces

An Interface is an abstract type that includes a certain set of fields that a type must include to implement the interface.

NodeInterface is the base for all types.

Type fields
id:ID!
Beta

Catalog id.

name:String!
Beta

name of the Catalog.

createdAt:DateTime!
Beta

DateTime of the Catalog creation.

updatedAt:DateTime
Beta

DateTime of the Catalog last update.

rows(
Beta
limit: Int = 25
page: Int = 1

rows of the Catalog.

columns(
Beta
limit: Int = 100
page: Int = 1

columns of the Catalog.

window(
Beta
columns: CatalogWindowPaginationInput! = {limit: 10, page: 1}
rows: CatalogWindowPaginationInput! = {limit: 25, page: 1}

A rectangular page of catalog data whose cells correspond to the selected columns. One catalog window can contain at most 2,500 cell coordinates.

primaryColumn:CatalogColumn
Beta

Primary CatalogColumn of the Catalog.

cellsByPrimaryKey(
Beta
primaryKey: String!
columnIds: [ID!]!

Fetch cells for a row identified by its primary key value.

columnFilter(
Beta
columnId: ID!
activeFilters: [ColumnFilterInput!]
query: String
columnQuery: String
limit: Int = 100
page: Int = 1

Get a paginated page of filter values (with counts) for one column. Returns null when the column does not belong to the catalog. Items are ordered by count DESC, value ASC.

usageReasons:[CatalogUsageReason!]!
Beta

Why this Catalog is currently in use, as reason codes. Empty when it is not in use.

searchCells(
Beta
query: String!
columnFilters: [ColumnFilterInput!]
columnIds: [ID!]!

Search catalog cells by query and column filters. Query is split by whitespace; each part must match (case-insensitive) in at least one cell per row. Column filters match entire cell values; multiple values for the same column are OR'd, cross-column is AND'd. Results limited to 100 rows.