OCAPI 19.8 changes since 18.8

The following sections describe all changes made to OCAPI since version 18.8.

Resources added, modified, or removed since 18.8

Resource Name Change Http Method URL Template API Details
AbTests Changed DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
AbTests Changed PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
Alerts Added GET /alerts/descriptors Data N/A
Alerts Added GET /alerts/descriptors/{application_id} Data N/A
Alerts Added GET /alerts/descriptors/{application_id}/{application_context_path}/{message_id} Data N/A
Alerts Added PATCH /alerts/descriptors/{application_id}/{application_context_path}/{message_id}/revalidate Data N/A
Alerts Added GET /alerts/items Data N/A
Alerts Added GET /alerts/items/{application_id} Data N/A
Alerts Added DELETE /alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id} Data N/A
Alerts Added GET /alerts/items/{application_id}/{application_context_path}/{message_id}/{context_object_id} Data N/A
Alerts Added GET /alerts/usersettings Data N/A
Alerts Added PATCH /alerts/usersettings Data N/A
Campaigns Changed DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
Campaigns Changed PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id} Data More
OcapiConfigs Added DELETE /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added GET /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added POST /ocapi_configs/{clientId} Data N/A
OcapiConfigs Added PUT /ocapi_configs/{clientId} Data N/A
RoleSearch Changed POST /role_search Data More
Roles Changed DELETE /roles/{id} Data More
Roles Changed PUT /roles/{id}/users/{login} Data More
SortingRuleSearch Added POST /sites/{site_id}/sorting_rule_search Data N/A

Documents added, modified, or removed since 18.8

Document Name Change API Details
AlertDescriptor Added Data API N/A
AlertDescriptorSettings Added Data API N/A
AlertDescriptors Added Data API N/A
AlertDescriptorsRevalidationRequest Added Data API N/A
AlertItem Added Data API N/A
AlertItems Added Data API N/A
AlertSettings Added Data API N/A
CampaignSortingRuleExperience Changed Data API More
ExportDataUnitsConfiguration Added Data API N/A
ExportGlobalDataConfiguration Added Data API N/A
ExportSitesConfiguration Added Data API N/A
OcapiConfigsApiRequest Added Data API N/A
OcapiConfigsApiResponse Added Data API N/A
Order Changed Shop API More
ResourceInfo Added Data API N/A
ResourceObject Added Data API N/A
RoleSearchRequest Added Data API N/A
SiteArchiveExportConfiguration Added Data API N/A
SiteResourceInfo Added Data API N/A
SortingRule Changed Data API More
SortingRuleSearchResult Added Data API N/A
VersionRangeObject Added Data API N/A

Details about modified resources

The following requests have been modified since 18.8.

DELETE /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 19.8
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /sites/{site_id}/ab_tests/{ab_test_id}/segments/{segment_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 19.8
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

DELETE /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 19.8
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

PUT /sites/{site_id}/campaigns/{campaign_id}/sorting_rules/{sorting_rule_id}/{category_id}

Element Change API 18.8 19.8
Description Changed Data Action to bind a single sorting rule to a given campaign. Lookup of the sorting rule is done in the site Action to bind a single sorting rule to a given campaign.
Query Parameter Added Data N/A

Name: rule_context

Type: String

Description: The context in which the rule lives, either "site" or "global"the optional context of the sorting rule, either "site" (default) or "global"

Constraints: strings=["global", "site"]

POST /role_search

Element Change API 18.8 19.8
Description Changed Data Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Searches for access roles.

The query attribute specifies a complex query that can be used to narrow down the search. These are the list of searchable attributes:

  • id - String
  • description - String

Optionally, a user ID (the user login) can be specified. When it is supplied, the search for roles is limited to the roles assigned to this user. When expanding the permissions for the roles, all effective permissions for this user can be retrieved.

Optionally, a (single) permission can be specified. When it is supplied, the search for roles is limited to the roles having this permission. When expanding the users for the roles, all users having this permission can be retrieved.

The output of the query can also be sorted. These are the list of sortable attributes:

  • id - String
  • description - String
Body Changed Data SearchRequest RoleSearchRequest
Fault Added Data N/A

InvalidSearchQueryException(400): Throws when one of the search request restrictions is violated

fault (String)

DELETE /roles/{id}

Element Change API 18.8 19.8
Fault Added Data N/A

RoleNotFoundException(404): Thrown if the given role does not exist

id (String)

PUT /roles/{id}/users/{login}

Element Change API 18.8 19.8
Fault Added Data N/A

InvalidRoleException(400): Thrown if the access role with the given id does not exist.

roleId (String)

Fault Added Data N/A

InvalidUserLoginException(400): Thrown if a user with the given login does not exist.

login (String)

Fault Removed Data

RoleNotFoundException(404): Thrown if the access role with the given id does not exist.

id (String)

N/A
Fault Removed Data

UserNotFoundException(404): Thrown if a user with the given login does not exist.

login (String)

N/A

Details about modified documents

The following documents have been modified since 18.8.

CampaignSortingRuleExperience

Element Change API 18.8 19.8
Property Changed Data

Name: rule_context

Constraints: strings=["site", "global"]

Name: rule_context

Constraints: strings=["site", "global"]

Order

Element Change API 18.8 19.8
Property Added Shop N/A

Name: global_party_id

Type: String

Description: globalPartyId is managed by Customer 360. Its value can be changed.

Constraints:

SortingRule

Element Change API 18.8 19.8
Property Added Data N/A

Name: rule_context

Type: String

Description: The context of the rule, either site or global

Constraints: