All properties on a Content Type is generated as a field on the GraphQL type. See the Property Editors page for which types the editors are returning.
If a property is marked as Allow varying by culture, a culture argument is added to that field. The argument is optional and will fallback to the parent fields culture or the default culture if none is specified.
The Query type is the entry to the GraphQL API. By default it contains two fields, one to get a single Content item by ID or url and one to get all Content.
typeQuery {""" Get Content by its unique identifier or url. Either id or url must be specified but not both. """ content(""" The unique identifier of the content. """ id: ID,""" The url of the content. """ url: String,""" The culture to fetch the content in. If empty the default culture will be used. """ culture: String""" Specifies if draft content should be returned. Requires the request to be authenticated. """ preview: Boolean ): Content""" Get all Content. """ allContent(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String,""" The culture to fetch the value in. If empty the default culture will be used. """ culture: String,""" Specifies if draft content should be returned. Requires the request to be authenticated. """ preview: Boolean""" Filter the returned data. """ where: ContentFilterInput,""" Sort the returned data. """ orderBy: [ContentOrderByInput] ): ContentConnection!}
For each Document Type that is not used as a Composition or marked as an Element Type, two fields will be generated on the Query type. One for getting a single Content item by either it's ID or url and a field for getting all Content of that specific type.
typeBlockGridArea {""" Name of the area. """ alias: String!""" Items in the area. """ items: [BlockGridItem]!""" Number of rows spanned by the area. """ rowSpan: Int!""" Number of columns spanned by the area. """ columnSpan: Int!}
Query
{ contentPage { blocks { items {areas: { alias columnSpan items { title } } } } }}
typeBlockGridItem {""" The content. """ content: Element!""" The settings. """ settings: Element""" Number of rows spanned by the item. """ rowSpan: Int!""" Number of columns spanned by the item. """ columSpan: Int!""" Number of columns in child areas. """ areaGridColumns: Int!""" Number of columns in child areas. """ areas: [BlockGridArea]}
# Represents a range of decimals.typeDecimalRange {""" Maximum value of the range. """ maximum: Decimal!""" Minimum value of the range. """ minimum: Decimal!}
typeImageCropper {""" The predefined crops. """ crops: [ImageCropperCrop]!""" The image url with crop parameters. """ cropUrl(""" The crop alias. """ alias: String""" Change background color of the image. """ backgroundColor: String""" The width of the output image. """ width: Int""" The height of the output image. """ height: Int""" Quality percentage of the output image. """ quality: Int""" The image crop mode. """ cropMode: ImageCropMode""" The image crop anchor. """ cropAnchor: ImageCropAnchor""" Use a dimension as a ratio. """ ratioMode: ImageCropRatioMode""" The format of the output image. """ format: ImageCropFormat""" Use focal point to generate an output image using the focal point instead of the predefined crop if there is one. """ preferFocalPoint: Boolean = false""" If the image should be upscaled to requested dimensions. """ upscale: Boolean = false ): String""" The focal point position. """ focalPoint: ImageCropperFocalPoint!""" The focal point url template. """ focalPointUrlTemplate: String!""" The image url. """ url: String!}
enumImageCropAnchor {""" Anchors the position of the image to the bottom of it's bounding container. """ BOTTOM""" Anchors the position of the image to the bottom left side of it's bounding container. """ BOTTOM_LEFT""" Anchors the position of the image to the bottom right side of it's bounding container. """ BOTTOM_RIGHT""" Anchors the position of the image to the center of it's bounding container. """ CENTER""" Anchors the position of the image to the left of it's bounding container. """ LEFT""" Anchors the position of the image to the right of it's bounding container. """ RIGHT""" Anchors the position of the image to the top of it's bounding container. """ TOP""" Anchors the position of the image to the top left side of it's bounding container. """ TOP_LEFT""" Anchors the position of the image to the top right side of it's bounding container. """ TOP_RIGHT}
enumImageCropMode {""" When upscaling an image the image pixels themselves are not resized, rather the image is padded to fit the given dimensions. """ BOX_PAD""" Resizes the image to the given dimensions. If the set dimensions do not match the aspect ratio of the original image then the output is cropped to match the new aspect ratio. """ CROP""" Resizes the image to the given dimensions. If the set dimensions do not match the aspect ratio of the original image then the output is resized to the maximum possible value in each direction while maintaining the original aspect ratio. """ MAX""" Resizes the image until the shortest side reaches the set given dimension. This will maintain the aspect ratio of the original image. Upscaling is disabled in this mode and the original image will be returned if attempted. """ MIN""" Passing a single dimension will automatically preserve the aspect ratio of the original image. If the requested aspect ratio is different then the image will be padded to fit. """ PAD""" Resizes the image to the given dimensions. If the set dimensions do not match the aspect ratio of the original image then the output is stretched to match the new aspect ratio. """ STRETCH}
"""The `JSON` scalar type represents JSON values as specified by [ECMA-404](http://www.ecma-international.org/publications/files/ECMA-ST/ECMA-404.pdf)."""scalar JSON
typeLink {""" The name of the Link. """ name: String!""" The link target. """ target: String""" The link type. """ type: LintType!""" The link udi if type is CONTENT or MEDIA. """ udi: String""" The url. """ url: String!}
typeMediaWithCrops {""" The predefined crops. """ crops: [ImageCropperCrop]!""" The image url with crop parameters. """ cropUrl(""" The crop alias. """ alias: String""" Change background color of the image. """ backgroundColor: String""" The width of the output image. """ width: Int""" The height of the output image. """ height: Int""" Quality percentage of the output image. """ quality: Int""" The image crop mode. """ cropMode: ImageCropMode""" The image crop anchor. """ cropAnchor: ImageCropAnchor""" Use a dimension as a ratio. """ ratioMode: ImageCropRatioMode""" The format of the output image. """ format: ImageCropFormat""" Use focal point to generate an output image using the focal point instead of the predefined crop if there is one. """ preferFocalPoint: Boolean = false""" If the image should be upscaled to requested dimensions. """ upscale: Boolean = false ): String""" The focal point position. """ focalPoint: ImageCropperFocalPoint!""" The focal point url template. """ focalPointUrlTemplate: String!""" The media """ media: Media!""" The image url. """ url: String!}
"""Information about pagination in a connection."""typePageInfo {""" When paginating forwards, the cursor to continue. """ endCursor: String""" When paginating forwards, are there more items? """ hasNextPage: Boolean!""" When paginating backwards, are there more items? """ hasPreviousPage: Boolean!""" When paginating backwards, the cursor to continue. """ startCursor: String}
interfaceContent {""" The ancestors. """ ancestors(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String""" Filter the returned data. """ where: ContentFilterInput,""" Sort the returned data. """ orderBy: [ContentOrderByInput], ): ContentConnection!""" The children. """ children(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String""" Filter the returned data. """ where: ContentFilterInput,""" Sort the returned data. """ orderBy: [ContentOrderByInput], ): ContentConnection!""" The Content Type alias. """ contentTypeAlias: String!""" The create date. """ createDate: DateTime!""" The descendants. """ descendants(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String""" Filter the returned data. """ where: ContentFilterInput,""" Sort the returned data. """ orderBy: [ContentOrderByInput], ): ContentConnection!""" The unique identifier. """ id: ID!""" The level. """ level: Int!""" The name. """ name(""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String ): String""" The parent Content, can be null if content is at root. """ parent(""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String ): Content""" The sort order. """ sortOrder: Int!""" The update date. """ updateDate(""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String ): DateTime""" The url. """ url(""" The culture to fetch the value in. If empty the contents culture will be used. """ culture: String ): String}
Content Connection
"""A connection from an object to a list of objects of type `Content`."""typeContentConnection {""" A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for \"{ edges { node } }\" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the \"cursor\" field on the edge to enable efficient pagination, this shortcut cannot be used, "and the full \"{ edges { node } } \" version should be used instead. """ items: [Content]!""" A list of edges. """ edges: [ContentEdge]!""" Information to aid in pagination. """ pageInfo: PageInfo!}
Content Edge
"""An edge in a connection from an object to another object of type `Content`"""typeContentEdge {""" A cursor for use in pagination. """ cursor: String!""" The item at the end of the edge. """ node: Content}
Media
interfaceMedia {""" The ancestors. """ ancestors(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String ): MediaConnection!""" The children. """ children(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String ): MediaConnection!""" The create date. """ createDate: DateTime!""" The descendants. """ descendants(""" Specifies the number of edges to return starting from `after` or the first entry if `after` is not specified. """ first: Int,""" Only look at connected edges with cursors greater than the value of `after`. """ after: String,""" Specifies the number of edges to return counting reversely from `before`, or the last entry if `before` is not specified. """ last: Int,""" Only look at connected edges with cursors smaller than the value of `before`. """ before: String ): MediaConnection!""" The unique identifier. """ id: ID!""" The level. """ level: Int!""" The Media Type alias """ mediaTypeAlias: String!""" The name. """ name: String!""" The parent Content, can be null if content is at root. """ parent: Media""" The sort order. """ sortOrder: Int!""" The update date. """ updateDate: DateTime""" The url. """ url(""" Change the background color of the image. """ backgroundColor: String,""" The width of the output image. """ width: Int,""" The height of the output image. """ height: Int,""" Quality percentage of the output image. """ quality: Int,""" The image crop mode. """ cropMode: ImageCropMode,""" The image crop anchor. """ cropAnchor: ImageCropAnchor,""" Use a dimension as a ratio. """ ratioMode: ImageCropRatioMode,""" If the image should be upscaled to requested dimensions. """ upscale: Boolean = false,""" Change the format of the output image. """ format: ImageCropFormat ): String}
Media Connection
"""A connection from an object to a list of objects of type `Media`."""typeMediaConnection {""" A list of all of the objects returned in the connection. This is a convenience field provided for quickly exploring the API; rather than querying for \"{ edges { node } }\" when no edge data is needed, this field can be used instead. Note that when clients like Relay need to fetch the \"cursor\" field on the edge to enable efficient pagination, this shortcut cannot be used, "and the full \"{ edges { node } } \" version should be used instead. """ items: [Media]!""" A list of edges. """ edges: [MediaEdge]!""" Information to aid in pagination. """ pageInfo: PageInfo!}
Media Edge
"""An edge in a connection from an object to another object of type `Media`"""typeMediaEdge {""" A cursor for use in pagination. """ cursor: String!""" The item at the end of the edge. """ node: Media}
Filtering
For all Document Types a FilterInput type is generated. The name is the type name postfixed by FilterInput e.g. given a type named Product the name will be ProductFilterInput.
Default Filter Fields
To filter the allContent field, ancestors, children and descendants connections the ContentFilterInput is used.
All filter inputs for Content Types will also have the default fields.
"""A filter input for the type `Content`."""inputContentFilterInput {""" All of the filters must match. """ AND: [ContentFilterInput]""" Some of the filters must match. """ OR: [ContentFilterInput]""" None of the filters must match. """ NOT: [ContentFilterInput]""" Field must equal value. """ contentTypeAlias: String""" Field must match any of the values. """ contentTypeAlias_any: [String]""" Field must start with the value. """ contentTypeAlias_starts_with: String""" Field must end with the value. """ contentTypeAlias_ends_with: String""" Field must contain the value. """ contentTypeAlias_contains: String""" Field must equal value. """ createDate: DateTime""" Field must be greater than the value. """ createDate_gt: DateTime""" Field must be greater than or equal the value. """ createDate_gte: DateTime""" Field must be less than the value. """ createDate_lt: DateTime""" Field must be less than or equal the value. """ createDate_lte: DateTime""" Field must equal value. """ id: ID""" Field must match any of the values. """ id_any: [ID]""" Field must equal value. """ level: Int""" Field must be greater than the value. """ level_gt: Int""" Field must be greater than or equal the value. """ level_gte: Int""" Field must be less than the value. """ level_lt: Int""" Field must be less than or equal the value. """ level_lte: Int""" Field must match any of the values. """ level_any: [Int]""" Field must equal value. """ name: String""" Field must match any of the values. """ name_any: [String]""" Field must start with the value. """ name_starts_with: String""" Field must end with the value. """ name_ends_with: String""" Field must contain the value. """ name_contains: String""" Field must equal value. """ sortOrder: Int""" Field must be greater than the value. """ sortOrder_gt: Int""" Field must be greater than or equal the value. """ sortOrder_gte: Int""" Field must be less than the value. """ sortOrder_lt: Int""" Field must be less than or equal the value. """ sortOrder_lte: Int""" Field must match any of the values. """ sortOrder_any: [Int]""" Field must equal value. """ updateDate: DateTime""" Field must be greater than the value. """ updateDate_gt: DateTime""" Field must be greater than or equal the value. """ updateDate_gte: DateTime""" Field must be less than the value. """ updateDate_lt: DateTime""" Field must be less than or equal the value. """ updateDate_lte: DateTime}
Filtering is possible only on non-complex Property Editors like Text Area and Label. Filtering on more complex types like Content Picker and Multi-node Tree Picker has to be done client-side.
Strings
For fields returning String the following filter fields are generated.
Given the following type:
ProductimplementsContent {...sku: String...}
The following type will be generated, incl. the fields from the ContentFilterInput.
"""A filter input for the type `Product`."""inputProductFilterInput {""" All of the filters must match. """ AND: [ProductFilterInput]""" Some of the filters must match. """ OR: [ProductFilterInput]""" None of the filters must match. """ NOT: [ProductFilterInput]...""" Field must equal value. """ sku: String""" Field must match any of the values. """ sku_any: [String]""" Field must start with the value. """ sku_starts_with: String""" Field must end with the value. """ sku_ends_with: String""" Field must contain the value. """ sku_contains: String...}
Ints
For fields returning Int or Decimal the following filters are generated.
The type is either Int or Decimal depending on the output type.
Given the following type:
ProductimplementsContent {...price: Decimal...}
The following type will be generated, incl. the fields from the ContentFilterInput.
"""A filter input for the type `Product`."""inputProductFilterInput {""" All of the filters must match. """ AND: [ProductFilterInput]""" Some of the filters must match. """ OR: [ProductFilterInput]""" None of the filters must match. """ NOT: [ProductFilterInput]...""" Field must equal value. """ price: Decimal""" Field must be greater than the value. """ price_gt: Decimal""" Field must be greater than or equal to the value. """ price_gte: Decimal""" Field must be less than the value. """ price_lt: Decimal""" Field must be less than or equal to the value. """ price_lte: Decimal""" Field must match any of the values. """ price_any: [Decimal]...}
Boolean
For types returning Boolean the following filters are generated.
The following type will be generated, incl. the fields from the ContentFilterInput.
"""A filter input for the type `Product`."""inputProductFilterInput {""" All of the filters must match. """ AND: [ProductFilterInput]""" Some of the filters must match. """ OR: [ProductFilterInput]""" None of the filters must match. """ NOT: [ProductFilterInput].... # Field must equal value. purchase: Boolean...}
The following type will be generated, incl. the fields from the ContentFilterInput.
"""A filter input for the type `Product`."""inputProductFilterInput {""" All of the filters must match. """ AND: [ProductFilterInput]""" Some of the filters must match. """ OR: [ProductFilterInput]""" None of the filters must match. """ NOT: [ProductFilterInput]...""" Field must equal value. """ availableDate: DateTime""" Field must be greater than the value. """ availableDate_gt: DateTime""" Field must be greater than or equal to the value. """ availableDate_gte: DateTime""" Field must be less than the value. """ availableDate_lt: DateTime""" Field must be less than or equal to the value. """ availableDate_lte: DateTime...}
Media
For types returning Media the MediaFilterInput is used.
"""A filter input for the type `Media`."""inputMediaFilterInput {""" All of the filters must match. """ AND: [MediaFilterInput]""" Some of the filters must match. """ OR: [MediaFilterInput]""" None of the filters must match. """ NOT: [MediaFilterInput]""" Field must equal value. """ mediaTypeAlias: String""" Field must match any of the values. """ mediaTypeAlias_any: [String]""" Field must start with the value. """ mediaTypeAlias_starts_with: String""" Field must end with the value. """ mediaTypeAlias_ends_with: String""" Field must contain the value. """ mediaTypeAlias_contains: String""" Field must equal value. """ createDate: DateTime""" Field must be greater than the value. """ createDate_gt: DateTime""" Field must be greater than or equal the value. """ createDate_gte: DateTime""" Field must be less than the value. """ createDate_lt: DateTime""" Field must be less than or equal the value. """ createDate_lte: DateTime""" Field must equal value. """ id: ID""" Field must match any of the values. """ id_any: [ID]""" Field must equal value. """ level: Int""" Field must be greater than the value. """ level_gt: Int""" Field must be greater than or equal the value. """ level_gte: Int""" Field must be less than the value. """ level_lt: Int""" Field must be less than or equal the value. """ level_lte: Int""" Field must match any of the values. """ level_any: [Int]""" Field must equal value. """ name: String""" Field must match any of the values. """ name_any: [String]""" Field must start with the value. """ name_starts_with: String""" Field must end with the value. """ name_ends_with: String""" Field must contain the value. """ name_contains: String""" Field must equal value. """ sortOrder: Int""" Field must be greater than the value. """ sortOrder_gt: Int""" Field must be greater than or equal the value. """ sortOrder_gte: Int""" Field must be less than the value. """ sortOrder_lt: Int""" Field must be less than or equal the value. """ sortOrder_lte: Int""" Field must match any of the values. """ sortOrder_any: [Int]""" Field must equal value. """ updateDate: DateTime""" Field must be greater than the value. """ updateDate_gt: DateTime""" Field must be greater than or equal the value. """ updateDate_gte: DateTime""" Field must be less than the value. """ updateDate_lt: DateTime""" Field must be less than or equal the value. """ updateDate_lte: DateTime}
Lists
For types returning [Decimal], [Int] or [String] the following filters are generated.
The type is [Decimal], [Int] or [String] depending on the output type
Given the following type:
ProductimplementsContent {...tags: [String]...}
The following type will be generated, incl. the fields from the ContentFilterInput.
# A filter input for the type `Product`.inputProductFilterInput {""" All of the filters must match. """ AND: [ProductFilterInput]""" Some of the filters must match. """ OR: [ProductFilterInput]""" None of the filters must match. """ NOT: [ProductFilterInput]...""" Field must match all of the values. """ tags_all: [String]""" Field must match any of the values. """ tags_some: [String]...}
Ordering
The result can be ordered by specifying a value for the orderBy argument.
An OrderBy type is generated for all Document Types. The name is the type name postfixed by OrderByInput e.g. given a type named Product the name will be ProductOrderByInput.
Fields returning DateTime, Decimal, Boolean, Int or String can be used to order by.
Default OrderBy Fields
To filter the allContent field, ancestors, children and descendants connections the ContentOrderBy is used.
All order by inputs for Content Types will also have the default fields.
``"""An order input for the type `Content`."""enumContentOrderByInput {""" Order by `contentTypeAlias` in ascending order. """ contentTypeAlias_ASC""" Order by `contentTypeAlias` in descending order. """ contentTypeAlias_DESC""" Order by `createDate` in ascending order. """ createDate_ASC""" Order by `createDate` in descending order. """ createDate_DESC""" Order by `level` in ascending order. """ level_ASC""" Order by `level` in descending order. """ level_DESC""" Order by `name` in ascending order. """ name_ASC""" Order by `name` in descending order. """ name_DESC""" Order by `path` in ascending order. """ path_ASC""" Order by `path` in descending order. """ path_DESC""" Order by `sortOrder` in ascending order. """ sortOrder_ASC""" Order by `sortOrder` in descending order. """ sortOrder_DESC""" Order by `updateDate` in ascending order. """ updateDate_ASC""" Order by `updateDate` in descending order. """ updateDate_DESC}`### Custom OrderBy FieldsGiventhefollowingtype:```graphqlProductimplementsContent {...price: Decimalsku: String...}
The following type will be generated, incl. the fields from the ContentOrderByInput.
"""An order by input for the type `Product`."""enumProductOrderByInput {...""" Order by `price` in ascending order. """ price_ASC""" Order by `price` in descending order. """ price_DESC""" Order by `sku` in ascending order. """ sku_ASC # Order by `sku` in descending order. sku_DESC...}
Default ordering
If you don't specify any order the data returned will be ordered by the path they appear in, in the Umbraco Backoffice tree.
