Jump to

• Request
• Response

updateRecommendationGlobalRule

put

/ccadmin/v1/recommendationGlobalRules/{id}

This operation is used to update a Global Rule in Oracle Commerce Cloud.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The Global Rule id.

Body ()

Root Schema : updateRecommendationGlobalRule_request

Type: object

Show Source

• 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

{
    "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(optional): string
  The ID of the Condition.

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

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : updateRecommendationGlobalRule_response

Type: object

Show Source

• 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

{
    "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(optional): string
  The ID of the Condition.

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

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"
        }
    ]
}

412 Response

ETag mismatch. Asset has been updated by another user.

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| |------------------|------------------| |52050|Missing input.| |52018|Invalid numRecs.| |52033|Invalid Conditions.| |52035|Missing Global Rule ID.| |52036|Invalid Global Rule ID.| |52040|Missing Global Rule displayName.| |52037|The Global Rule ID is too long.| |52038|Duplicate Global Rule ID.| |52041|Global Rule displayName is too long.| |52043|Global Rule description is too long.| |52042|Duplicate Global Rule displayName.| |52019|Invalid Strategy Condition format.| |52022|Invalid Recommendation Group format.| |52023|Missing Condition ID.| |52024|Invalid Condition 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