Documentation AEM as a Cloud Service User Guide

Learning to use GraphQL with AEM - Sample Content and Queries learn-graphql-with-aem-sample-content-queries

Last update: Mon Dec 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Topics:
Content Fragments,GraphQL API

Learn to use GraphQL with AEM so you can serve content headlessly by exploring sample content and queries.

NOTE

Read this page along with the following:

To get started with GraphQL queries, and how they work with AEM Content Fragments, it helps to see some practical examples.

To help with this see:

A sample Content Fragment structure
And some sample GraphQL queries, based on the sample Content Fragment structure (Content Fragment Models and related Content Fragments).

GraphQL - Sample Queries using the Sample Content Fragment Structure graphql-sample-queries-sample-content-fragment-structure

See these sample queries for illustrations of create queries, together with sample results.

NOTE

Depending on your instance, you can directly access the GraphiQL interface included with AEM GraphQL API for submitting and testing queries.

You can access the query editor from either:

Tools > General > GraphQL Query Editor
directly; for example, http://localhost:4502/aem/graphiql.html

NOTE

The sample queries are based on the Sample Content Fragment Structure for use with GraphQL

Sample Query - All Available Schemas and Datatypes sample-all-schemes-datatypes

Returns all types for all available schemas.

Sample Query

{
  __schema {
    types {
      name
      description
    }
  }
}

Sample Result

{
  "data": {
    "__schema": {
      "types": [
        {
          "name": "AdventureModel",
          "description": null
        },
        {
          "name": "AdventureModelArrayFilter",
          "description": null
        },
        {
          "name": "AdventureModelFilter",
          "description": null
        },
        {
          "name": "AdventureModelResult",
          "description": null
        },
        {
          "name": "AdventureModelResults",
          "description": null
        },
        {
          "name": "AllFragmentModels",
          "description": null
        },
        {
          "name": "ArchiveRef",
          "description": null
        },
        {
          "name": "ArrayMode",
          "description": null
        },
        {
          "name": "ArticleModel",
          "description": null
        },

...more results...

        {
          "name": "__EnumValue",
          "description": null
        },
        {
          "name": "__Field",
          "description": null
        },
        {
          "name": "__InputValue",
          "description": null
        },
        {
          "name": "__Schema",
          "description": "A GraphQL Introspection defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, the entry points for query, mutation, and subscription operations."
        },
        {
          "name": "__Type",
          "description": null
        },
        {
          "name": "__TypeKind",
          "description": "An enum describing what kind of type a given __Type is"
        }
      ]
    }
  }
}

Sample Query - All Information about All Cities sample-all-information-all-cities

To retrieve all information about all cities, you can use the following basic query:
Sample Query

{
  cityList {
    items
  }
}

When run, the system automatically expands the query to include all fields:

{
  cityList {
    items {
      _path
      name
      country
      population
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "_path": "/content/dam/sample-content-fragments/cities/basel",
          "name": "Basel",
          "country": "Switzerland",
          "population": 172258
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/berlin",
          "name": "Berlin",
          "country": "Germany",
          "population": 3669491
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/bucharest",
          "name": "Bucharest",
          "country": "Romania",
          "population": 1821000
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/san-francisco",
          "name": "San Francisco",
          "country": "USA",
          "population": 883306
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/san-jose",
          "name": "San Jose",
          "country": "USA",
          "population": 1026350
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/stuttgart",
          "name": "Stuttgart",
          "country": "Germany",
          "population": 634830
        },
        {
          "_path": "/content/dam/sample-content-fragments/cities/zurich",
          "name": "Zurich",
          "country": "Switzerland",
          "population": 415367
        }
      ]
    }
  }
}

Sample Query - Names of All Cities sample-names-all-cities

A straightforward query to return the nameof all entries in the cityschema.

Sample Query

query {
  cityList {
    items {
      name
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Basel"
        },
        {
          "name": "Berlin"
        },
        {
          "name": "Bucharest"
        },
        {
          "name": "San Francisco"
        },
        {
          "name": "San Jose"
        },
        {
          "name": "Stuttgart"
        },
        {
          "name": "Zurich"
        }
      ]
    }
  }
}

