Package com.xwiki.projectmanagement.openproject.rest.document

Interface OpenProjectSpaceResource

public interface OpenProjectSpaceResource

Resource for handling the OpenProject integration spaces.

Since:

1.2.0-rc-1

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	createSpace(String wiki, String documentReference, Boolean withId)	Creates the OpenProject project template at the given document reference.

Method Details

createSpace

javax.ws.rs.core.Response createSpace(String wiki,
 String documentReference,
 Boolean withId)
                               throws org.xwiki.rest.XWikiRestException

Creates the OpenProject project template at the given document reference.

Parameters:

wiki - the wiki where the template should be created.

documentReference - the reference identifying where the template should be created.

withId - if set to true, also creates and attaches to the created document unique identifiers. The returned documents will also contain the attached unique id.

Returns:

200 together with a list of Page, representing the created pages. 401 if the user does not have edit rights on the space. 403 if the page already exists. 406 if the requested wiki does not have the OpenProject integration UI installed.

Throws:

org.xwiki.rest.XWikiRestException - if any other problem occurs in the process of space creation.