listRecommendationStrategies
get
/ccadmin/v1/recommendationStrategies
This operation is used to get the collection of Recommendation Strategies from Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Query Parameters
-
fields(optional): string
This controls which fields are returned in the response body. The default is to include all Strategy fields.
-
limit(optional): integer
This is the field to specify the number of records to be fetched per REST call.
-
offset(optional): integer
This field specifies the offset/starting index from which data to be fetched.
-
q(optional): string
This field specifies the query used to filter Strategies.
-
sort(optional): string
This field specifies the sort order of the list to be fetched.
-
totalResults(optional): boolean
Indicates if the total results should be included in the response.
Header Parameters
-
Accept-Language: string
The locale.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : listRecommendationStrategies_response
Type:
Show Source
object
-
items(optional):
array items
The returned list of items.
Nested Schema : items
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)
{
"totalResults":4,
"endingIndex":250,
"offset":0,
"totalResultsParam":true,
"count":4,
"links":[
{
"rel":"self",
"href":"http://localhost:9080/ccadminui/v1/recommendationStrategies"
}
],
"sort":{
"collator":null,
"localeSensitiveSorting":false,
"numDirectives":1,
"empty":false
},
"items":[
{
"recommendationGroups":[
{
"numRecs":5,
"conditions":[
{
"id":"browsedTogether"
}
]
}
],
"displayName":"browsedTogether",
"description":"This is a description of browsedTogether",
"id":"browsedTogether"
},
{
"recommendationGroups":[
{
"numRecs":5,
"conditions":[
{
"id":"mostRecentlyViewed"
}
]
}
],
"displayName":"mostRecentlyViewed",
"description":"This is a description of mostRecentlyViewed",
"id":"mostRecentlyViewed"
},
{
"recommendationGroups":[
{
"numRecs":5,
"conditions":[
{
"id":"purchasedTogether"
}
]
}
],
"displayName":"purchasedTogether",
"description":"This is a description of purchasedTogether",
"id":"purchasedTogether"
},
{
"recommendationGroups":[
{
"numRecs":5,
"conditions":[
{
"id":"topSellers"
}
]
}
],
"displayName":"topSellers",
"description":"This is a description of topSellers",
"id":"topSellers"
}
],
"collectionPaged":true,
"listingRequest":null,
"startingIndex":0,
"totalNumberOfItems":4
}
Default Response
The error response.
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