Sample Query - A Single Specific City Fragment sample-single-specific-city-fragment

A query to return the details of a single fragment entry at a specific location in the repository.

Sample Query

{
  cityByPath (_path: "/content/dam/sample-content-fragments/cities/berlin") {
    item {
      _path
      name
      country
      population
     categories
    }
  }
}

Sample Results

{
  "data": {
    "cityByPath": {
      "item": {
        "_path": "/content/dam/sample-content-fragments/cities/berlin",
        "name": "Berlin",
        "country": "Germany",
        "population": 3669491,
        "categories": [
          "city:capital",
          "city:emea"
        ]
      }
    }
  }
}

Sample Query - All Cities with a Named Variation sample-cities-named-variation

If you create a variation, named “Berlin Centre” (berlin_centre), for the city Berlin, then you can use a query to return details of the variation.

Sample Query

{
  cityList (variation: "berlin_center") {
    items {
      _path
      name
      country
      population
      categories
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "_path": "/content/dam/sample-content-fragments/cities/berlin",
          "name": "Berlin",
          "country": "Germany",
          "population": 3669491,
          "categories": [
            "city:capital",
            "city:emea"
          ]
        }
      ]
    }
  }
}

Sample Query - Names of All Cities Tagged as City Breaks sample-names-all-cities-tagged-city-breaks

If you:

create various tags, named Tourism : Business, City Break, Holiday
and assign them to the Master variation of various City instances

Then you can use a query to return details of the name and tagsof all entries tagged as City Breaks in the cityschema.

Sample Query

query {
  cityList(
    includeVariations: true,
    filter: {_tags: {_expressions: [{value: "tourism:city-break", _operator: CONTAINS}]}}
  ){
    items {
      name,
      _tags
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Berlin",
          "_tags": [
            "tourism:city-break",
            "tourism:business"
          ]
        },
        {
          "name": "Zurich",
          "_tags": [
            "tourism:city-break",
            "tourism:business"
          ]
        }
      ]
    }
  }
}

Sample Query - Full Details of a Company’s CEO and Employees sample-full-details-company-ceos-employees

Using the structure of the nested fragments, this query returns the full details of a company’s CEO and all its employees.

Sample Query

query {
  companyList {
    items {
      name
      ceo {
        _path
        name
        firstName
        awards {
        id
          title
        }
      }
      employees {
       name
        firstName
       awards {
         id
          title
        }
      }
    }
  }
}

Sample Results

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "Apple Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
            "name": "Jobs",
            "firstName": "Steve",
            "awards": []
          },
          "employees": [
            {
              "name": "Marsh",
              "firstName": "Duke",
              "awards": []
            },
            {
              "name": "Caulfield",
              "firstName": "Max",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                }
              ]
            }
          ]
        },
        {
          "name": "Little Pony, Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/adam-smith",
            "name": "Smith",
            "firstName": "Adam",
            "awards": []
          },
          "employees": [
            {
              "name": "Croft",
              "firstName": "Lara",
              "awards": [
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            },
            {
              "name": "Slade",
              "firstName": "Cutter",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                },
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            }
          ]
        },
        {
          "name": "NextStep Inc.",
          "ceo": {
            "_path": "/content/dam/sample-content-fragments/persons/steve-jobs",
            "name": "Jobs",
            "firstName": "Steve",
            "awards": []
          },
          "employees": [
            {
              "name": "Smith",
              "firstName": "Joe",
              "awards": []
            },
            {
              "name": "Lincoln",
              "firstName": "Abraham",
              "awards": []
            }
          ]
        }
      ]
    }
  }
}

Sample Query - All Persons that have a name of “Jobs” or “Smith” sample-all-persons-jobs-smith

A query that filters all persons for any that have the name Jobsor Smith.

Sample Query

query {
  personList(filter: {
    name: {
      _logOp: OR
      _expressions: [
        {
          value: "Jobs"
        },
        {
          value: "Smith"
        }
      ]
    }
  }) {
    items {
      name
      firstName
    }
  }
}

