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 Detail

      • GET_PROJECT_ID_PARAM_DESCR

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

      • CREATE_PROJECT_PARAM_DESCR

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

      • UPDATE_PROJECT_ID_PARAM_DESCR

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

      • UPDATE_PROJECT_PARAM_DESCR

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

      • DELETE_PROJECT_ID_PARAM_DESCR

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

      • IMPORT_PROJECT_FILE_PARAM_DESCR

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

      • EXPORT_PROJECT_ID_PARAM_DESCR

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

      • VALIDATE_PROJECT_ID_PARAM_DESCR

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

      • ATTACHMENT_API_PARAM_DESCR

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

      • PROJECT_NAME_PARAM_DESCR

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

      • PROJECT_NAME_OVERRIDE_DESCR

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

      • UPLOAD_FILE_PARAM_NAME

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

      • EXPORT_AS_ATTACHMENT_PARAM_NAME

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

      • PROJECT_NAME_PARAM_NAME

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

    • Method Detail

      • getProjects

        @GetMapping(path="/projects")
org.springframework.hateoas.PagedResources<org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Project>> getProjects​(org.springframework.data.domain.Pageable pageable,
                                                                                                                                      @RequestParam(name="name",required=false)
                                                                                                                                      java.lang.String name)

      • createProject

        @PostMapping(path="/projects")
@ResponseStatus(CREATED)
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Project> createProject​(@RequestBody
                                                                                            org.activiti.cloud.modeling.api.Project project)

      • getProject

        @GetMapping(path="/projects/{projectId}")
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Project> getProject​(@PathVariable
                                                                                         java.lang.String projectId)

      • updateProject

        @PutMapping(path="/projects/{projectId}")
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Project> updateProject​(@PathVariable
                                                                                            java.lang.String projectId,
                                                                                            @RequestBody
                                                                                            org.activiti.cloud.modeling.api.Project project)

      • deleteProject

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

      • importProject

        @PostMapping(path="/projects/import",
             consumes="multipart/form-data")
@ResponseStatus(CREATED)
org.springframework.hateoas.Resource<org.activiti.cloud.modeling.api.Project> importProject​(@RequestParam("file")
                                                                                            org.springframework.web.multipart.MultipartFile file,
                                                                                            @RequestParam(name="name",required=false)
                                                                                            java.lang.String name)
                                                                                     throws java.io.IOException
        Throws:
        java.io.IOException

      • exportProject

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

      • validateProject

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