Package com.xwiki.projectmanagement.rest

Interface ProjectsResource

public interface ProjectsResource
The resource that exposes CRUD operations over the work items of the different project management implementations.
Since:
1.0
Version:
$Id$

  • Method Summary

    Modifier and Type
    Method
    Description
    javax.ws.rs.core.Response
    getProject(String wiki, String projectManagementHint, String projectId)
    Retrieve a project from a specific project management implementation.
    javax.ws.rs.core.Response
    getProjects(String wiki, String projectManagementHint, int page, int pageSize, String filter)
    Retrieve a list of projects.

  • Method Details

    • getProject

      javax.ws.rs.core.Response getProject(String wiki, String projectManagementHint, String projectId)
      Retrieve a project from a specific project management implementation.
      Parameters:
      wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.
      projectManagementHint - the hint of the project management implementation.
      projectId - the id of the project.
      Returns:
      a project model. HTTP 200: successful retrieval. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items.

    • getProjects

      javax.ws.rs.core.Response getProjects(String wiki, String projectManagementHint, int page, int pageSize, String filter)
      Retrieve a list of projects.
      Parameters:
      wiki - the wiki from where the project management implementation can retrieve. Depending on the implementation, different wikis can have different configurations or the wiki might be irrelevant to the query.
      projectManagementHint - the hint of the project management implementation.
      page - the page number that is being requested.
      pageSize - the maximum number of elements that can be returned by this query.
      filter - the filter that should match the returned projects.
      Returns:
      a paginated result of work items specific to the page number. HTTP 200: successful retrieval. HTTP 401: the user is not logged in. HTTP 403: the user does not have the rights to retrieve the work items.