Sample Results

{
  "data": {
    "personList": {
      "items": [
        {
          "name": "Smith",
          "firstName": "Adam"
        },
        {
          "name": "Smith",
          "firstName": "Joe"
        },
        {
          "name": "Jobs",
          "firstName": "Steve"
        }
      ]
    }
  }
}

Sample Query - All Persons that do not have a name of “Jobs” sample-all-persons-not-jobs

A query that filters all persons for any that have the name Jobsor Smith.

Sample Query

query {
  personList(filter: {
    name: {
      _expressions: [
        {
          value: "Jobs"
          _operator: EQUALS_NOT
        }
      ]
    }
  }) {
    items {
      name
      firstName
    }
  }
}

Sample Results

{
  "data": {
    "personList": {
      "items": [
        {
          "name": "Lincoln",
          "firstName": "Abraham"
        },
        {
          "name": "Smith",
          "firstName": "Adam"
        },
        {
          "name": "Slade",
          "firstName": "Cutter"
        },
        {
          "name": "Marsh",
          "firstName": "Duke"
        },
        {
          "name": "Smith",
          "firstName": "Joe"
        },
        {
          "name": "Croft",
          "firstName": "Lara"
        },
        {
          "name": "Caulfield",
          "firstName": "Max"
        }
      ]
    }
  }
}

Sample Query - All Adventures whose `_path` is starting with a specific prefix sample-wknd-all-adventures-cycling-path-filter

All adventures where _path starts with a specific prefix (/content/dam/wknd/en/adventures/cycling).

Sample Query

query {
  adventureList(
    filter: {
      _path: {
        _expressions: [
        {
          value: "/content/dam/wknd/en/adventures/cycling"
         _operator: STARTS_WITH
        }]
       }
    })
    {
    items {
      _path
    }
  }
}

Sample Results

{
  "data": {
    "adventureList": {
      "items": [
        {
          "_path": "/content/dam/wknd/en/adventures/cycling-southern-utah/cycling-southern-utah"
        },
        {
          "_path": "/content/dam/wknd/en/adventures/cycling-tuscany/cycling-tuscany"
        }
      ]
    }
  }
}

Sample Query - All cities in Germany or Switzerland with a population between 400000 through 999999 sample-all-cities-d-ch-population

Here a combination of fields is filtered on. An AND (implicit) is used to select the populationrange, while an OR (explicit) is used to select the required cities.

Sample Query

query {
  cityList(filter: {
    population: {
      _expressions: [
        {
          value: 400000
          _operator: GREATER_EQUAL
        }, {
          value: 1000000
          _operator: LOWER
        }
      ]
    },
    country: {
      _logOp: OR
      _expressions: [
        {
          value: "Germany"
        }, {
          value: "Switzerland"
        }
      ]
    }
  }) {
    items {
      name
      population
      country
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "Stuttgart",
          "population": 634830,
          "country": "Germany"
        },
        {
          "name": "Zurich",
          "population": 415367,
          "country": "Switzerland"
        }
      ]
    }
  }
}

Sample Query - All cities with SAN in the name, irrespective of case sample-all-cities-san-ignore-case

This query interrogates for all cities that have SAN in the name, irrespective of case.

Sample Query

query {
  cityList(filter: {
    name: {
      _expressions: [
        {
          value: "SAN"
          _operator: CONTAINS
          _ignoreCase: true
        }
      ]
    }
  }) {
    items {
      name
      population
      country
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA"
        },
        {
          "name": "San Jose",
          "population": 1026350,
          "country": "USA"
        }
      ]
    }
  }
}

Sample Query - Filter on an array with an item that must occur at least once sample-array-item-occur-at-least-once

This query filters on an array with an item (city:na) that must occur at least once.

Sample Query

query {
  cityList(filter: {
    categories: {
      _expressions: [
        {
          value: "city:na"
          _apply: AT_LEAST_ONCE
        }
      ]
    }
  }) {
    items {
      name
      population
      country
      categories
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA",
          "categories": [
            "city:beach",
            "city:na"
          ]
        },
        {
          "name": "San Jose",
          "population": 1026350,
          "country": "USA",
          "categories": [
            "city:na"
          ]
        }
      ]
    }
  }
}

