Collection

Pagination

Group of objects are returned as Collection types containing pagination information and items, such as CategoryCollection. The response is controlled with the page and perPage arguments.

query GetCategories ($page: Int = 1, $perPage: Int = 10) {
  cms {
    categories (page: $page, perPage: $perPage) {
      pagination {
        page
        lastPage
        total
      }
      items {
        id
        name
        description
      }
    }
  }
}

{
  "data": {
    "cms": {
      "categories": {
        "pagination": {
          "page": 1,
          "lastPage": 2,
          "total": 14
        },
        "items": [
          {
            "id": "2",
            "name": "Accueil",
            "description": ""
          },
          {
            "id": "4",
            "name": "Action",
            "description": ""
          },
          {
            "id": "13",
            "name": "Concerts",
            "description": ""
          },
          // ...
        ]
      }
    }
  }
}

Sort

The sort argument can be used to sort Collection.items based on one or more property paths.

query GetCategories {
  cms {
    categories (sort: [
      { field: "id" order: Desc }
    ]) {
      items {
        id
        name
      }
    }
  }
}

{
  "data": {
    "cms": {
      "categories": {
        "items": [
          {
            "id": "14",
            "name": "Formations"
          },
          {
            "id": "13",
            "name": "Concerts"
          },
          // ...
        ]
      }
    }
  }
}

Query

Queries to filter Collection.items are provided in the query argument and must follow Elasticsearch's query string sytnax (opens new window).

Example: Products published in September 2020.

query Products {
  cms {
    products (
      query: "dateFrom:[2020-09-01 TO 2020-10-01]"
    ) {
      items {
        id
        name
        dateFrom
      }
    }
  }
}

{
  "data": {
    "cms": {
      "products": {
        "items": [
          {
            "id": "1",
            "name": "The line",
            "dateFrom": "2020-09-27T01:30:12.000Z",
            "dateTo": null
          },
          {
            "id": "2",
            "name": "Die Hard : belle journée pour mourir",
            "dateFrom": "2020-09-27T01:30:12.000Z",
            "dateTo": null
          },
          // ...
        ]
      }
    }
  }
}

IncludeIds

The includeIds argument is useful to retrieve specific items by ids.

query Products {
  cms {
    products (includeIds: [1, 2]) {
      items {
        id
        name
        dateFrom
      }
    }
  }
}

{
  "data": {
    "cms": {
      "products": {
        "items": [
          {
            "id": "1",
            "name": "The line"
          },
          {
            "id": "2",
            "name": "Die Hard : belle journée pour mourir"
          }
        ]
      }
    }
  }
}