Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Notice that the content of an object (map) is on a separate level in the YAML example and that its own indent level and list items are denoted by hyphens ("-"). You can easily convert between these two formats at json2yaml.com.

Query syntax

See the examples above and Search Parameters for a list of all valid parameters and a detailed description on each one of them.

IDs and ID-based Lookup

If the ID of a content item is already known from a previous search request, it can easily be retrieved using the ids parameter as shown in the example above.

There are different kinds of IDs used in XperienCentral for different purposes. Content Item IDs are used to request specific content items via this API, often in combination with a specific language. That will return the current (=active) version in that language. Version IDs are never used in the API. Content Item can be either a Page or a Media Item. Since the numerical ID used for pages and media items might overlap this internal ID is prefixed by either "P" for Page or "M" for Media Item in this API. If the ID of a content item is already known from a previous search request, it can easily be retrieved using the ids parameter as shown in the example above.

Languages and "Display-on" pages

...

A Media Item is rendered via its "display-on" page. The language of the Media Item decides the language version of the display-on page. Therefore ensure that display-on pages are available in all different languages.


Back to top

...


...

Responses

Successful responses

A successful response has a results field containing a list of results. See examples above. A successful result always starts with the following field:

...