Cristal Integration - REST Server

Last modified by Admin on 2026/04/01 01:04

cogService to allow connection from a Cristal instance through a RESTful API
TypeJAR
CategoryApplication
Developed by

Pierre Jeanjean

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Since v1.4.0 requires XWiki 18.1.0

Success

Installable with the Extension Manager

Description

A REST server providing the necessary endpoints to support a Cristal instance.

/cristal/wikis/{wikiName}/spaces/{spaceName}[/spaces/{nestedSpaceName}]*/pages/{pageName}[?format=f&revision=r]

  • HTTP Method: GET
    • Query parameters
      • format: the format expected for the response (either "jsonld", or empty to retrieve the resource as-is)
      • revision: the page revision to request (default: latest available)
    • Description: Returns a page resource.
    • Status codes:
      • 200: If the request was successful.
      • 401: If the user is not authorized.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager).

You can also use the manual method which involves dropping the JAR file and all its dependencies into the WEB-INF/lib folder and restarting XWiki.

Versions

Dependencies

Dependencies for this extension (org.xwiki.contrib.cristal.integration:cristal-integration-rest-server 1.4.0):

  • jakarta.json:jakarta.json-api 2.1.3
  • org.xwiki.contrib.cristal.integration:cristal-integration-rest-api 1.4.0
  • org.xwiki.platform:xwiki-platform-rest-api 18.1.0
  • org.xwiki.platform:xwiki-platform-rest-server 18.1.0
  • org.xwiki.platform:xwiki-platform-oldcore 18.1.0
  • org.xwiki.contrib.markdown:syntax-markdown-commonmark12 8.9

Get Connected