Sample Query - Filter on an exact array value sample-array-exact-value

This query filters on an exact array value.

Sample Query

query {
  cityList(filter: {
    categories: {
      _expressions: [
        {
          values: [
            "city:beach",
            "city:na"
          ]
        }
      ]
    }
  }) {
    items {
      name
      population
      country
      categories
    }
  }
}

Sample Results

{
  "data": {
    "cityList": {
      "items": [
        {
          "name": "San Francisco",
          "population": 883306,
          "country": "USA",
          "categories": [
            "city:beach",
            "city:na"
          ]
        }
      ]
    }
  }
}

Sample Query for Nested Content Fragments - All companies that have at least one employee that has a name of “Smith” sample-companies-employee-smith

This query illustrates filtering for any person of name “Smith”, returning information from across two nested fragments - company and employee.

Sample Query

query {
  companyList(filter: {
    employees: {
      _match: {
        name: {
          _expressions: [
            {
              value: "Smith"
            }
          ]
        }
      }
    }
  }) {
    items {
      name
      ceo {
        name
        firstName
      }
      employees {
        name
        firstName
      }
    }
  }
}

Sample Results

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "NextStep Inc.",
          "ceo": {
            "name": "Jobs",
            "firstName": "Steve"
          },
          "employees": [
            {
              "name": "Smith",
              "firstName": "Joe"
            },
            {
              "name": "Lincoln",
              "firstName": "Abraham"
            }
          ]
        }
      ]
    }
  }
}

Sample Query for Nested Content Fragments - All companies where all employees have won the “Gamestar” award sample-all-companies-employee-gamestar-award

This query illustrates filtering across three nested fragments - company, employee, and award.

Sample Query

query {
  companyList(filter: {
    employees: {
      _apply: ALL
      _match: {
        awards: {
          _match: {
            id: {
              _expressions: [
                {
                  value: "GS"
                  _operator:EQUALS
                }
              ]
            }
          }
        }
      }
    }
  }) {
    items {
      name
      ceo {
        name
        firstName
      }
      employees {
        name
        firstName
        awards {
          id
          title
        }
      }
    }
  }
}

Sample Results

