getRecommendationStrategy
get
/ccadmin/v1/recommendationStrategies/{id}
This operation is used to get a specific Recommendation Strategy from Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Strategy ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getRecommendationStrategy_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"
}
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|
|------------------|------------------|
|52008|Invalid Strategy 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