getRecommendationGlobalRule
get
/ccadmin/v1/recommendationGlobalRules/{id}
This operation is used to get a specific Recommendation Global Rule from Oracle Commerce Cloud.
Request
Supported Media Types
- application/json
Path Parameters
-
id: string
The Global Rule ID.
Response
Supported Media Types
- application/json
200 Response
Following model is returned when operation succeeds.
Root Schema : getRecommendationGlobalRule_response
Type:
Show Source
object
-
conditions(optional):
array conditions
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationGlobalRuleConditions endpoint.
-
description(optional):
string
The Global Rule's description.
-
displayName(optional):
string
The localized display name of the Global Rule.
-
id(optional):
string
The ID of the Global Rule
Nested Schema : conditions
Type:
array
The array of Conditions and their parameters, if any. Conditions are described in the /recommendationGlobalRuleConditions endpoint.
Show Source
Example Response (application/json)
{
"displayName":"noShirtsNoShoesNoService",
"description":"This is a description of noShirtsNoShoesNoService",
"id":"noShirtsNoShoesNoService",
"conditions":[
{
"id":"specifiedCollection",
"collectionId":"Shirts"
},
{
"id":"specifiedBrand",
"brand":"Service"
},
{
"id":"specifiedCollection",
"collectionId":"Shoes"
}
]
}
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|
|------------------|------------------|
|52036|Invalid Global Rule 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