Interface ApplicationEntityManagerRestOpenApi

  • All Known Implementing Classes:
    ApplicationEntityManagerRestController

    @RequestMapping("/v2.1.1/core/aem/")
    public interface ApplicationEntityManagerRestOpenApi
    Swagger documentation for Application Entity Manager.
    Author:
    Mauricio Ruiz Beltrán <mauricio.ruiz@kuwaiba.org>
    • Method Detail

      • createRootPool

        @RequestMapping(method=POST,
                        value="createRootPool/{name}/{description}/{className}/{type}/{sessionId}",
                        produces="application/json")
        String createRootPool​(@NotNull @Valid @PathVariable(value="name",required=true)
                              @NotNull @Valid String name,
                              @NotNull @Valid @PathVariable(value="description",required=true)
                              @NotNull @Valid String description,
                              @NotNull @Valid @PathVariable(value="className",required=true)
                              @NotNull @Valid String className,
                              @NotNull @Valid @PathVariable(value="type",required=true)
                              @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                              @NotNull @Valid String sessionId)
      • createPoolInObject

        @RequestMapping(method=POST,
                        value="createPoolInObject/{parentClassName}/{parentId}/{name}/{description}/{className}/{type}/{sessionId}",
                        produces="application/json")
        String createPoolInObject​(@NotNull @Valid @PathVariable(value="parentClassName",required=true)
                                  @NotNull @Valid String parentClassName,
                                  @NotNull @Valid @PathVariable(value="parentId",required=true)
                                  @NotNull @Valid String parentId,
                                  @NotNull @Valid @PathVariable(value="name",required=true)
                                  @NotNull @Valid String name,
                                  @NotNull @Valid @PathVariable(value="description",required=true)
                                  @NotNull @Valid String description,
                                  @NotNull @Valid @PathVariable(value="className",required=true)
                                  @NotNull @Valid String className,
                                  @NotNull @Valid @PathVariable(value="type",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)
      • createPoolInPool

        @RequestMapping(method=POST,
                        value="createPoolInPool/{parentId}/{name}/{description}/{className}/{type}/{sessionId}",
                        produces="application/json")
        String createPoolInPool​(@NotNull @Valid @PathVariable(value="parentId",required=true)
                                @NotNull @Valid String parentId,
                                @NotNull @Valid @PathVariable(value="name",required=true)
                                @NotNull @Valid String name,
                                @NotNull @Valid @PathVariable(value="description",required=true)
                                @NotNull @Valid String description,
                                @NotNull @Valid @PathVariable(value="className",required=true)
                                @NotNull @Valid String className,
                                @NotNull @Valid @PathVariable(value="type",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)
      • deletePools

        @RequestMapping(method=DELETE,
                        value="deletePools/{ids}/{sessionId}",
                        produces="application/json")
        void deletePools​(@NotNull @Valid @PathVariable(value="ids",required=true)
                         @NotNull @Valid String[] ids,
                         @NotNull @Valid @PathVariable(value="sessionId",required=true)
                         @NotNull @Valid String sessionId)
      • setPoolProperties

        @RequestMapping(method=PUT,
                        value="setPoolProperties/{poolId}/{name}/{description}/{sessionId}",
                        produces="application/json")
        ChangeDescriptor setPoolProperties​(@NotNull @Valid @PathVariable(value="poolId",required=true)
                                           @NotNull @Valid String poolId,
                                           @NotNull @Valid @PathVariable(value="name",required=true)
                                           @NotNull @Valid String name,
                                           @NotNull @Valid @PathVariable(value="description",required=true)
                                           @NotNull @Valid String description,
                                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                           @NotNull @Valid String sessionId)
      • getBusinessObjectAuditTrail

        @RequestMapping(method=GET,
                        value="getBusinessObjectAuditTrail/{className}/{objectId}/{limit}/{sessionId}",
                        produces="application/json")
        List<ActivityLogEntry> getBusinessObjectAuditTrail​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                           @NotNull @Valid String className,
                                                           @NotNull @Valid @PathVariable(value="objectId",required=true)
                                                           @NotNull @Valid String objectId,
                                                           @NotNull @Valid @PathVariable(value="limit",required=true)
                                                           @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                           @NotNull @Valid String sessionId)
      • getGeneralActivityAuditTrailCount

        @RequestMapping(method=POST,
                        value="getGeneralActivityAuditTrailCount/{page}/{limit}/{sessionId}",
                        produces="application/json")
        long getGeneralActivityAuditTrailCount​(@NotNull @Valid @PathVariable(value="page",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                                               @NotNull @Valid @PathVariable(value="limit",required=true)
                                               @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                               @NotNull @Valid @RequestBody
                                               @NotNull @Valid HashMap<String,​Object> filters,
                                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                               @NotNull @Valid String sessionId)
      • getGeneralActivityAuditTrail

        @RequestMapping(method=POST,
                        value="getGeneralActivityAuditTrail/{page}/{limit}/{sessionId}",
                        produces="application/json")
        List<ActivityLogEntry> getGeneralActivityAuditTrail​(@NotNull @Valid @PathVariable(value="page",required=true)
                                                            @javax.validation.constraints.NotNull,@javax.validation.Valid int page,
                                                            @NotNull @Valid @PathVariable(value="limit",required=true)
                                                            @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                            @NotNull @Valid @RequestBody
                                                            @NotNull @Valid HashMap<String,​Object> filters,
                                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                            @NotNull @Valid String sessionId)
      • getObjectRelatedView

        @RequestMapping(method=GET,
                        value="getObjectRelatedView/{objectId}/{className}/{viewId}/{sessionId}",
                        produces="application/json")
        ViewObject getObjectRelatedView​(@NotNull @Valid @PathVariable(value="objectId",required=true)
                                        @NotNull @Valid String objectId,
                                        @NotNull @Valid @PathVariable(value="className",required=true)
                                        @NotNull @Valid String className,
                                        @NotNull @Valid @PathVariable(value="viewId",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)
      • getObjectRelatedViews

        @RequestMapping(method=GET,
                        value="getObjectRelatedViews/{objectId}/{className}/{limit}/{sessionId}",
                        produces="application/json")
        List<ViewObjectLight> getObjectRelatedViews​(@NotNull @Valid @PathVariable(value="objectId",required=true)
                                                    @NotNull @Valid String objectId,
                                                    @NotNull @Valid @PathVariable(value="className",required=true)
                                                    @NotNull @Valid String className,
                                                    @NotNull @Valid @PathVariable(value="limit",required=true)
                                                    @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                                    @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                    @NotNull @Valid String sessionId)
      • getGeneralViews

        @RequestMapping(method=GET,
                        value="getGeneralViews/{className}/{limit}/{sessionId}",
                        produces="application/json")
        List<ViewObjectLight> getGeneralViews​(@NotNull @Valid @PathVariable(value="className",required=true)
                                              @NotNull @Valid String className,
                                              @NotNull @Valid @PathVariable(value="limit",required=true)
                                              @javax.validation.constraints.NotNull,@javax.validation.Valid int limit,
                                              @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                              @NotNull @Valid String sessionId)
      • getGeneralView

        @RequestMapping(method=GET,
                        value="getGeneralView/{viewId}/{sessionId}",
                        produces="application/json")
        ViewObject getGeneralView​(@NotNull @Valid @PathVariable(value="viewId",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)
      • createObjectRelatedView

        @RequestMapping(method=POST,
                        value="createObjectRelatedView/{objectId}/{className}/{name}/{description}/{viewClassName}/{structure}/{background}/{sessionId}",
                        produces="application/json")
        long createObjectRelatedView​(@NotNull @Valid @PathVariable(value="objectId",required=true)
                                     @NotNull @Valid String objectId,
                                     @NotNull @Valid @PathVariable(value="className",required=true)
                                     @NotNull @Valid String className,
                                     @NotNull @Valid @PathVariable(value="name",required=true)
                                     @NotNull @Valid String name,
                                     @NotNull @Valid @PathVariable(value="description",required=true)
                                     @NotNull @Valid String description,
                                     @NotNull @Valid @PathVariable(value="viewClassName",required=true)
                                     @NotNull @Valid String viewClassName,
                                     @NotNull @Valid @PathVariable(value="structure",required=true)
                                     @NotNull @Valid String structure,
                                     @Valid @PathVariable(value="background",required=true)
                                     @Valid String background,
                                     @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                     @NotNull @Valid String sessionId)
      • createGeneralView

        @RequestMapping(method=POST,
                        value="createGeneralView/{className}/{name}/{description}/{structure}/{background}/{sessionId}",
                        produces="application/json")
        long createGeneralView​(@NotNull @Valid @PathVariable(value="className",required=true)
                               @NotNull @Valid String className,
                               @NotNull @Valid @PathVariable(value="name",required=true)
                               @NotNull @Valid String name,
                               @NotNull @Valid @PathVariable(value="description",required=true)
                               @NotNull @Valid String description,
                               @NotNull @Valid @PathVariable(value="structure",required=true)
                               @NotNull @Valid String structure,
                               @Valid @PathVariable(value="background",required=true)
                               @Valid String background,
                               @NotNull @Valid @PathVariable(value="sessionId",required=true)
                               @NotNull @Valid String sessionId)
      • updateObjectRelatedView

        @RequestMapping(method=PUT,
                        value="updateObjectRelatedView/{objectId}/{className}/{viewId}/{name}/{description}/{structure}/{background}/{sessionId}",
                        produces="application/json")
        ChangeDescriptor updateObjectRelatedView​(@NotNull @Valid @PathVariable(value="objectId",required=true)
                                                 @NotNull @Valid String objectId,
                                                 @NotNull @Valid @PathVariable(value="className",required=true)
                                                 @NotNull @Valid String className,
                                                 @NotNull @Valid @PathVariable(value="viewId",required=true)
                                                 @javax.validation.constraints.NotNull,@javax.validation.Valid long viewId,
                                                 @NotNull @Valid @PathVariable(value="name",required=true)
                                                 @NotNull @Valid String name,
                                                 @NotNull @Valid @PathVariable(value="description",required=true)
                                                 @NotNull @Valid String description,
                                                 @NotNull @Valid @PathVariable(value="structure",required=true)
                                                 @NotNull @Valid String structure,
                                                 @Valid @PathVariable(value="background",required=true)
                                                 @Valid String background,
                                                 @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                 @NotNull @Valid String sessionId)
      • updateGeneralView

        @RequestMapping(method=PUT,
                        value="updateGeneralView/{id}/{name}/{description}/{structure}/{background}/{sessionId}",
                        produces="application/json")
        ChangeDescriptor updateGeneralView​(@NotNull @Valid @PathVariable(value="id",required=true)
                                           @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                           @NotNull @Valid @PathVariable(value="name",required=true)
                                           @NotNull @Valid String name,
                                           @NotNull @Valid @PathVariable(value="description",required=true)
                                           @NotNull @Valid String description,
                                           @NotNull @Valid @PathVariable(value="structure",required=true)
                                           @NotNull @Valid String structure,
                                           @Valid @PathVariable(value="background",required=true)
                                           @Valid String background,
                                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                           @NotNull @Valid String sessionId)
      • deleteGeneralViews

        @RequestMapping(method=DELETE,
                        value="deleteGeneralViews/{ids}/{sessionId}",
                        produces="application/json")
        void deleteGeneralViews​(@NotNull @Valid @PathVariable(value="ids",required=true)
                                @NotNull @Valid List<Long> ids,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)
      • attachFileToListTypeItem

        @RequestMapping(method=PUT,
                        value="attachFileToListTypeItem/{name}/{tags}/{file}/{listTypeItemClassName}/{listTypeItemId}/{sessionId}",
                        produces="application/json")
        long attachFileToListTypeItem​(@NotNull @Valid @PathVariable(value="name",required=true)
                                      @NotNull @Valid String name,
                                      @NotNull @Valid @PathVariable(value="tags",required=true)
                                      @NotNull @Valid String tags,
                                      @NotNull @Valid @PathVariable(value="file",required=true)
                                      @NotNull @Valid String file,
                                      @NotNull @Valid @PathVariable(value="listTypeItemClassName",required=true)
                                      @NotNull @Valid String listTypeItemClassName,
                                      @NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                      @NotNull @Valid String listTypeItemId,
                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                      @NotNull @Valid String sessionId)
      • getFilesForListTypeItem

        @RequestMapping(method=GET,
                        value="getFilesForListTypeItem/{className}/{objectId}/{sessionId}",
                        produces="application/json")
        List<FileObjectLight> getFilesForListTypeItem​(@NotNull @Valid @PathVariable(value="className",required=true)
                                                      @NotNull @Valid String className,
                                                      @NotNull @Valid @PathVariable(value="objectId",required=true)
                                                      @NotNull @Valid String objectId,
                                                      @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                                      @NotNull @Valid String sessionId)
      • getFile

        @RequestMapping(method=GET,
                        value="getFile/{id}/{className}/{objectId}/{sessionId}",
                        produces="application/json")
        FileObject getFile​(@NotNull @Valid @PathVariable(value="id",required=true)
                           @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                           @NotNull @Valid @PathVariable(value="className",required=true)
                           @NotNull @Valid String className,
                           @NotNull @Valid @PathVariable(value="objectId",required=true)
                           @NotNull @Valid String objectId,
                           @NotNull @Valid @PathVariable(value="sessionId",required=true)
                           @NotNull @Valid String sessionId)
      • detachFileFromListTypeItem

        @RequestMapping(method=PUT,
                        value="detachFileFromListTypeItem/{id}/{className}/{objectId}/{sessionId}",
                        produces="application/json")
        void detachFileFromListTypeItem​(@NotNull @Valid @PathVariable(value="id",required=true)
                                        @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                        @NotNull @Valid @PathVariable(value="className",required=true)
                                        @NotNull @Valid String className,
                                        @NotNull @Valid @PathVariable(value="objectId",required=true)
                                        @NotNull @Valid String objectId,
                                        @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                        @NotNull @Valid String sessionId)
      • updateFileProperties

        @RequestMapping(method=PUT,
                        value="updateFileProperties/{id}/{className}/{listTypeItemId}/{sessionId}",
                        produces="application/json")
        void updateFileProperties​(@NotNull @Valid @PathVariable(value="id",required=true)
                                  @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                  @NotNull @RequestBody
                                  @NotNull List<StringPair> properties,
                                  @NotNull @Valid @PathVariable(value="className",required=true)
                                  @NotNull @Valid String className,
                                  @NotNull @Valid @PathVariable(value="listTypeItemId",required=true)
                                  @NotNull @Valid String listTypeItemId,
                                  @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                  @NotNull @Valid String sessionId)
      • createBusinessRule

        @RequestMapping(method=POST,
                        value="createBusinessRule/{name}/{description}/{type}/{scope}/{appliesTo}/{version}/{constraints}/{sessionId}",
                        produces="application/json")
        long createBusinessRule​(@NotNull @Valid @PathVariable(value="name",required=true)
                                @NotNull @Valid String name,
                                @NotNull @Valid @PathVariable(value="description",required=true)
                                @NotNull @Valid String description,
                                @NotNull @Valid @PathVariable(value="type",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                                @NotNull @Valid @PathVariable(value="scope",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid int scope,
                                @NotNull @Valid @PathVariable(value="appliesTo",required=true)
                                @NotNull @Valid String appliesTo,
                                @NotNull @Valid @PathVariable(value="version",required=true)
                                @NotNull @Valid String version,
                                @NotNull @Valid @PathVariable(value="constraints",required=true)
                                @NotNull @Valid List<String> constraints,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)
      • deleteBusinessRule

        @RequestMapping(method=DELETE,
                        value="deleteBusinessRule/{id}/{sessionId}",
                        produces="application/json")
        void deleteBusinessRule​(@NotNull @Valid @PathVariable(value="id",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid long id,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)
      • getBusinessRules

        @RequestMapping(method=GET,
                        value="getBusinessRules/{type}/{sessionId}",
                        produces="application/json")
        List<BusinessRule> getBusinessRules​(@NotNull @Valid @PathVariable(value="type",required=true)
                                            @javax.validation.constraints.NotNull,@javax.validation.Valid int type,
                                            @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                            @NotNull @Valid String sessionId)
      • getClassHierachy

        @RequestMapping(method=GET,
                        value="getClassHierachy/{showAll}/{sessionId}",
                        produces="application/json")
        byte[] getClassHierachy​(@NotNull @Valid @PathVariable(value="showAll",required=true)
                                @javax.validation.constraints.NotNull,@javax.validation.Valid boolean showAll,
                                @NotNull @Valid @PathVariable(value="sessionId",required=true)
                                @NotNull @Valid String sessionId)