Jump to

• Request
• Response

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : getRecommendationStrategy_response

Type: object

Show Source

• 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.

{
    "properties":{
        "recommendationGroups":{
            "description":"The array of Recommendation Groups for the Strategy.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "numRecs":{
                        "description":"The number of recommendations to display from this set of Conditions.",
                        "type":"integer"
                    },
                    "conditions":{
                        "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationStrategyConditions endpoint.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The ID of the Condition.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        },
        "displayName":{
            "description":"The localized display name of the Strategy.",
            "type":"string"
        },
        "description":{
            "description":"The Strategy's description.",
            "type":"string"
        },
        "id":{
            "description":"The ID of the Strategy",
            "type":"string"
        }
    }
}

Nested Schema : recommendationGroups

Type: array

The array of Recommendation Groups for the Strategy.

Show Source

• Array of: object items

{
    "description":"The array of Recommendation Groups for the Strategy.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "numRecs":{
                "description":"The number of recommendations to display from this set of Conditions.",
                "type":"integer"
            },
            "conditions":{
                "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationStrategyConditions endpoint.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the Condition.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "numRecs":{
            "description":"The number of recommendations to display from this set of Conditions.",
            "type":"integer"
        },
        "conditions":{
            "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationStrategyConditions endpoint.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "id":{
                        "description":"The ID of the Condition.",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : conditions

Type: array

The array of Conditions and their parameters, if any. Conditions are described in the /recommendationStrategyConditions endpoint.

Show Source

• Array of: object items

{
    "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationStrategyConditions endpoint.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "id":{
                "description":"The ID of the Condition.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• id(optional): string
  The ID of the Condition.

{
    "type":"object",
    "properties":{
        "id":{
            "description":"The ID of the Condition.",
            "type":"string"
        }
    }
}

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.|

Body ()

Root Schema : errorModel

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "type":{
            "description":"The URI to the HTTP state code definition",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "errors":{
            "description":"An optional list of errors if multiple errors were encountered",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorCode":{
                        "description":"The numerical code identifying the error",
                        "type":"string"
                    },
                    "message":{
                        "description":"The localized message describing the error",
                        "type":"string"
                    },
                    "devMessage":{
                        "description":"An optional non-localized message containing technical information for developers",
                        "type":"string"
                    },
                    "moreInfo":{
                        "description":"An optional non-localized message with more information",
                        "type":"string"
                    },
                    "o:errorPath":{
                        "description":"An optional machine readable description of where the error occurred",
                        "type":"string"
                    },
                    "status":{
                        "description":"The HTTP status code",
                        "type":"string"
                    }
                }
            }
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Show Source

• Array of: object items

{
    "description":"An optional list of errors if multiple errors were encountered",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorCode":{
                "description":"The numerical code identifying the error",
                "type":"string"
            },
            "message":{
                "description":"The localized message describing the error",
                "type":"string"
            },
            "devMessage":{
                "description":"An optional non-localized message containing technical information for developers",
                "type":"string"
            },
            "moreInfo":{
                "description":"An optional non-localized message with more information",
                "type":"string"
            },
            "o:errorPath":{
                "description":"An optional machine readable description of where the error occurred",
                "type":"string"
            },
            "status":{
                "description":"The HTTP status code",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• 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

{
    "type":"object",
    "properties":{
        "errorCode":{
            "description":"The numerical code identifying the error",
            "type":"string"
        },
        "message":{
            "description":"The localized message describing the error",
            "type":"string"
        },
        "devMessage":{
            "description":"An optional non-localized message containing technical information for developers",
            "type":"string"
        },
        "moreInfo":{
            "description":"An optional non-localized message with more information",
            "type":"string"
        },
        "o:errorPath":{
            "description":"An optional machine readable description of where the error occurred",
            "type":"string"
        },
        "status":{
            "description":"The HTTP status code",
            "type":"string"
        }
    }
}

Back to Top