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 Detail

      • GET_MODELS_TYPE_PARAM_DESCR

        static final java.lang.String GET_MODELS_TYPE_PARAM_DESCR
        See Also:
        Constant Field Values

      • GET_MODELS_PROJECT_ID_PARAM_DESCR

        static final java.lang.String GET_MODELS_PROJECT_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • GET_MODEL_ID_PARAM_DESCR

        static final java.lang.String GET_MODEL_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • CREATE_MODEL_PARAM_DESCR

        static final java.lang.String CREATE_MODEL_PARAM_DESCR
        See Also:
        Constant Field Values

      • CREATE_MODEL_PROJECT_ID_PARAM_DESCR

        static final java.lang.String CREATE_MODEL_PROJECT_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • UPDATE_MODEL_ID_PARAM_DESCR

        static final java.lang.String UPDATE_MODEL_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • UPDATE_MODEL_PARAM_DESCR

        static final java.lang.String UPDATE_MODEL_PARAM_DESCR
        See Also:
        Constant Field Values

      • UPDATE_MODEL_FILE_PARAM_DESCR

        static final java.lang.String UPDATE_MODEL_FILE_PARAM_DESCR
        See Also:
        Constant Field Values

      • DELETE_MODEL_ID_PARAM_DESCR

        static final java.lang.String DELETE_MODEL_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • GET_MODEL_CONTENT_ID_PARAM_DESCR

        static final java.lang.String GET_MODEL_CONTENT_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • IMPORT_MODEL_TYPE_PARAM_DESCR

        static final java.lang.String IMPORT_MODEL_TYPE_PARAM_DESCR
        See Also:
        Constant Field Values

      • IMPORT_MODEL_FILE_PARAM_DESCR

        static final java.lang.String IMPORT_MODEL_FILE_PARAM_DESCR
        See Also:
        Constant Field Values

      • EXPORT_MODEL_ID_PARAM_DESCR

        static final java.lang.String EXPORT_MODEL_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • VALIDATE_MODEL_ID_PARAM_DESCR

        static final java.lang.String VALIDATE_MODEL_ID_PARAM_DESCR
        See Also:
        Constant Field Values

      • VALIDATE_MODEL_FILE_PARAM_DESCR

        static final java.lang.String VALIDATE_MODEL_FILE_PARAM_DESCR
        See Also:
        Constant Field Values

      • VALIDATE_EXTENSIONS_FILE_PARAM_DESCR

        static final java.lang.String VALIDATE_EXTENSIONS_FILE_PARAM_DESCR
        See Also:
        Constant Field Values

      • MODEL_TYPE_PARAM_NAME

        static final java.lang.String MODEL_TYPE_PARAM_NAME
        See Also:
        Constant Field Values

    • Method Detail

      • getModels

        @GetMapping(path="/projects/{projectId}/models")
org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Model>> getModels​(@PathVariable
                                                                                                                                  java.lang.String projectId,
                                                                                                                                  @RequestParam("type")
                                                                                                                                  java.lang.String type,
                                                                                                                                  org.springframework.data.domain.Pageable pageable)

      • getModel

        @GetMapping(path="/models/{modelId}")
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Model> getModel​(@PathVariable
                                                                                     java.lang.String modelId)

      • createModel

        @PostMapping(path="/projects/{projectId}/models")
@ResponseStatus(CREATED)
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Model> createModel​(@PathVariable
                                                                                        java.lang.String projectId,
                                                                                        @RequestBody
                                                                                        org.activiti.cloud.modeling.api.Model model)

      • updateModel

        @PutMapping(path="/models/{modelId}")
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Model> updateModel​(@PathVariable
                                                                                        java.lang.String modelId,
                                                                                        @RequestBody
                                                                                        org.activiti.cloud.modeling.api.Model model)

      • updateModelContent

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

      • deleteModel

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

      • getModelContent

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

      • getModelDiagram

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

      • importModel

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

      • exportModel

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

      • getModelTypes

        @GetMapping(path="/model-types")
org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.ModelType>> getModelTypes​(org.springframework.data.domain.Pageable pageable)

      • validateModel

        @PostMapping("/models/{modelId}/validate")
@ResponseStatus(NO_CONTENT)
void validateModel​(@PathVariable
                   java.lang.String modelId,
                   @RequestParam("file")
                   org.springframework.web.multipart.MultipartFile file)
            throws java.io.IOException
        Throws:
        java.io.IOException

      • validateModelExtensions

        @PostMapping("/models/{modelId}/validate/extensions")
@ResponseStatus(NO_CONTENT)
void validateModelExtensions​(@PathVariable
                             java.lang.String modelId,
                             @RequestParam("file")
                             org.springframework.web.multipart.MultipartFile file)
                      throws java.io.IOException
        Throws:
        java.io.IOException