cogREST API to deal with XWiki Filesystem Format (XFF) format
TypeJAR
CategoryAPI
Developed by

XWiki Development Team

Active Installs0
Rating
Rate!
0 Votes
LicenseGNU Lesser General Public License 2.1
Installable with the Extension Manager

Description

REST API to deal with XWiki Filesystem Format (XFF) format.

This API allow you to send an XFF format to a running XWiki platform.  By defaut all the resources of the RESTful API are rooted at the following URI: http://server:port/xwiki/rest/ (depending on where your XWiki is running).

/wikis/{wikiName}/xff

  • HTTP Method: POST
    • Accepted Media types:
      • octet/stream (A XFF file)
    • Description: import a XFF in a wiki.
    • Status codes:
      • 200: If the request was successful.

Test it with curl

Imagine that you have a new extension in a XFF format in the form of a ZIP file myextension.xff and that you want to import it into your localhost (running on port 8080), in the main wiki called xwiki, this is how you would do it.

curl \
  --verbose \
  --request POST \
  --user "username:password" \
  --header 'Content-Type: octet/stream' \
  --data-binary "@myextension.xff" \
  "http://localhost:8080/xwiki/rest/wikis/xwiki/xff"

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). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

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.

Dependencies

Dependencies for this extension (org.xwiki.contrib:xff-rest-api 0.4.0):

Tags:
Created by Jean SIMARD on 2015/09/16 08:48
    

Get Connected