Class EntitiesController

java.lang.Object
io.jmix.rest.impl.controller.EntitiesController

@RestController("rest_EntitiesController") @RequestMapping(value="/rest/entities", produces="application/json;charset=UTF-8") public class EntitiesController extends Object
Controller that performs CRUD entity operations
  • Field Details

  • Constructor Details

    • EntitiesController

      public EntitiesController()
  • Method Details

    • loadEntity

      @GetMapping("/{entityName}/{entityId}") public String loadEntity(@PathVariable String entityName, @PathVariable String entityId, @RequestParam(required=false) String fetchPlan, @RequestParam(required=false) Boolean returnNulls, @RequestParam(required=false) Boolean dynamicAttributes, @RequestParam(required=false) String modelVersion)
    • loadEntitiesList

      @GetMapping("/{entityName}") public org.springframework.http.ResponseEntity<String> loadEntitiesList(@PathVariable String entityName, @RequestParam(required=false) String fetchPlan, @RequestParam(required=false) Integer limit, @RequestParam(required=false) Integer offset, @RequestParam(required=false) String sort, @RequestParam(required=false) Boolean returnNulls, @RequestParam(required=false) Boolean returnCount, @RequestParam(required=false) Boolean dynamicAttributes, @RequestParam(required=false) String modelVersion)
    • searchEntitiesListGet

      @GetMapping("/{entityName}/search") public org.springframework.http.ResponseEntity<String> searchEntitiesListGet(@PathVariable String entityName, @RequestParam String filter, @RequestParam(required=false) String fetchPlan, @RequestParam(required=false) Integer limit, @RequestParam(required=false) Integer offset, @RequestParam(required=false) String sort, @RequestParam(required=false) Boolean returnNulls, @RequestParam(required=false) Boolean returnCount, @RequestParam(required=false) Boolean dynamicAttributes, @RequestParam(required=false) String modelVersion)
    • countSearchEntitiesListGet

      @GetMapping("/{entityName}/search/count") public String countSearchEntitiesListGet(@PathVariable String entityName, @RequestParam String filter, @RequestParam(required=false) String modelVersion)
    • searchEntitiesListPost

      @PostMapping("/{entityName}/search") public org.springframework.http.ResponseEntity<String> searchEntitiesListPost(@PathVariable String entityName, @RequestBody String requestBodyJson)
    • countSearchEntitiesListPost

      @PostMapping("/{entityName}/search/count") public String countSearchEntitiesListPost(@PathVariable String entityName, @RequestBody String requestBodyJson)
    • createEntity

      @PostMapping("/{entityName}") public org.springframework.http.ResponseEntity<String> createEntity(@RequestBody String entityJson, @PathVariable String entityName, @RequestParam(required=false) String responseView, @RequestParam(required=false) String responseFetchPlan, @RequestParam(required=false) String modelVersion, jakarta.servlet.http.HttpServletRequest request)
    • updateEntity

      @PutMapping("/{entityName}/{entityId}") public String updateEntity(@RequestBody String entityJson, @PathVariable String entityName, @PathVariable String entityId, @RequestParam(required=false) String responseView, @RequestParam(required=false) String responseFetchPlan, @RequestParam(required=false) String modelVersion)
    • updateEntities

      @PutMapping("/{entityName}") public String updateEntities(@RequestBody String entitiesJson, @PathVariable String entityName, @RequestParam(required=false) String responseView, @RequestParam(required=false) String responseFetchPlan, @RequestParam(required=false) String modelVersion)
    • deleteEntity

      @DeleteMapping(path="/{entityName}/{entityId}") public org.springframework.http.ResponseEntity<?> deleteEntity(@PathVariable String entityName, @PathVariable String entityId, @RequestParam(required=false) String modelVersion)
    • deleteEntities

      @DeleteMapping("/{entityName}") public org.springframework.http.ResponseEntity<?> deleteEntities(@RequestBody String entitiesIdJson, @PathVariable String entityName, @RequestParam(required=false) String modelVersion)