Package com.xwiki.projectmanagement.openproject

Interface OpenProjectApiClient

@Role public interface OpenProjectApiClient
Defines the methods that a OpenProject api client should implement.
Version:
$Id$

  • Method Details

    • getWorkPackages

      PaginatedResult<WorkPackage> getWorkPackages(int offset, int pageSize, String filters, String sortBy) throws ProjectManagementException
      Retrieves a list of available work packages from the current OpenProject configuration.
      Parameters:
      offset - the offset index from which to start retrieving work packages.
      pageSize - the maximum number of work packages to return.
      filters - optional filters to apply (e.g. query parameters encoded as a string).
      sortBy - optional sorting criteria to apply (e.g. field name and sort direction).
      Returns:
      a PaginatedResult containing the list of WorkPackage and pagination metadata.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the work packages.

    • getProjectWorkPackages

      PaginatedResult<WorkPackage> getProjectWorkPackages(String project, int offset, int pageSize, String filters, String sortBy) throws ProjectManagementException
      Retrieves a list of available work packages from the current OpenProject configuration and specified project.
      Parameters:
      project - the project (project name or id) from which we want to retrieve the work packages
      offset - the offset index from which to start retrieving work packages.
      pageSize - the maximum number of work packages to return.
      filters - optional filters to apply (e.g. query parameters encoded as a string).
      sortBy - optional sorting criteria to apply (e.g. field name and sort direction).
      Returns:
      a PaginatedResult containing the list of WorkPackage and pagination metadata.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the work packages.

    • getUsers

      PaginatedResult<User> getUsers(int offset, int pageSize, String filters) throws ProjectManagementException
      Retrieves a list of available users based on the specified page size and filter criteria from the current OpenProject configuration.
      Parameters:
      offset - the offset from which to start retrieving users.
      pageSize - the number of users to retrieve per page.
      filters - a JSON-formatted string representing filter criteria to apply to the request
      Returns:
      a list of User
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the users.

    • getAvailableUsers

      default PaginatedResult<User> getAvailableUsers(String url, int offset, int pageSize, String filters) throws ProjectManagementException
      Retrieves a list of available users for creating a work package based on the specified page size and filter criteria from the current OpenProject configuration.
      Parameters:
      url - the URL of the work package for which we want to retrieve the available users.
      offset - the offset from which to start retrieving users.
      pageSize - the number of users to retrieve per page.
      filters - a JSON-formatted string representing filter criteria to apply to the request
      Returns:
      a list of User
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the users.
      Since:
      1.1

    • getProjects

      PaginatedResult<Project> getProjects(int offset, int pageSize, String filters) throws ProjectManagementException
      Retrieves a paginated list of available projects based on the specified page size and filter criteria from the current OpenProject configuration.
      Parameters:
      offset - the offset from which to start retrieving projects.
      pageSize - the number of projects to retrieve per page.
      filters - a JSON-formatted string representing filter criteria to apply to the request.
      Returns:
      a list of Project.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the projects.

    • getAvailableProjects

      default PaginatedResult<Project> getAvailableProjects(String url, int offset, int pageSize, String filters) throws ProjectManagementException
      Retrieves a paginated list of available projects for creating work packages based on the specified page size and filter criteria from the current OpenProject configuration.
      Parameters:
      url - the URL of the work package for which we want to retrieve the available projects.
      offset - the offset from which to start retrieving projects.
      pageSize - the number of projects to retrieve per page.
      filters - a JSON-formatted string representing filter criteria to apply to the request.
      Returns:
      a list of Project.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the projects.
      Since:
      1.1

    • getTypes

      PaginatedResult<Type> getTypes() throws ProjectManagementException
      Retrieves all available types from the current OpenProject configuration.
      Returns:
      a List of Type.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the types.

    • getStatuses

      PaginatedResult<Status> getStatuses() throws ProjectManagementException
      Retrieves all available statuses from the current OpenProject configuration.
      Returns:
      a List of Status.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the statuses.

    • getPriorities

      PaginatedResult<Priority> getPriorities() throws ProjectManagementException
      Retrieves all available priorities from the current OpenProject configuration.
      Returns:
      a List of Priority.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the priorities.

    • getUserAvatar

      UserAvatar getUserAvatar(String userId) throws ProjectManagementException
      Retrieve the user avatar.
      Parameters:
      userId - the id of the user for which we want to retrieve the avatar.
      Returns:
      the model containing the image stream and its content type.
      Throws:
      ProjectManagementException
      Since:
      1.0-rc-5

    • getWorkPackagesFormResponse

      default com.fasterxml.jackson.databind.JsonNode getWorkPackagesFormResponse(String jsonBody) throws ProjectManagementException
      Retrieves work packages form response.
      Parameters:
      jsonBody - the json body.
      Returns:
      the json node.
      Throws:
      ProjectManagementException - if some error was encountered while trying to retrieve the work packages form
      Since:
      1.1

    • createWorkPackage

      default com.fasterxml.jackson.databind.JsonNode createWorkPackage(String url, String jsonBody) throws ProjectManagementException
      Creates a work package in OpenProject.
      Parameters:
      url - the URL to create the work package.
      jsonBody - the JSON body representing the work package to be created.
      Returns:
      the created work package.
      Throws:
      ProjectManagementException - if there was an issue during the creation process.
      Since:
      1.1