Package de.hybris.platform.sap.productconfig.runtime.cps.client

Interface ConfigurationClientBase

All Known Subinterfaces:
ConfigurationClient
public interface ConfigurationClientBase
Specifies REST APIs for CPS calls to create, update and release a configuration runtime object

  • Method Details

    • updateConfiguration

      @PATCH @Produces("application/json") @Path("/configurations/{cfgId}/items/{itemId}/characteristics/{csticId}") rx.Observable updateConfiguration(CPSCharacteristicInput characteristicInput, @PathParam("cfgId") String cfgId, @PathParam("itemId") String itemId, @PathParam("csticId") String csticId, @HeaderParam("Cookie") String sessionCookieAsString, @HeaderParam("Cookie") String cfCookieAsString, @HeaderParam("If-Match") String eTag, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Updates a configuration runtime object
      Parameters:
      characteristicInput - Changes to a characteristic
      cfgId - ID of runtime object
      itemId - ID of item that carries the characteristics to be changed
      csticId - ID of characteristic (language independent name)
      sessionCookieAsString - Cookie identifying the session
      cfCookieAsString - Cookie identifying the node
      eTag - eTag id for optimistic locking
      sapPassport - SAP passport as string
      Returns:
      Response. The observable cannot be specified, otherwise the charon method invocation fails

    • updateConfiguration

      @PATCH @Produces("application/json") @Path("/configurations/{cfgId}/items/{itemId}/characteristics/{csticId}") rx.Observable updateConfiguration(CPSCharacteristicInput characteristicInput, @PathParam("cfgId") String cfgId, @PathParam("itemId") String itemId, @PathParam("csticId") String csticId, @HeaderParam("If-Match") String eTag, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Updates a configuration runtime object
      Parameters:
      characteristicInput - Changes to a characteristic
      cfgId - ID of runtime object
      itemId - ID of item that carries the characteristics to be changed
      csticId - ID of characteristic (language independent name)
      eTag - eTag id for optimistic locking
      sapPassport - SAP passport as string
      Returns:
      Response. The observable cannot be specified, otherwise the charon method invocation fails

    • getConfiguration

      @GET @Produces("application/json") @Path("/configurations/{cfgId}") rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> getConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("Accept-Language") String lang, @HeaderParam("Cookie") String sessionCookieAsString, @HeaderParam("Cookie") String cfCookieAsString, @HeaderParam("SAP-PASSPORT") String sapPassport, @QueryParam("$select") String select)
      Get a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      lang - language in which language-dependent fields are returned (e.g. conflict texts)
      sessionCookieAsString - Cookie identifying the session
      cfCookieAsString - Cookie identifying the node
      sapPassport - SAP passport as string
      select - filter to specify which level of detailed shall be returned. Must contain at least one or any combination of the following options subItems,characteristicGroups,variantConditions,characteristics,possibleValues,values
      Returns:
      Observable wrapping the configuration object

    • getGroup

      @GET @Produces("application/json") @Path("/configurations/{cfgId}/items/{itemId}") rx.Observable<com.hybris.charon.RawResponse<CPSItem>> getGroup(@PathParam("cfgId") String cfgId, @PathParam("itemId") String itemId, @QueryParam("$filter") String filter, @HeaderParam("Accept-Language") String lang, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Gets details for a group, including domain values
      Parameters:
      cfgId - ID of runtime object
      itemId - instance ID
      filter - group filter, contains one group
      lang - language in which language-dependent fields are returned (e.g. conflict texts)
      sapPassport - SAP passport as string
      Returns:
      Observable wrapping the configuration object

    • getGroup

      @GET @Produces("application/json") @Path("/configurations/{cfgId}/items/{itemId}") rx.Observable<com.hybris.charon.RawResponse<CPSItem>> getGroup(@PathParam("cfgId") String cfgId, @PathParam("itemId") String itemId, @QueryParam("$filter") String filter, @HeaderParam("Accept-Language") String lang, @HeaderParam("Cookie") String sessionCookieAsString, @HeaderParam("Cookie") String cfCookieAsString, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Gets details for a group, including domain values
      Parameters:
      cfgId - ID of runtime object
      itemId - instance ID
      filter - group filter, contains one group
      lang - language in which language-dependent fields are returned (e.g. conflict texts)
      sessionCookieAsString - Cookie identifying the session
      cfCookieAsString - Cookie identifying the node
      sapPassport - SAP passport as string
      Returns:
      Observable wrapping the configuration object

    • getConfiguration

      @GET @Produces("application/json") @Path("/configurations/{cfgId}") rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> getConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("Accept-Language") String lang, @HeaderParam("SAP-PASSPORT") String sapPassport, @QueryParam("$select") String select)
      Get a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      lang - language in which language-dependent fields are returned (e.g. conflict texts)
      sapPassport - SAP passport as string
      select - filter to specify which level of detailed shall be returned. Must contain at least one or any combination of the following options subItems,characteristicGroups,variantConditions,characteristics,possibleValues,values
      Returns:
      Observable wrapping the configuration object

    • createDefaultConfiguration

      @POST @Produces("application/json") @Path("/configurations") rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> createDefaultConfiguration(CPSCreateConfigInput createConfigInput, @HeaderParam("Accept-Language") String lang, @HeaderParam("SAP-PASSPORT") String sapPassport, @QueryParam("autoCleanup") String autoCleanup, @QueryParam("$select") String select)
      Create a configuration runtime object
      Parameters:
      createConfigInput - Data we need to create a default configuration. We typically only provide the product code
      lang - language in which language-dependent fields are returned (e.g. conflict texts)
      sapPassport - SAP passport as string
      autoCleanup - only if true, cleanUp of old configs will be handled by CPS Service. Typically configs will be auto deleted after a certain time. Otherwise configs are persisted forever, unless they are deleted with a delete request.
      select - filter to specify which level of detailed shall be returned. Must contain at least one or any combination of the following options subItems,characteristicGroups,variantConditions,characteristics,possibleValues,values
      Returns:
      Response wrapping the configuration object

    • getExternalConfiguration

      @GET @Produces("application/json") @Path("/externalConfigurations/{cfgId}") rx.Observable<CPSExternalConfiguration> getExternalConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("Cookie") String sessionCookieAsString, @HeaderParam("Cookie") String cfCookieAsString, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Get the external representation of a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      sessionCookieAsString - Cookie identifying the session
      cfCookieAsString - Cookie identifying the server node
      sapPassport - SAP passport as string
      Returns:
      Observable wrapping the external representation of a configuration object

    • getExternalConfiguration

      @GET @Produces("application/json") @Path("/externalConfigurations/{cfgId}") rx.Observable<CPSExternalConfiguration> getExternalConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Get the external representation of a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      sapPassport - SAP passport as string
      Returns:
      Observable wrapping the external representation of a configuration object

    • createRuntimeConfigurationFromExternal

      @POST @Produces("application/json") @Path("/externalConfigurations") rx.Observable<com.hybris.charon.RawResponse<CPSConfiguration>> createRuntimeConfigurationFromExternal(@HeaderParam("SAP-PASSPORT") String sapPassport, CPSExternalConfiguration externalConfiguration, @QueryParam("autoCleanup") String autoCleanup, @QueryParam("$select") String select)
      Create a configuration runtime object based on a external representation
      Parameters:
      sapPassport - SAP passport as string
      externalConfiguration - External representation of a configuration
      autoCleanup - only if true, cleanUp of old configs will be handled by CPS Service. Typically configs will be auto deleted after a certain time. Otherwise configs are persisted forever, unless they are deleted with a delete request.
      select - filter to specify which level of detailed shall be returned. Must contain at least one or any combination of the following options subItems,characteristicGroups,variantConditions,characteristics,possibleValues,values
      Returns:
      Response wrapping the configuration object

    • deleteConfiguration

      @DELETE @Produces("application/json") @Path("/configurations/{cfgId}") rx.Observable deleteConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("Cookie") String sessionCookieAsString, @HeaderParam("Cookie") String cfCookieAsString, @HeaderParam("If-Match") String eTag, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Release a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      sessionCookieAsString - Cookie identifying the session
      cfCookieAsString - Cookie identifying the server node
      eTag - eTag id for optimistic locking
      sapPassport - SAP passport as string
      Returns:
      Response. The observable cannot be specified, otherwise the charon method invocation fails

    • deleteConfiguration

      @DELETE @Produces("application/json") @Path("/configurations/{cfgId}") rx.Observable deleteConfiguration(@PathParam("cfgId") String cfgId, @HeaderParam("If-Match") String eTag, @HeaderParam("SAP-PASSPORT") String sapPassport)
      Release a configuration runtime object
      Parameters:
      cfgId - ID of runtime object
      eTag - eTag id for optimistic locking
      sapPassport - SAP passport as string
      Returns:
      Response. The observable cannot be specified, otherwise the charon method invocation fails