Jump to

• Request
• Response

listRecommendationGlobalRules

get

/ccadmin/v1/recommendationGlobalRules

This operation is used to get the collection of Recommendation Global Rules from Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Query Parameters

• fields: string
  This controls which fields are returned in the response body. The default is to include all Global Rule fields.
• limit: integer
  This is the field to specify the number of records to be fetched per REST call.
• offset: integer
  This field specifies the offset/starting index from which data to be fetched.
• q: string
  This field specifies the query used to filter Global Rules.
• sort: string
  This field specifies the sort order of the list to be fetched.
• totalResults: boolean
  Indicates if the total results should be included in the response.

Header Parameters

• Accept-Language(required): string
  The locale.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : listRecommendationGlobalRules_response

Type: object

Show Source

• items: array items
  The returned list of items.

{
    "properties":{
        "items":{
            "description":"The returned list of items.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "displayName":{
                        "description":"The localized display name of the Global Rule.",
                        "type":"string"
                    },
                    "description":{
                        "description":"The Global Rule's description.",
                        "type":"string"
                    },
                    "id":{
                        "description":"The ID of the Global Rule",
                        "type":"string"
                    },
                    "conditions":{
                        "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationGlobalRuleConditions endpoint.",
                        "type":"array",
                        "items":{
                            "type":"object",
                            "properties":{
                                "id":{
                                    "description":"The ID of the Condition.",
                                    "type":"string"
                                }
                            }
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: array

The returned list of items.

Show Source

• Array of: object items

{
    "description":"The returned list of items.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "displayName":{
                "description":"The localized display name of the Global Rule.",
                "type":"string"
            },
            "description":{
                "description":"The Global Rule's description.",
                "type":"string"
            },
            "id":{
                "description":"The ID of the Global Rule",
                "type":"string"
            },
            "conditions":{
                "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationGlobalRuleConditions endpoint.",
                "type":"array",
                "items":{
                    "type":"object",
                    "properties":{
                        "id":{
                            "description":"The ID of the Condition.",
                            "type":"string"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• conditions: array conditions
  The array of Conditions and their parameters, if any. Conditions are described in the /recommendationGlobalRuleConditions endpoint.
• description: string
  The Global Rule's description.
• displayName: string
  The localized display name of the Global Rule.
• id: string
  The ID of the Global Rule

{
    "type":"object",
    "properties":{
        "displayName":{
            "description":"The localized display name of the Global Rule.",
            "type":"string"
        },
        "description":{
            "description":"The Global Rule's description.",
            "type":"string"
        },
        "id":{
            "description":"The ID of the Global Rule",
            "type":"string"
        },
        "conditions":{
            "description":"The array of Conditions and their parameters, if any.  Conditions are described in the /recommendationGlobalRuleConditions 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 /recommendationGlobalRuleConditions endpoint.

Show Source

• Array of: object items

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

Nested Schema : items

Type: object

Show Source

• id: string
  The ID of the Condition.

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

Example Response (application/json)

{
    "totalResults":3,
    "offset":0,
    "sort":{
        "property":"displayName",
        "order":"asc"
    },
    "items":[
        {
            "displayName":"noProductsInCurrentBrand",
            "description":"This is a description of noProductsInCurrentBrand",
            "id":"noProductsInCurrentBrand",
            "conditions":[
                {
                    "id":"currentBrand"
                }
            ]
        },
        {
            "displayName":"noProductsInCurrentCollection",
            "description":"This is a description of noProductsInCurrentCollection",
            "id":"noProductsInCurrentCollection",
            "conditions":[
                {
                    "id":"currentCollection"
                }
            ]
        },
        {
            "displayName":"noProductsInCurrentPriceType",
            "description":"This is a description of noProductsInCurrentPriceType",
            "id":"noProductsInCurrentPriceType",
            "conditions":[
                {
                    "id":"currentPriceType"
                }
            ]
        }
    ]
}

Default Response

The error response.

Body ()

Root Schema : errorModel

Type: object

Show Source

• devMessage: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• errors: array errors
  An optional list of errors if multiple errors were encountered
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: string
  The HTTP status code
• type: 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: string
  An optional non-localized message containing technical information for developers
• errorCode: string
  The numerical code identifying the error
• message: string
  The localized message describing the error
• moreInfo: string
  An optional non-localized message with more information
• o:errorPath: string
  An optional machine readable description of where the error occurred
• status: 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