Delivery API features matrix

The information on this documentation page is not yet applicable in production.

This page provides a concise overview of method, filter and configuration properties and features available in Magnolia Delivery API, provided by the REST module (version 3.0 and higher).

CDS and JCR CDS only JCR only

Delivery methods

  • Query nodes

    • Params:

      • q

      • depth

      • offset

      • limit

      • orderBy

      • includesTotal

      • <filter>

  • Read node

    • Params:

      • path

      • depth

  • Get children

    • Params:

      • path

      • depth

      • offset

      • limit

      • includesTotal

  • Query nodes

    • Params:

      • version

  • Read node

    • Params:

      • version

Delivery filters

  • eq

  • ne

  • gt

  • lt

  • gte

  • lte

  • in

  • not-in

  • like

  • null

  • @name

  • @path

  • @id

  • @jcr:uuid

  • @ancestor

Endpoint configuration properties

  • class

  • $type

  • workspace

  • nodeTypes

  • includeSystemProperties

  • systemProperties

  • limit

  • references

  • referenceDepth

  • referenceRepeat

  • depth

depth is not supported in the CDS Read node method.

  • childContentTypes

  • contentProperties

  • includeNonTypeChildContent

  • typeNodeMappings

  • rootPath

  • endpointPath

  • chidNodeTypes

  • bypassWorkspaceAcls

  • personalized

  • timeToLive

  • strict

  • properties

  • excludeProperties

For reference resolving configuration properties, please see:
Feedback

DX Core

×

Location

This widget lets you know where you are on the docs site.

You are currently perusing through the REST module docs.

Main doc sections

DX Core Headless PaaS Legacy Cloud Incubator modules