Package io.jmix.rest.impl.controller

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 Summary

Fields

Modifier and Type	Field	Description
protected EntitiesControllerManager	entitiesControllerManager

Constructor Summary

Constructors

Constructor	Description
EntitiesController()

Method Summary

Modifier and Type	Method	Description
String	countSearchEntitiesListGet(String entityName, String filter, String modelVersion)
String	countSearchEntitiesListPost(String entityName, String requestBodyJson)
org.springframework.http.ResponseEntity<String>	createEntity(String entityJson, String entityName, String responseView, String responseFetchPlan, String modelVersion, jakarta.servlet.http.HttpServletRequest request)
org.springframework.http.ResponseEntity<?>	deleteEntities(String entitiesIdJson, String entityName, String modelVersion)
org.springframework.http.ResponseEntity<?>	deleteEntity(String entityName, String entityId, String modelVersion)
org.springframework.http.ResponseEntity<String>	loadEntitiesList(String entityName, String view, String fetchPlan, Integer limit, Integer offset, String sort, Boolean returnNulls, Boolean returnCount, Boolean dynamicAttributes, String modelVersion)
String	loadEntity(String entityName, String entityId, String view, String fetchPlan, Boolean returnNulls, Boolean dynamicAttributes, String modelVersion)
org.springframework.http.ResponseEntity<String>	searchEntitiesListGet(String entityName, String filter, String view, String fetchPlan, Integer limit, Integer offset, String sort, Boolean returnNulls, Boolean returnCount, Boolean dynamicAttributes, String modelVersion)
org.springframework.http.ResponseEntity<String>	searchEntitiesListPost(String entityName, String requestBodyJson)
String	updateEntities(String entitiesJson, String entityName, String responseView, String responseFetchPlan, String modelVersion)
String	updateEntity(String entityJson, String entityName, String entityId, String responseView, String responseFetchPlan, String modelVersion)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

entitiesControllerManager

@Autowired
protected EntitiesControllerManager entitiesControllerManager

Constructor Details

EntitiesController

public EntitiesController()

Method Details

loadEntity

@GetMapping("/{entityName}/{entityId}")
public String loadEntity(@PathVariable
 String entityName,
 @PathVariable
 String entityId,
 @RequestParam(required=false)
 String view,
 @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 view,
 @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 view,
 @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)