Jump to

• Request
• Response

updateRedirect

put

/ccadmin/v1/redirects/{id}

Updates the redirection rule.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  The redirection rule id.

Body ()

Root Schema : createRedirect_request

Type: object

Show Source

• originUrl: string
  Origin URL of the redirect.
• siteId(optional): string
  ID of the site the redirect belongs to.
• targetUrl: string
  Destination URL of the redirect.
• type: integer
  Redirect type

{
    "properties":{
        "originUrl":{
            "description":"Origin URL of the redirect.",
            "type":"string"
        },
        "siteId":{
            "description":"ID of the site the redirect belongs to.",
            "type":"string"
        },
        "type":{
            "description":"Redirect type",
            "type":"integer"
        },
        "targetUrl":{
            "description":"Destination URL of the redirect.",
            "type":"string"
        }
    },
    "required":[
        "type",
        "originUrl",
        "targetUrl"
    ],
    "example":{
        "originUrl":"/origin_url_4",
        "siteId":"siteUS",
        "type":301,
        "targetUrl":"/target_url_4"
    }
}

Example:

{
    "originUrl":"/origin_url_4",
    "siteId":"siteUS",
    "type":301,
    "targetUrl":"/target_url_4"
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : createRedirect_response

Type: object

Show Source

• id(optional): string
  ID.
• originUrl(optional): string
  Origin URL of the redirect.
• siteId(optional): string
  ID of the site the redirect belongs to.
• targetUrl(optional): string
  Destination URL of the redirect.
• type(optional): integer
  Redirect type

{
    "properties":{
        "originUrl":{
            "description":"Origin URL of the redirect.",
            "type":"string"
        },
        "siteId":{
            "description":"ID of the site the redirect belongs to.",
            "type":"string"
        },
        "id":{
            "description":"ID.",
            "type":"string"
        },
        "type":{
            "description":"Redirect type",
            "type":"integer"
        },
        "targetUrl":{
            "description":"Destination URL of the redirect.",
            "type":"string"
        }
    }
}

Example Response (application/json)

{
    "originUrl":"/origin_url_1",
    "siteId":null,
    "id":"300001",
    "type":301,
    "targetUrl":"/target_url_1"
}

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| |------------------|------------------| |183000|Unexpected error returned processing redirection rules.| |183001|Unsupported redirect type.| |183002|Incorrect origin URL.| |183003|Incorrect target URL.| |183004|Site {0} does not exist.| |183005|Redirect loop detected.| |183006|Number of redirect jumps exceeded.| |183009|Error parsing input request.| |183014|Rule with id {0} does not exist.| |183011|Origin and target URLs are the same.| |183013|Maximum number of redirection rules exceeded.| |

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