Class CustomizationController
java.lang.Object
de.hybris.platform.webservicescommons.controllers.AbstractController
de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
de.hybris.platform.personalizationwebservices.controllers.CustomizationController
Controller exposes functionality for customizations, variations and actions
-
Nested Class Summary
Nested classes/interfaces inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
AbstractController.Executor -
Field Summary
FieldsFields inherited from class de.hybris.platform.personalizationwebservices.controllers.PersonalizationAbstractController
BASE_URL, VERSIONFields inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
CATALOG_PATH -
Constructor Summary
ConstructorsConstructorDescriptionCustomizationController(CustomizationFacade cxCustomizationFacade, org.springframework.validation.Validator customizationValidator) -
Method Summary
Modifier and TypeMethodDescriptionorg.springframework.http.ResponseEntity<CustomizationData>createCustomization(String catalog, String catalogVersion, CustomizationData customization, org.springframework.web.util.UriComponentsBuilder builder) Creates customizationprotected CustomizationListWsDTOcreateListDTO(SearchPageData<CustomizationData> customizations) voiddeleteCustomization(String catalog, String catalogVersion, String customizationCode) Removes customization with given codegetCustomization(String catalog, String catalogVersion, String customizationCode) Returns customization with given codeReturns all customizationsupdateCustomization(String catalog, String catalogVersion, String customizationCode, CustomizationData customization) Updates customization with given codeprotected voidvalidateCustomization(CustomizationData customization) Methods inherited from class de.hybris.platform.webservicescommons.controllers.AbstractController
executeAndConvertException, executeAndConvertException, getBindingResult, getLocationHeader, getWebPaginationUtils, setWebPaginationUtils, validate, validate, validateInputCode, validateResponse
-
Field Details
-
CUSTOMIZATIONS
- See Also:
-
CUSTOMIZATION
- See Also:
-
-
Constructor Details
-
CustomizationController
@Autowired public CustomizationController(CustomizationFacade cxCustomizationFacade, org.springframework.validation.Validator customizationValidator)
-
-
Method Details
-
getCustomizations
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations", method=GET) public CustomizationListWsDTO getCustomizations(@PathVariable String catalog, @PathVariable String catalogVersion, @RequestParam(required=false) Map<String, String> requestParams) Returns all customizations- Returns:
- Collection of all customizations
-
createListDTO
-
createCustomization
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations", method=POST, consumes={"application/json","application/xml"}) @ResponseStatus(CREATED) public org.springframework.http.ResponseEntity<CustomizationData> createCustomization(@PathVariable String catalog, @PathVariable String catalogVersion, @RequestBody CustomizationData customization, org.springframework.web.util.UriComponentsBuilder builder) Creates customization- Returns:
- created customization
- Throws:
AlreadyExistsException- if customization with given code already existsWebserviceValidationException- if provided customization data is invalidNotFoundException- if catalog version doesn't exists
-
updateCustomization
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}", method=PUT, consumes={"application/json","application/xml"}) public CustomizationData updateCustomization(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode, @RequestBody CustomizationData customization) Updates customization with given code- Returns:
- updated customization
- Throws:
WebserviceValidationException- if provided data is invalidNotFoundException- if customization with given code does not exists
-
deleteCustomization
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}", method=DELETE) @ResponseStatus(NO_CONTENT) public void deleteCustomization(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode) Removes customization with given code- Throws:
NotFoundException- if customization with given code does not exists
-
getCustomization
@RequestMapping(value="/v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}", method=GET) public CustomizationData getCustomization(@PathVariable String catalog, @PathVariable String catalogVersion, @PathVariable String customizationCode) Returns customization with given code- Returns:
- customization with given code
- Throws:
NotFoundException- if customization with given code does not exists
-
validateCustomization
-