Class DigitalObjectsAPIController
java.lang.Object
de.digitalcollections.commons.springmvc.controller.AbstractController
de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController
de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController<I>
de.digitalcollections.cudami.admin.controller.identifiable.AbstractIdentifiablesController<E,C>
de.digitalcollections.cudami.admin.controller.identifiable.entity.AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject,CudamiDigitalObjectsClient>
de.digitalcollections.cudami.admin.controller.identifiable.entity.DigitalObjectsAPIController
@RestController
public class DigitalObjectsAPIController
extends AbstractEntitiesController<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject,CudamiDigitalObjectsClient>
Controller for all public "DigitalObjects" endpoints (API).
-
Field Summary
Fields inherited from class de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController
service
Fields inherited from class de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController
languageService
-
Constructor Summary
ConstructorDescriptionDigitalObjectsAPIController
(CudamiClient client, LanguageService languageService) -
Method Summary
Modifier and TypeMethodDescriptionBTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>
find
(int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>
find
(int pageNumber, int pageSize, String searchField, String searchTerm, List<de.digitalcollections.model.list.sorting.Order> sortBy) BTResponse<de.digitalcollections.model.identifiable.entity.Collection>
findAssociatedCollections
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) BTResponse<de.digitalcollections.model.identifiable.entity.Project>
findAssociatedProjects
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) BTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject>
findContainedDigitalObjects
(UUID uuid, int offset, int limit, String searchTerm, String sortProperty, String sortOrder, String dataLanguage) de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject
getByIdentifier
(String namespace, String id) de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject
getByRefId
(long refId) de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject
Methods inherited from class de.digitalcollections.cudami.admin.controller.identifiable.entity.AbstractEntitiesController
search
Methods inherited from class de.digitalcollections.cudami.admin.controller.identifiable.AbstractIdentifiablesController
doForward, getExistingLanguagesFromIdentifiable, getExistingLanguagesFromIdentifiables, getExistingLanguagesFromService
Methods inherited from class de.digitalcollections.cudami.admin.controller.AbstractUniqueObjectController
find
Methods inherited from class de.digitalcollections.cudami.admin.controller.AbstractPagingAndSortingController
createBTRequest, createPageRequest, createPageRequest, getDataLanguage, getDataLanguage, getFieldType
Methods inherited from class de.digitalcollections.commons.springmvc.controller.AbstractController
verifyBinding
-
Constructor Details
-
DigitalObjectsAPIController
-
-
Method Details
-
find
@GetMapping("/api/digitalobjects/search") @ResponseBody public de.digitalcollections.model.list.paging.PageResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> find(@RequestParam(name="pageNumber",required=false,defaultValue="0") int pageNumber, @RequestParam(name="pageSize",required=false,defaultValue="5") int pageSize, @RequestParam(name="searchField",required=false) String searchField, @RequestParam(name="searchTerm",required=false) String searchTerm, @RequestParam(name="sortBy",required=false) List<de.digitalcollections.model.list.sorting.Order> sortBy) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
find
@GetMapping("/api/digitalobjects") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> find(@RequestParam(name="offset",required=false,defaultValue="0") int offset, @RequestParam(name="limit",required=false,defaultValue="10") int limit, @RequestParam(name="search",required=false) String searchTerm, @RequestParam(name="sort",required=false,defaultValue="label") String sortProperty, @RequestParam(name="order",required=false,defaultValue="asc") String sortOrder, @RequestParam(name="dataLanguage",required=false) String dataLanguage) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
findAssociatedCollections
@GetMapping(value="/api/digitalobjects/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}/collections", produces="application/json") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.Collection> findAssociatedCollections(@PathVariable UUID uuid, @RequestParam(name="offset",required=false,defaultValue="0") int offset, @RequestParam(name="limit",required=false,defaultValue="10") int limit, @RequestParam(name="search",required=false) String searchTerm, @RequestParam(name="sort",required=false,defaultValue="label") String sortProperty, @RequestParam(name="order",required=false,defaultValue="asc") String sortOrder, @RequestParam(name="dataLanguage",required=false) String dataLanguage) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
findAssociatedProjects
@GetMapping(value="/api/digitalobjects/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}/projects", produces="application/json") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.Project> findAssociatedProjects(@PathVariable UUID uuid, @RequestParam(name="offset",required=false,defaultValue="0") int offset, @RequestParam(name="limit",required=false,defaultValue="10") int limit, @RequestParam(name="search",required=false) String searchTerm, @RequestParam(name="sort",required=false,defaultValue="label") String sortProperty, @RequestParam(name="order",required=false,defaultValue="asc") String sortOrder, @RequestParam(name="dataLanguage",required=false) String dataLanguage) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
findContainedDigitalObjects
@GetMapping("/api/digitalobjects/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}/digitalobjects") @ResponseBody public BTResponse<de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject> findContainedDigitalObjects(@PathVariable UUID uuid, @RequestParam(name="offset",required=false,defaultValue="0") int offset, @RequestParam(name="limit",required=false,defaultValue="10") int limit, @RequestParam(name="search",required=false) String searchTerm, @RequestParam(name="sort",required=false,defaultValue="label") String sortProperty, @RequestParam(name="order",required=false,defaultValue="asc") String sortOrder, @RequestParam(name="dataLanguage",required=false) String dataLanguage) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
getByIdentifier
@GetMapping("/api/digitalobjects/identifier/{namespace}:{id}") @ResponseBody public de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject getByIdentifier(@PathVariable String namespace, @PathVariable String id) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
getByRefId
@GetMapping("/api/digitalobjects/{refId:[0-9]+}") @ResponseBody public de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject getByRefId(@PathVariable long refId) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-
getByUuid
@GetMapping("/api/digitalobjects/{uuid:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$}") @ResponseBody public de.digitalcollections.model.identifiable.entity.digitalobject.DigitalObject getByUuid(@PathVariable UUID uuid) throws de.digitalcollections.model.exception.TechnicalException - Throws:
de.digitalcollections.model.exception.TechnicalException
-