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

Interface ModelRestApi

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

  • Field Details

  • Method Details

    • getModels

      @GetMapping(path="/projects/{projectId}/models") org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<Model>> getModels(@PathVariable String projectId, @RequestParam("type") String type, org.springframework.data.domain.Pageable pageable)

    • getModelsByName

      @GetMapping(path="/projects/{projectId}/models/findByName") org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<Model>> getModelsByName(@PathVariable String projectId, @RequestParam("name") String name, org.springframework.data.domain.Pageable pageable)

    • getModel

      @GetMapping(path="/models/{modelId}") org.springframework.hateoas.EntityModel<Model> getModel(@PathVariable String modelId)

    • createModel

      @PostMapping(path="/projects/{projectId}/models") @ResponseStatus(CREATED) org.springframework.hateoas.EntityModel<Model> createModel(@PathVariable String projectId, @RequestBody Model model)

    • updateModel

      @PutMapping(path="/models/{modelId}") org.springframework.hateoas.EntityModel<Model> updateModel(@PathVariable String modelId, @RequestBody Model model)

    • updateModelContent

      @PutMapping(path="/models/{modelId}/content", consumes="multipart/form-data") @ResponseStatus(NO_CONTENT) void updateModelContent(@PathVariable String modelId, @RequestPart("file") org.springframework.web.multipart.MultipartFile file) throws IOException
      Throws:
      IOException

    • deleteModel

      @DeleteMapping(path="/models/{modelId}") @ResponseStatus(NO_CONTENT) void deleteModel(@PathVariable String modelId)

    • getModelContent

      @GetMapping(path="/models/{modelId}/content") void getModelContent(jakarta.servlet.http.HttpServletResponse response, @PathVariable String modelId) throws IOException
      Throws:
      IOException

    • getModelDiagram

      @GetMapping(path="/models/{modelId}/content", produces="image/svg+xml") void getModelDiagram(jakarta.servlet.http.HttpServletResponse response, @PathVariable String modelId) throws IOException
      Throws:
      IOException

    • importModel

      @PostMapping(path="/projects/{projectId}/models/import", consumes="multipart/form-data") @ResponseStatus(CREATED) org.springframework.hateoas.EntityModel<Model> importModel(@PathVariable String projectId, @RequestParam("type") String type, @RequestPart("file") org.springframework.web.multipart.MultipartFile file) throws IOException
      Throws:
      IOException

    • exportModel

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

    • getModelTypes

      @GetMapping(path="/model-types") org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<ModelType>> getModelTypes(org.springframework.data.domain.Pageable pageable)

    • validateModel

      @PostMapping(path="/models/{modelId}/validate", consumes="multipart/form-data") @ResponseStatus(NO_CONTENT) void validateModel(@PathVariable String modelId, @RequestPart("file") org.springframework.web.multipart.MultipartFile file, @RequestParam(value="projectId",required=false) String projectId, @RequestParam(value="The model is going to be validated and checked used in other model",required=false) boolean isUsed) throws IOException
      Throws:
      IOException

    • validateModelExtensions

      @PostMapping(path="/models/{modelId}/validate/extensions", consumes="multipart/form-data") @ResponseStatus(NO_CONTENT) void validateModelExtensions(@PathVariable String modelId, @RequestPart("file") org.springframework.web.multipart.MultipartFile file, @RequestParam(value="projectId",required=false) String projectId) throws IOException
      Throws:
      IOException

    • getGlobalModels

      @GetMapping(path="/models") org.springframework.hateoas.PagedModel<org.springframework.hateoas.EntityModel<Model>> getGlobalModels(@RequestParam("type") String type, @RequestParam(value="includeOrphans",required=false,defaultValue="false") boolean includeOrphans, org.springframework.data.domain.Pageable pageable)

    • putProjectModelRelationship

      @PutMapping(path="/projects/{projectId}/models/{modelId}") org.springframework.hateoas.EntityModel<Model> putProjectModelRelationship(@PathVariable String projectId, @PathVariable String modelId, @RequestParam(value="scope",required=false) String scope, @RequestParam(value="force",required=false,defaultValue="false") boolean force)

    • deleteProjectModelRelationship

      @DeleteMapping(path="/projects/{projectId}/models/{modelId}") org.springframework.hateoas.EntityModel<Model> deleteProjectModelRelationship(@PathVariable String projectId, @PathVariable String modelId)

    • createModelWithoutProject

      @PostMapping(path="/models") @ResponseStatus(CREATED) org.springframework.hateoas.EntityModel<Model> createModelWithoutProject(@RequestBody Model model)