Package org.activiti.cloud.services.modeling.rest.api

Interface ProjectRestApi

All Known Implementing Classes:
ProjectController
@RestController @RequestMapping(path="/v1", produces={"application/hal+json","application/json"}) public interface ProjectRestApi
Controller for Project resources.

  • Field Details

  • Method Details

    • getProjects

      @GetMapping(path="/projects") org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<Project>> getProjects(org.springframework.data.domain.Pageable pageable, @RequestParam(name="name",required=false) String name, @RequestParam(name="filters",required=false) List<String> filters, @RequestParam(name="include",required=false) List<String> include)

    • createProject

      @PostMapping(path="/projects") @ResponseStatus(CREATED) org.springframework.hateoas.EntityModel<Project> createProject(@RequestBody Project project)

    • getProject

      @GetMapping(path="/projects/{projectId}") org.springframework.hateoas.EntityModel<Project> getProject(@PathVariable String projectId, @RequestParam(name="include",required=false) List<String> include)

    • updateProject

      @PutMapping(path="/projects/{projectId}") org.springframework.hateoas.EntityModel<Project> updateProject(@PathVariable String projectId, @RequestBody Project project)

    • deleteProject

      @DeleteMapping(path="/projects/{projectId}") @ResponseStatus(NO_CONTENT) void deleteProject(@PathVariable String projectId)

    • importProject

      @PostMapping(path="/projects/import", consumes="multipart/form-data") @ResponseStatus(CREATED) org.springframework.hateoas.EntityModel<Project> importProject(@RequestPart("file") org.springframework.web.multipart.MultipartFile file, @RequestParam(name="name",required=false) String name) throws IOException
      Throws:
      IOException

    • exportProject

      @GetMapping(path="/projects/{projectId}/export") void exportProject(jakarta.servlet.http.HttpServletResponse response, @PathVariable String projectId, @RequestParam(name="attachment",required=false,defaultValue="true") boolean attachment) throws IOException
      Throws:
      IOException

    • copyProject

      @PostMapping(path="/projects/{projectId}/copy") org.springframework.hateoas.EntityModel<Project> copyProject(@PathVariable String projectId, @RequestParam(name="name") String name)

    • validateProject

      @GetMapping(path="/projects/{projectId}/validate") void validateProject(@PathVariable String projectId) throws IOException
      Throws:
      IOException