updateRecommendationStrategy
put
/ccadmin/v1/recommendationStrategies/{id}
This operation is used to update a Strategy in Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Strategy id.
Root Schema : updateRecommendationStrategy_request
Type:
Show Source
object
-
description(optional):
string
The Strategy's description.
-
displayName(optional):
string
The localized display name of the Strategy.
-
id(optional):
string
The ID of the Strategy
-
recommendationGroups(optional):
array recommendationGroups
The array of Recommendation Groups for the Strategy.
Nested Schema : recommendationGroups
Type:
array
The array of Recommendation Groups for the Strategy.
Show Source
Nested Schema : items
Type:
Show Source
object
-
conditions(optional):
array conditions
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
-
numRecs(optional):
integer
The number of recommendations to display from this set of Conditions.
Nested Schema : conditions
Type:
array
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
Show Source
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : updateRecommendationStrategy_response
Type:
Show Source
object
-
description(optional):
string
The Strategy's description.
-
displayName(optional):
string
The localized display name of the Strategy.
-
id(optional):
string
The ID of the Strategy
-
recommendationGroups(optional):
array recommendationGroups
The array of Recommendation Groups for the Strategy.
Nested Schema : recommendationGroups
Type:
array
The array of Recommendation Groups for the Strategy.
Show Source
Nested Schema : items
Type:
Show Source
object
-
conditions(optional):
array conditions
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
-
numRecs(optional):
integer
The number of recommendations to display from this set of Conditions.
Nested Schema : conditions
Type:
array
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.
Show Source
Example Response (application/json)
{
"recommendationGroups":[
{
"numRecs":1,
"conditions":[
{
"id":"specifiedCollection",
"collectionId":"Shirts"
},
{
"lowValue":50,
"highValue":100,
"currency":"en_US",
"id":"priceRange"
}
]
},
{
"numRecs":2,
"conditions":[
{
"id":"specifiedCollection",
"collectionId":"Pants"
}
]
}
],
"displayName":"One Mid-Range Shirt and Two Pants",
"description":"This is a description of oneMidRangeShirtAndTwoPants",
"id":"oneMidRangeShirtAndTwoPants"
}
412 Response
ETag mismatch. Asset has been updated by another user.
Default Response
The error response.
The following are the internal error codes thrown by this API when the request processing fails in Oracle Commerce Cloud:
|Error Code|Description|
|------------------|------------------|
|52049|Missing input.|
|52018|Invalid numRecs.|
|52005|Invalid Recommendation Groups.|
|52006|Missing Strategy ID.|
|52008|Invalid Strategy ID.|
|52009|Missing Strategy displayName.|
|52010|The Strategy ID is too long.|
|52011|Duplicate Strategy ID.|
|52012|Strategy displayName is too long.|
|52013|Strategy description is too long.|
|52017|Duplicate Strategy displayName.|
|52019|Invalid Strategy Condition format.|
|52022|Invalid Recommendation Group format.|
|52023|Missing Condition ID.|
|52024|Invalid Condition ID.|
Root Schema : errorModel
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
errors(optional):
array errors
An optional list of errors if multiple errors were encountered
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code
-
type(optional):
string
The URI to the HTTP state code definition
Nested Schema : errors
Type:
array
An optional list of errors if multiple errors were encountered
Show Source
Nested Schema : items
Type:
Show Source
object
-
devMessage(optional):
string
An optional non-localized message containing technical information for developers
-
errorCode(optional):
string
The numerical code identifying the error
-
message(optional):
string
The localized message describing the error
-
moreInfo(optional):
string
An optional non-localized message with more information
-
o:errorPath(optional):
string
An optional machine readable description of where the error occurred
-
status(optional):
string
The HTTP status code