Package com.xwiki.task.rest

Interface TaskResource

@Unstable
public interface TaskResource

Provides operations on task pages.

Since:

3.0

Version:

$Id$

Method Summary

Modifier and Type	Method	Description
javax.ws.rs.core.Response	changeTaskStatus(String wikiName, String spaces, String pageName, String status)	Modify the status of a Task macro.

Method Detail

changeTaskStatus

javax.ws.rs.core.Response changeTaskStatus(String wikiName,
                                           @Encoded
                                           String spaces,
                                           String pageName,
                                           String status)
                                    throws org.xwiki.rest.XWikiRestException

Modify the status of a Task macro.

Parameters:

wikiName - the name of the wiki in which the page resides

spaces - the spaces of the page

pageName - the name of the page

status - whether the task has been completed or not

Returns:

200 is the status has been changed successfully of 404 if the task was not found

Throws:

org.xwiki.rest.XWikiRestException - when failing in retrieving the document or saving it