1. Overview
These services create and manage customizations targeted at specific users and can integrate personalization with other systems.
1.1. Version information
Version : 1.0.0
1.2. License information
License : Use of this file is subject to the terms of your agreement with SAP SE or its affiliates respecting the use of the SAP product for which this file relates.
Terms of service : null
1.3. URI scheme
Host : localhost:9001
BasePath : /personalizationwebservices
1.4. Tags
-
Actions : Operations for actions in variations
-
CustomerSegmentations : Operations for customer and segment relation
-
CustomizationPackages : Operations for customization with related objects
-
Customizations : Operations for customizations
-
Query : Query operations
-
Segments : Operations for segments
-
Triggers : Operations for triggers
-
Variations : Operations for variations in customization
1.5. Produces
-
application/xml
-
application/json
2. Paths
2.1. Gets list of actions that fulfill search criteria with information about variation and customization
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/actions
2.1.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Query |
actionCode |
Customization code. Supported by CXCMSACTION type. |
string |
Query |
catalogs |
Filter for action catalog. Supported by CXCMSACTION type. |
enum (CURRENT, PARENTS, ALL) |
Query |
componentCatalog |
Catalog of the action component. Supported by CXCMSACTION type. |
string |
Query |
componentId |
Id of the component used by the action. Supported by CXCMSACTION type. |
string |
Query |
containerId |
Id of the container used by the action. Supported by CXCMSACTION type. |
string |
Query |
currentPage |
Current page number |
integer (int32) |
Query |
customizationCode |
Customization code. Supported by CXCMSACTION type. |
string |
Query |
customizationName |
Customization name. Supported by CXCMSACTION type. |
string |
Query |
customizationStatus |
Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
Query |
needsTotal |
Request total count |
boolean |
Query |
pageCatalogId |
Catalog of the page action is affecting. Ignored if pageId is not provided. Supported by CXCMSACTION type. |
string |
Query |
pageId |
Id of the page affected by the action. Supported by CXCMSACTION type. |
string |
Query |
pageSize |
Page size |
integer (int32) |
Query |
type |
Type of action. CXCMSACTION requires personalizationcms extension. |
enum (CXCMSACTION) |
Query |
variationCode |
Variation code. Supported by CXCMSACTION type. |
string |
Query |
variationName |
Variation name. Supported by CXCMSACTION type. |
string |
Query |
variationStatus |
Comma separated variation statuses. Available statuses : ENABLED, DISABLED, DELETED. Supported by CXCMSACTION type. |
string |
2.1.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog with given id doesn’t exist |
No Content |
2.1.3. Tags
-
Actions
2.1.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.2. Creates customization with related objects like variations and triggers
POST /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages
2.2.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Body |
customization |
Customization with related objects |
2.2.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog with given id doesn’t exist |
No Content |
409 |
Conflict - customization with given code already exists |
No Content |
2.2.3. Consumes
-
application/xml
-
application/json
2.2.4. Tags
-
CustomizationPackages
2.2.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.3. Updates customization and related objects
PUT /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizationpackages/{customizationCode}
2.3.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Body |
customization |
Customization data for update |
2.3.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
409 |
Conflict - customization code in request body and url do not match |
No Content |
2.3.3. Consumes
-
application/xml
-
application/json
2.3.4. Tags
-
CustomizationPackages
2.3.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.4. Creates a customization
POST /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations
2.4.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Body |
customization |
Customization to create |
2.4.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog with given id doesn’t exist |
No Content |
409 |
Conflict - customization with given code already exists |
No Content |
2.4.3. Consumes
-
application/xml
-
application/json
2.4.4. Tags
-
Customizations
2.4.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.5. Returns all customizations
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations
2.5.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Query |
catalogs |
Filter for customization catalog. Requires personalizationcms extension. |
enum (CURRENT, PARENTS, ALL) |
Query |
code |
Filter for customization identifier. This filter don’t work together with other filters (pageId, statuses, name) |
string |
Query |
currentPage |
Current page number |
integer (int32) |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
Query |
name |
Filter for customization name. This require also 'statuses' parameter to be set |
string |
Query |
needsTotal |
Request total count |
boolean |
Query |
negatePageId |
Flag to return customizations not related to page with 'pageId'. Requires personalizationcms extension. |
boolean |
Query |
pageCatalogId |
Page catalog identifier. Requires personalizationcms extension. |
string |
Query |
pageId |
Page identifier. This require also 'statuses' parameter to be set. Requires personalizationcms extension. |
string |
Query |
pageSize |
Page size |
integer (int32) |
Query |
statuses |
Comma separated customization statuses. Available statuses : ENABLED, DISABLED, DELETED |
string |
2.5.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog version not found (catalogId : {catalogId} catalogVersionId : {catalogVersionId}) |
No Content |
2.5.3. Tags
-
Customizations
2.5.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.6. Get a customization
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}
2.6.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.6.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
2.6.3. Tags
-
Customizations
2.6.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.7. Updates a customization
PUT /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}
2.7.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Body |
customization |
Customization data for update |
2.7.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
409 |
Conflict - customization code in request body and url do not match |
No Content |
2.7.3. Consumes
-
application/xml
-
application/json
2.7.4. Tags
-
Customizations
2.7.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.8. Deletes a customization
DELETE /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}
2.8.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
2.8.2. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
2.8.3. Tags
-
Customizations
2.8.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.9. Creates a new variations part of a given customization
POST /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations
2.9.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Body |
variation |
Variation data to create |
2.9.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
409 |
Conflict - variation with given code already exists |
No Content |
2.9.3. Consumes
-
application/xml
-
application/json
2.9.4. Tags
-
Variations
2.9.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.10. Returns all variations for a given customization
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations
2.10.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.10.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog or customization with given id doesn’t exist |
No Content |
2.10.3. Tags
-
Variations
2.10.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.11. Returns an existing variation
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}
2.11.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.11.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
2.11.3. Tags
-
Variations
2.11.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.12. Updates an existing variation
PUT /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}
2.12.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
variation |
Variation data for update |
2.12.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
409 |
Conflict - variation code in request body and url do not match |
No Content |
2.12.3. Consumes
-
application/xml
-
application/json
2.12.4. Tags
-
Variations
2.12.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.13. Delete an existing variation
DELETE /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}
2.13.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
2.13.2. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
2.13.3. Tags
-
Variations
2.13.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.14. Creates an action
POST /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions
2.14.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
action |
Action to create |
2.14.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
409 |
Conflict - action with given code already exists |
No Content |
2.14.3. Consumes
-
application/xml
-
application/json
2.14.4. Tags
-
Actions
2.14.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.15. Returns all actions for a given customization and variation
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions
2.15.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.15.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
2.15.3. Tags
-
Actions
2.15.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.16. Deletes a set of actions in given variation and customization
DELETE /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions
2.16.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
actionCodes |
Identifiers of actions to delete e.g. ["id1","id2"] for application/json content type |
< string > array |
2.16.2. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request e.g. incorrect request body data |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
2.16.3. Tags
-
Actions
2.16.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.17. Creates set of actions in given variation and customization
PATCH /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions
2.17.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
actionList |
Actions to create |
2.17.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
409 |
Conflict - action with given code already exists |
No Content |
2.17.3. Consumes
-
application/xml
-
application/json
2.17.4. Tags
-
Actions
2.17.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.18. Get an existing action for a given customization and variation
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}
2.18.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
actionCode |
Action identifier |
string |
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.18.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or action with given id doesn’t exist |
No Content |
2.18.3. Tags
-
Actions
2.18.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.19. Updates an existing action for a given customization and variation
PUT /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}
2.19.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
actionCode |
Action identifier |
string |
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
action |
Action data to update |
2.19.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or action with given id doesn’t exist |
No Content |
409 |
Conflict - action code in request body and url do not match |
No Content |
2.19.3. Consumes
-
application/xml
-
application/json
2.19.4. Tags
-
Actions
2.19.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.20. Deletes an existing action for a given customization and variation
DELETE /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/actions/{actionCode}
2.20.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
actionCode |
Action identifier |
string |
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
2.20.2. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or action with given id doesn’t exist |
No Content |
2.20.3. Tags
-
Actions
2.20.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.21. Create a trigger for a given variation
POST /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers
2.21.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
data |
Trigger to create |
2.21.2. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
409 |
Conflict - trigger with given code already exists |
No Content |
2.21.3. Consumes
-
application/xml
-
application/json
2.21.4. Tags
-
Triggers
2.21.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.22. Get triggers for a given variation
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers
2.22.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.22.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization or variation with given id doesn’t exist |
No Content |
2.22.3. Tags
-
Triggers
2.22.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.23. Get a specific trigger
GET /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}
2.23.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
triggerCode |
Trigger identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.23.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or trigger with given id doesn’t exist |
No Content |
2.23.3. Tags
-
Triggers
2.23.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.24. Updates a trigger
PUT /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}
2.24.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
triggerCode |
Trigger identifier |
string |
Path |
variationCode |
Variation identifier |
string |
Body |
data |
Trigger data for update |
2.24.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or trigger with given id doesn’t exist |
No Content |
409 |
Conflict - trigger code in request body and url do not match |
No Content |
2.24.3. Consumes
-
application/xml
-
application/json
2.24.4. Tags
-
Triggers
2.24.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.25. Deletes a trigger
DELETE /v1/catalogs/{catalog}/catalogVersions/{catalogVersion}/customizations/{customizationCode}/variations/{variationCode}/triggers/{triggerCode}
2.25.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
catalog |
Catalog identifier |
string |
Path |
catalogVersion |
Catalog version identifier |
string |
Path |
customizationCode |
Customization identifier |
string |
Path |
triggerCode |
Trigger identifier |
string |
Path |
variationCode |
Variation identifier |
string |
2.25.2. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method or catalog with given id |
No Content |
404 |
Catalog, customization, variation or trigger with given id doesn’t exist |
No Content |
2.25.3. Tags
-
Triggers
2.25.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.26. Creates a customer segmentation
POST /v1/customersegmentations
2.26.1. Description
This endpoint creates a relation between customer and segment. In default security configuration this endpoint is forbidden
2.26.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
customerSegmentation |
DTO object which contains customer and segment identifiers |
2.26.3. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Customer, segment or basesite with given id doesn’t exist |
No Content |
409 |
Conflict - relation between customer and segment already exists |
No Content |
2.26.4. Consumes
-
application/xml
-
application/json
2.26.5. Tags
-
CustomerSegmentations
2.26.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.27. Returns customer segmentations
GET /v1/customersegmentations
2.27.1. Description
This endpoint returns list segmententations matching customer id and segment id passed as parameters. In default security configuration this endpoint is forbidden
2.27.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
baseSite |
Basesite identifier |
string |
Query |
currentPage |
Current page number |
integer (int32) |
Query |
customerId |
Customer identifier. At least one of parameters is required : customerId, segmentId |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
Query |
needsTotal |
Request total count |
boolean |
Query |
pageSize |
Page size |
integer (int32) |
Query |
segmentId |
Segment identifier. At least one of parameters is required : customerId, segmentId |
string |
2.27.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
2.27.4. Tags
-
CustomerSegmentations
2.27.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.28. Get a customer segmentation
GET /v1/customersegmentations/{segmentationId}
2.28.1. Description
This endpoint returns a relation between a customer and a segment. In default security configuration this endpoint is forbidden
2.28.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentationId |
Relation identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.28.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect identifier or parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Relation between customer and segment doesn’t exist |
No Content |
2.28.4. Tags
-
CustomerSegmentations
2.28.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.29. Updates a customer segmentation
PUT /v1/customersegmentations/{segmentationId}
2.29.1. Description
This endpoint updates a relation between a customer and segment. In default security configuration this endpoint is forbidden
2.29.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentationId |
Relation identifier |
string |
Body |
data |
DTO object which contains customer and segment identifiers |
2.29.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect identifier |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Relation between customer and segment doesn’t exist |
No Content |
409 |
Conflict - CustomerSegmentation code in request body and url do not match. |
No Content |
2.29.4. Consumes
-
application/xml
-
application/json
2.29.5. Tags
-
CustomerSegmentations
2.29.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.30. Deletes a customer segmentation
DELETE /v1/customersegmentations/{segmentationId}
2.30.1. Description
This endpoint deletes a relation between a customer and segment. In default security configuration this endpoint is forbidden
2.30.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentationId |
segmentationId |
string |
2.30.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request e.g. incorrect identifier |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Relation between customer and segment doesn’t exist |
No Content |
2.30.4. Tags
-
CustomerSegmentations
2.30.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.31. Executes a query with given parameters.
POST /v1/query/{name}
2.31.1. Description
The available queries depend on which extensions are included in your installation. Examples : cxpromotionsforcatalog, cxReplaceComponentWithContainer, etc…
2.31.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
name |
Query name |
string |
Body |
params |
Parameter for query |
2.31.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
object |
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Query with given name doesn’t exist |
No Content |
2.31.4. Consumes
-
application/json
2.31.5. Tags
-
Query
2.31.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.32. Creates segment
POST /v1/segments
2.32.1. Description
In default security configuration this endpoint is forbidden
2.32.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Body |
segment |
Segment to create |
2.32.3. Responses
HTTP Code | Description | Schema |
---|---|---|
201 |
Created |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
409 |
Conflict - segment with given code already exists |
No Content |
2.32.4. Consumes
-
application/xml
-
application/json
2.32.5. Tags
-
Segments
2.32.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.33. Get all the segments
GET /v1/segments
2.33.1. Description
Endpoint returns all segments from the system
2.33.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Query |
code |
Filter for segment identifier |
string |
Query |
currentPage |
Current page number |
integer (int32) |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
Query |
needsTotal |
Request total count |
boolean |
Query |
pageSize |
Page size |
integer (int32) |
2.33.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
2.33.4. Tags
-
Segments
2.33.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.34. Get a segment
GET /v1/segments/{segmentCode}
2.34.1. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentCode |
Segment identifier |
string |
Query |
fields |
Response configuration (list of fields, which should be returned in response) |
string |
2.34.2. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect parameter value |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Segment with given id doesn’t exist |
No Content |
2.34.3. Tags
-
Segments
2.34.4. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.35. Updates a segment
PUT /v1/segments/{segmentCode}
2.35.1. Description
In default security configuration this endpoint is forbidden
2.35.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentCode |
Segment identifier |
string |
Body |
segment |
Segment data to update |
2.35.3. Responses
HTTP Code | Description | Schema |
---|---|---|
200 |
OK |
|
400 |
Bad Request e.g. incorrect request body data, missing parameters |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Segment with given id doesn’t exist |
No Content |
409 |
Conflict - segment code in request body and url do not match |
No Content |
2.35.4. Consumes
-
application/xml
-
application/json
2.35.5. Tags
-
Segments
2.35.6. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
2.36. Deletes a segments
DELETE /v1/segments/{segmentCode}
2.36.1. Description
In default security configuration this endpoint is forbidden
2.36.2. Parameters
Type | Name | Description | Schema |
---|---|---|---|
Path |
segmentCode |
Segment identifier |
string |
2.36.3. Responses
HTTP Code | Description | Schema |
---|---|---|
204 |
No Content |
No Content |
400 |
Bad Request |
No Content |
401 |
Unauthorized |
No Content |
403 |
Forbidden. Have no access to this method |
No Content |
404 |
Segment with given id doesn’t exist |
No Content |
2.36.4. Tags
-
Segments
2.36.5. Security
Type | Name |
---|---|
oauth2 |
|
oauth2 |
3. Definitions
3.1. ActionFullList
List of actions
Name | Description | Schema |
---|---|---|
actions |
List of actions |
< action > array |
pagination |
Pagination details |
3.2. ActionList
List of actions
Name | Description | Schema |
---|---|---|
actions |
List of actions |
< action > array |
3.3. CustomerSegmentationList
List of customer segmentations
Name | Description | Schema |
---|---|---|
customerSegmentations |
List of customer segmentations |
< customerSegmentation > array |
pagination |
Pagination details |
3.4. CustomizationList
List of customizations
Name | Description | Schema |
---|---|---|
customizations |
List of customizations |
< customization > array |
pagination |
Pagination details |
3.5. QueryParams
Generic parameters for query endpoint
Name | Description | Schema |
---|---|---|
params |
Parameters map |
< string, string > map |
3.6. SegmentList
List of segments
Name | Description | Schema |
---|---|---|
pagination |
Pagination details |
|
segments |
List of segments |
< segment > array |
3.7. TriggerList
List of triggers
Name | Description | Schema |
---|---|---|
triggers |
List of customer triggers |
< trigger > array |
3.8. VariationList
List of variations
Name | Description | Schema |
---|---|---|
variations |
List of variations |
< variation > array |
3.9. action
Action
Name | Description | Schema |
---|---|---|
catalog |
Catalog name |
string |
catalogVersion |
Catalog version |
string |
code |
Action code |
string |
rank |
Priority of the action |
integer (int32) |
3.10. customer
Customer details
Name | Description | Schema |
---|---|---|
segmentLinks |
List of customer’s segmentation details |
< customerSegmentation > array |
uid |
ID of the customer |
string |
3.11. customerSegmentation
Customer segmentation
Name | Description | Schema |
---|---|---|
affinity |
Affinity of the customer to the segment |
number |
baseSite |
Basesite identifier |
string |
code |
Customer segmentation code |
string |
customer |
Details of the customer |
|
provider |
Provider identifier |
string |
segment |
Details of the segment |
3.12. customization
Customization
Name | Description | Schema |
---|---|---|
active |
Dynamic attribute describing whether the customization affects the experience |
boolean |
catalog |
Catalog name |
string |
catalogVersion |
Catalog version |
string |
code |
Customization code |
string |
description |
Customization description |
string |
enabledEndDate |
Point in time when the customization will deactivate |
string (date-time) |
enabledStartDate |
Point in time when the customization will activate, if it’s enabled |
string (date-time) |
name |
Customization name |
string |
rank |
Priority of the customization |
integer (int32) |
status |
Status of the customization |
enum (ENABLED, DISABLED, DELETED) |
variations |
Details of the variations in this customization |
< variation > array |
3.13. pagination
Pagination info
Name | Description | Schema |
---|---|---|
count |
Number of elements on this page |
integer (int32) |
hasNext |
Indicates if there is next page |
boolean |
hasPrevious |
Indicates if there is previous page |
boolean |
page |
Current page number |
integer (int32) |
totalCount |
Total number of elements |
integer (int64) |
totalPages |
Total number of pages |
integer (int32) |
3.14. segment
Segment details
Name | Description | Schema |
---|---|---|
code |
Segment code |
string |
customerLinks |
Customer segmentation details |
< customerSegmentation > array |
description |
Segment description |
string |
segmentTriggers |
Segment trigger details |
< segmentTrigger > array |
3.15. segmentTrigger
Segment trigger
Name | Description | Schema |
---|---|---|
catalog |
Catalog name |
string |
catalogVersion |
Catalog version |
string |
code |
Trigger code |
string |
groupBy |
Logical operator connecting the segments |
enum (AND, OR) |
segments |
Details of the segments |
< segment > array |
variation |
Details of the variation |
3.16. trigger
Trigger
Name | Description | Schema |
---|---|---|
catalog |
Catalog name |
string |
catalogVersion |
Catalog version |
string |
code |
Trigger code |
string |
variation |
Details of the variation |
3.17. variation
Variation
Name | Description | Schema |
---|---|---|
actions |
Details of the variation actions |
< action > array |
active |
Dynamic attribute describing whether the variation affects the experience |
boolean |
catalog |
Catalog name |
string |
catalogVersion |
Catalog version |
string |
code |
Variation code |
string |
customization |
Details of the customization the variation belongs to |
|
enabled |
This is deprecated field (use status field instead) |
boolean |
name |
Variation name |
string |
rank |
Priority of the variation |
integer (int32) |
status |
Status of the variation |
enum (ENABLED, DISABLED, DELETED) |
triggers |
Details of the variation triggers |
< trigger > array |
4. Security
4.1. oauth2_client_credentials
Type : oauth2
Flow : application
Token URL : /authorizationserver/oauth/token
Name |
---|
personalizationwebservices |
4.2. oauth2_password
Type : oauth2
Flow : password
Token URL : /authorizationserver/oauth/token
Name |
---|
personalizationwebservices |