{
  "data": {
    "companyList": {
      "items": [
        {
          "name": "Little Pony, Inc.",
          "ceo": {
            "name": "Smith",
            "firstName": "Adam"
          },
          "employees": [
            {
              "name": "Croft",
              "firstName": "Lara",
              "awards": [
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            },
            {
              "name": "Slade",
              "firstName": "Cutter",
              "awards": [
                {
                  "id": "GB",
                  "title": "Gameblitz"
                },
                {
                  "id": "GS",
                  "title": "Gamestar"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Sample Query for Metadata - List the Metadata for Awards titled GB sample-metadata-awards-gb

This query illustrates filtering across three nested fragments - company, employee, and award.

Sample Query

query {
  awardList(filter: {
      id: {
        _expressions: [
          {
            value:"GB"
          }
        ]
    }
  }) {
    items {
      _metadata {
        stringMetadata {
          name,
          value
        }
      }
      id
      title
    }
  }
}

Sample Results

{
  "data": {
    "awardList": {
      "items": [
        {
          "_metadata": {
            "stringMetadata": [
              {
                "name": "title",
                "value": "Gameblitz Award"
              },
              {
                "name": "description",
                "value": ""
              }
            ]
          },
          "id": "GB",
          "title": "Gameblitz"
        }
      ]
    }
  }
}

Sample Queries using the WKND Project sample-queries-using-wknd-project

These sample queries are based on the WKND project. It has the following:

Content Fragment Models available under:
http://<hostname>:<port>/libs/dam/cfm/models/console/content/models.html/conf/wknd
Content Fragments (and other content) available under:
http://<hostname>:<port>/assets.html/content/dam/wknd/en
http://<hostname>:<port>/assets.html/content/dam/wknd-shared/en

NOTE

Because the results can be extensive, they are not reproduced here.

Sample Query for all Content Fragments of a certain model with the specified properties sample-wknd-all-model-properties

This sample query interrogates:

for all Content Fragments of type article
with the _path and properties of the authorFragment.

Sample Query

{
  articleList {
    items {
      _path
      authorFragment {
        _path
        firstName
        lastName
        birthDay
      }
    }
 }
}

Sample Query for Metadata sample-wknd-metadata

This query interrogates:

for all Content Fragments of type adventure
metadata

Sample Query

{
  adventureList {
    items {
      _path,
      _metadata {
        stringMetadata {
          name,
          value
        }
        stringArrayMetadata {
          name,
          value
        }
        intMetadata {
          name,
          value
        }
        intArrayMetadata {
          name,
          value
        }
        floatMetadata {
          name,
          value
        }
        floatArrayMetadata {
          name,
          value
        }
        booleanMetadata {
          name,
          value
        }
        booleanArrayMetadata {
          name,
          value
        }
        calendarMetadata {
          name,
          value
        }
        calendarArrayMetadata {
          name,
          value
        }
      }
    }
  }
}

Sample Query for a single Content Fragment of a given Model sample-wknd-single-content-fragment-of-given-model

This sample query interrogates:

for a single Content Fragment of type article at a specific path
- within that fragment, all formats of content:
  - HTML
  - Markdown
  - Plain Text
  - JSON

Sample Query

{
  articleByPath(_path: "/content/dam/wknd-shared/en/magazine/alaska-adventure/alaskan-adventures") {
    item {
        _path
        authorFragment {
          _path
          firstName
          lastName
          birthDay
        }
        main {
          html
          markdown
          plaintext
          json
        }
    }
  }
}

Sample Query for a Content Fragment Model from a Model sample-wknd-content-fragment-model-from-model

This sample query interrogates:

for a single Content Fragment
- details of the underlying Content Fragment Model

Sample Query

{
  adventureByPath(_path: "/content/dam/wknd-shared/en/magazine/western-australia/western-australia-by-camper-van") {
    item {
      _path
      title
      _model {
        _path
        title
      }
    }
  }
}

Sample Query for a Nested Content Fragment - Single Model Type sample-wknd-nested-fragment-single-model

This query interrogates:

for a single Content Fragment of type article at a specific path
- within that fragment, the path and author of the referenced (nested) fragment

NOTE

The field referencearticle has the Data type fragment-reference.

Sample Query

{
  adventureByPath(_path: "/content/dam/wknd-shared/en/magazine/western-australia/western-australia-by-camper-van") {
    item {
      _path
      title
      _model {
        _path
        title
      }
    }
  }
}

Sample Query for a Nested Content Fragment - Multiple Model Type sample-wknd-nested-fragment-multiple-model

Single referenced model type

This query interrogates:

for multiple Content Fragments of type bookmark
- with Fragment References to other fragments of the specific model type Article

NOTE

The field fragments has the Data type fragment-reference, with the model Article selected. Query delivers fragments as an array of [Article].

{
  bookmarkList {
    items {
        fragments {
          _path
          author
        }
     }
  }
}

Multiple referenced model types

This query interrogates:

for multiple Content Fragments of type bookmark
- with Fragment References to other fragments of the specific model types Article and Adventure

NOTE

The field fragments has the Data type fragment-reference, with the models Article, Adventure selected. Query delivers fragments as an array of [AllFragmentModels], which is dereferenced with union type.

{
  bookmarkList {
    items {
        fragments {
          ... on ArticleModel {
            _path
            author
          }
          ... on AdventureModel {
            _path
            adventureTitle
          }
        }
     }
  }
}

Sample Query for a Content Fragment of a specific Model with Content References sample-wknd-fragment-specific-model-content-reference

There are two flavors of this query:

To return all content references.
To return the specific content references of type attachments.

These queries interrogate:

for multiple Content Fragments of type bookmark
- with Content References to other fragments

Sample Query for multiple Content Fragments with Prefetched References sample-wknd-multiple-fragments-prefetched-references

The following query returns all content references by using _references:

{
  bookmarkList {
     _references {
         ... on ImageRef {
          _path
          type
          height
        }
        ... on MultimediaRef {
          _path
          type
          size
        }
        ... on DocumentRef {
          _path
          type
          author
        }
        ... on ArchiveRef {
          _path
          type
          format
        }
    }
    items {
        _path
    }
  }
}

Sample Query for multiple Content Fragments with Attachments sample-wknd-multiple-fragments-attachments

The following query returns all attachments - a specific field (subgroup) of type content-reference:

NOTE

The field attachments has the Data type content-reference, with various forms selected.

{
  bookmarkList {
    items {
      attachments {
        ... on PageRef {
          _path
          type
        }
        ... on ImageRef {
          _path
          width
        }
        ... on MultimediaRef {
          _path
          size
        }
        ... on DocumentRef {
          _path
          author
        }
        ... on ArchiveRef {
          _path
          format
        }
      }
    }
  }
}

Sample Query for a single Content Fragment with RTE Inline Reference sample-wknd-single-fragment-rte-inline-reference

This query interrogates:

for a single Content Fragment of type bookmark at a specific path
- within that, RTE inline references

NOTE

The RTE inline references are hydrated in _references.

Sample Query

{
  bookmarkByPath(_path: "/content/dam/wknd/en/bookmarks/skitouring") {
    item {
      _path
      description {
        json
      }
    }
    _references {
      ... on ArticleModel {
        _path
      }
      ... on AdventureModel {
        _path
      }
      ... on ImageRef {
        _path
      }
      ... on MultimediaRef {
        _path
      }
      ... on DocumentRef {
        _path
      }
      ... on ArchiveRef {
        _path
      }
    }
  }
}

Sample Query for a single Content Fragment variation of a given Model sample-wknd-single-fragment-given-model

This query interrogates:

for a single Content Fragment of type author at a specific path
- within that fragment, the data related to the variation: another

Sample Query

{
  authorByPath(_path: "/content/dam/wknd-shared/en/contributors/ian-provo", variation: "another") {
    item {
        _path
        _variation
        firstName
        lastName
        birthDay
    }
  }
}

Sample Query for a named Variation of multiple Content Fragments of a given Model sample-wknd-variation-multiple-fragment-given-model

This query interrogates:

for Content Fragments of type author with a specific variation: another

NOTE

This query demonstrates fallback for Content Fragments that do not have a Variation of the specified name.

Sample Query

{
  authorList(variation: "another") {
    items {
        _path
        _variation
        firstName
        lastName
        birthDay
    }
  }
}

Sample Query for multiple Content Fragments, and their Variations, of a given Model sample-wknd-multiple-fragment-variations-given-model

This query interrogates:

for Content Fragments of type article and all variations

Sample Query

query {
  articleList(
    includeVariations: true  ){
    items {
      _variation
      _path
      _tags
      _metadata {
        stringArrayMetadata {
          name
          value
        }
      }
    }
  }
}

Sample Query for Content Fragment Variations of a given Model that have a specific tag attached sample-wknd-fragment-variations-given-model-specific-tag

This query interrogates:

for Content Fragments of type article with one, or more, Variations having the tag WKND : Activity / Hiking

Sample Query

{
  articleList(
    includeVariations: true,
    filter: {_tags: {_expressions: [{value: "wknd:activity/hiking", _operator: CONTAINS}]}}
  ){
    items {
      _variation
      _path
      _tags
      _metadata {
        stringArrayMetadata {
          name
          value
        }
      }
    }
  }
}

Sample Query for multiple Content Fragments of a given locale sample-wknd-multiple-fragments-given-locale

This query interrogates:

for Content Fragments of type article within the fr locale

Sample Query

{
  articleList(_locale: "fr") {
    items {
      _path
      authorFragment {
        _path
        firstName
        lastName
        birthDay
      }
      main {
        html
        markdown
        plaintext
        json
      }
    }
  }
}

Sample List Query using offset and limit sample-list-offset-limit

This query interrogates:

for the page of results containing up to five articles, starting from the fifth article from the complete results list

Sample Query

{
   articleList(offset: 5, limit: 5) {
    items {
      authorFragment {
        _path
        firstName
        lastName
        birthDay
      }
      _path
    }
  }
}

Sample Pagination Query using first and after sample-pagination-first-after

This query interrogates:

for the page of results containing up to five adventures, starting from the given cursor item in the complete results list

Sample Query

{
    adventurePaginated(first: 5, after: "ODg1MmMyMmEtZTAzMy00MTNjLThiMzMtZGQyMzY5ZTNjN2M1") {
        edges {
          cursor
          node {
            title
          }
        }
        pageInfo {
          endCursor
          hasNextPage
        }
    }
}

Sample Query with filtering by _tags ID and excluding variations sample-filtering-tag-not-variations

This query interrogates:

for Content Fragments of type vehicle having the tag big-block
excluding variations

Sample Query

query {
  vehicleList(
    filter: {
    _tags: {
      _expressions: [
        {
          value: "vehicles:big-block"
          _operator: CONTAINS
        }
      ]
    }
  }) {
    items {
      _variation
      _path
      type
      name
      model
      fuel
      _tags
    }
  }
}

Sample Query with filtering by _tags ID and including variations sample-filtering-tag-with-variations

This query interrogates:

for Content Fragments of type vehicle having the tag big-block
including variations

Sample Query

{
  enginePaginated(after: "SjkKNmVkODFmMGQtNTQyYy00NmQ4LTljMzktMjhlNzQwZTY1YWI2Cmo5", first: 9 ,includeVariations:true, sort: "name",
    filter: {
    _tags: {
      _expressions: [
        {
          value: "vehicles:big-block"
          _operator: CONTAINS
        }
      ]
    }
  }) {
    edges{
    node {
        _variation
        _path
        name
        type
        size
        _tags
        _metadata {
          stringArrayMetadata {
            name
            value
          }
        }
    }
      cursor
    }
  }
}

The Sample Content Fragment Structure (used with GraphQL) content-fragment-structure-graphql

The sample queries are based on the following structure, which uses:

One, or more, Sample Content Fragment Models - form the basis for the GraphQL schemas
Sample Content Fragments based on the above models

Sample Content Fragment Models (Schemas) sample-content-fragment-models-schemas

For the sample queries, you use the following Content Models, and their interrelationships (references ->):

Company
-> Person
-> Award
City

Company model-company

The basic fields defining the company are:

Field Name

Data Type

Reference

Company Name

Single-line text

CEO

Fragment Reference (single)

Person

Employees

Fragment Reference (multifield)

Person

Person model-person

The fields defining a person, who can also be an employee:

Field Name

Data Type

Reference

Name

Single-line text

First name

Single-line text

Awards

Fragment Reference (multifield)

Award

Award model-award

The fields defining an award are:

Field Name

Data Type

Reference

Shortcut/ID

Single-line text

Title

Single-line text

City model-city

The fields for defining a city are:

Field Name

Data Type

Reference

Name

Single-line text

Country

Single-line text

Population

Number

Sample Content Fragments sample-content-fragments

The following fragments are used for the appropriate model.

Company fragment-company

Company Name

CEO

Employees

Apple

Steve Jobs

Duke Marsh
Max Caulfield

Little Pony Inc.

Adam Smith

Lara Croft
Cutter Slade

NextStep Inc.

Steve Jobs

Joe Smith
Abe Lincoln

Person fragment-person

Name

First Name

Awards

Lincoln

Abe

Smith

Adam

Slade

Cutter

Gameblitz
Gamestar

Marsh

Duke

Smith

Joe

Croft

Lara

Gamestar

Caulfield

Max

Gameblitz

Jobs

Steve

Award fragment-award

Shortcut/ID

Title

Gameblitz

Gamestar

OSC

Oscar

City fragment-city

Name

Country

Population

Learning to use GraphQL with AEM - Sample Content and Queries learn-graphql-with-aem-sample-content-queries

GraphQL - Sample Queries using the Sample Content Fragment Structure graphql-sample-queries-sample-content-fragment-structure

Sample Query - All Available Schemas and Datatypes sample-all-schemes-datatypes

Sample Query - All Information about All Cities sample-all-information-all-cities

Sample Query - Names of All Cities sample-names-all-cities

Sample Query - A Single Specific City Fragment sample-single-specific-city-fragment

Sample Query - All Cities with a Named Variation sample-cities-named-variation

Sample Query - Names of All Cities Tagged as City Breaks sample-names-all-cities-tagged-city-breaks

Sample Query - Full Details of a Company’s CEO and Employees sample-full-details-company-ceos-employees

Sample Query - All Persons that have a name of “Jobs” or “Smith” sample-all-persons-jobs-smith

Sample Query - All Persons that do not have a name of “Jobs” sample-all-persons-not-jobs

Sample Query - All Adventures whose _path is starting with a specific prefix sample-wknd-all-adventures-cycling-path-filter

Sample Query - All cities in Germany or Switzerland with a population between 400000 through 999999 sample-all-cities-d-ch-population

Sample Query - All cities with SAN in the name, irrespective of case sample-all-cities-san-ignore-case

Sample Query - Filter on an array with an item that must occur at least once sample-array-item-occur-at-least-once

Sample Query - Filter on an exact array value sample-array-exact-value

Sample Query for Nested Content Fragments - All companies that have at least one employee that has a name of “Smith” sample-companies-employee-smith

Sample Query for Nested Content Fragments - All companies where all employees have won the “Gamestar” award sample-all-companies-employee-gamestar-award

Sample Query for Metadata - List the Metadata for Awards titled GB sample-metadata-awards-gb

Sample Queries using the WKND Project sample-queries-using-wknd-project

Sample Query for all Content Fragments of a certain model with the specified properties sample-wknd-all-model-properties

Sample Query for Metadata sample-wknd-metadata

Sample Query for a single Content Fragment of a given Model sample-wknd-single-content-fragment-of-given-model

Sample Query for a Content Fragment Model from a Model sample-wknd-content-fragment-model-from-model

Sample Query for a Nested Content Fragment - Single Model Type sample-wknd-nested-fragment-single-model

Sample Query for a Nested Content Fragment - Multiple Model Type sample-wknd-nested-fragment-multiple-model

Single referenced model type

Multiple referenced model types

Sample Query for a Content Fragment of a specific Model with Content References sample-wknd-fragment-specific-model-content-reference

Sample Query for multiple Content Fragments with Prefetched References sample-wknd-multiple-fragments-prefetched-references

Sample Query for multiple Content Fragments with Attachments sample-wknd-multiple-fragments-attachments

Sample Query for a single Content Fragment with RTE Inline Reference sample-wknd-single-fragment-rte-inline-reference

Sample Query for a single Content Fragment variation of a given Model sample-wknd-single-fragment-given-model

Sample Query for a named Variation of multiple Content Fragments of a given Model sample-wknd-variation-multiple-fragment-given-model

Sample Query for multiple Content Fragments, and their Variations, of a given Model sample-wknd-multiple-fragment-variations-given-model

Sample Query for Content Fragment Variations of a given Model that have a specific tag attached sample-wknd-fragment-variations-given-model-specific-tag

Sample Query for multiple Content Fragments of a given locale sample-wknd-multiple-fragments-given-locale

Sample List Query using offset and limit sample-list-offset-limit

Sample Pagination Query using first and after sample-pagination-first-after

Sample Query with filtering by _tags ID and excluding variations sample-filtering-tag-not-variations

Sample Query with filtering by _tags ID and including variations sample-filtering-tag-with-variations

The Sample Content Fragment Structure (used with GraphQL) content-fragment-structure-graphql

Sample Content Fragment Models (Schemas) sample-content-fragment-models-schemas

Company model-company

Person model-person

Award model-award

City model-city

Sample Content Fragments sample-content-fragments

Company fragment-company

Person fragment-person

Award fragment-award

City fragment-city

Sample Query - All Adventures whose `_path` is starting with a specific prefix sample-wknd-all-adventures-cycling-path-filter