Jump to

• Request
• Response

setBrowserType

put

/ccadmin/v1/browserTypes/{id}

Update the properties of a browser type. Fails if the browser type does not exist. The {createIfMissing} query parameter gives an option to create a new entry in database.

Request

Supported Media Types

• application/json

Path Parameters

• id: string
  ID of the browser type. ID of the browser type. Must be 'snapshot' for user agents that should be served the desktop version of static snapshots, or 'mobileSnapshot' for user agents that should be served the mobile version of static snapshots.

Body ()

Root Schema : setBrowserType_request

Type: object

Show Source

• patterns(optional): array patterns
  List of user agent string patterns
• regexPatterns(optional): array regexPatterns
  List of user agent string regular expression patterns
• viewport(optional): string
  Allowed Values: [ "lg", "xs" ]

  Viewport associated with this browser type. Must be 'lg' for desktop or 'xs' for mobile.

{
    "properties":{
        "regexPatterns":{
            "description":"List of user agent string regular expression patterns",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "viewport":{
            "description":"Viewport associated with this browser type. Must be 'lg' for desktop or 'xs' for mobile.",
            "type":"string",
            "enum":[
                "lg",
                "xs"
            ]
        },
        "patterns":{
            "description":"List of user agent string patterns",
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "example":{
        "call":"curl -H 'Content-type: application/json' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.example.com}/ccadmin/v1/browserTypes/snapshot -d '{sampleRequestData}'",
        "data":{
            "viewport":"lg",
            "patterns":[
                ".*[Yy]ahoo.*[Cc]rawler",
                ".*[Ss]lurp"
            ]
        }
    }
}

Example:

{
    "call":"curl -H 'Content-type: application/json' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.example.com}/ccadmin/v1/browserTypes/snapshot -d '{sampleRequestData}'",
    "data":{
        "viewport":"lg",
        "patterns":[
            ".*[Yy]ahoo.*[Cc]rawler",
            ".*[Ss]lurp"
        ]
    }
}

Nested Schema : patterns

Type: array

List of user agent string patterns

Show Source

• Array of: string

{
    "description":"List of user agent string patterns",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : regexPatterns

Type: array

List of user agent string regular expression patterns

Show Source

• Array of: string

{
    "description":"List of user agent string regular expression patterns",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : setBrowserType_response

Type: object

Show Source

• id(optional): string
  ID of the browser type
• patterns(optional): array patterns
  List of user agent string patterns
• regexPatterns(optional): array regexPatterns
  List of user agent string regular expression patterns
• viewport(optional): string
  Allowed Values: [ "lg", "xs" ]

  Viewport associated with this browser type. Must be 'lg' for desktop or 'xs' for mobile.

{
    "properties":{
        "regexPatterns":{
            "description":"List of user agent string regular expression patterns",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "viewport":{
            "description":"Viewport associated with this browser type. Must be 'lg' for desktop or 'xs' for mobile.",
            "type":"string",
            "enum":[
                "lg",
                "xs"
            ]
        },
        "patterns":{
            "description":"List of user agent string patterns",
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "id":{
            "description":"ID of the browser type",
            "type":"string"
        }
    }
}

Nested Schema : patterns

Type: array

List of user agent string patterns

Show Source

• Array of: string

{
    "description":"List of user agent string patterns",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : regexPatterns

Type: array

List of user agent string regular expression patterns

Show Source

• Array of: string

{
    "description":"List of user agent string regular expression patterns",
    "type":"array",
    "items":{
        "type":"string"
    }
}

Example Response (application/json)

{
    "regexPatterns":[
        "[Mm]obile.*[Gg]ooglebot",
        "[Mm]obile.*[Bb]ing[Bb]ot"
    ],
    "viewport":"xs",
    "patterns":[
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccadminui/v1/browserTypes/mobileSnapshot"
        }
    ],
    "id":"snapshot"
}

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| |------------------|------------------| |17001|Browser type is invalid or non-existent| |17004|Browser Type Id passed is null or empty| |17005|Invalid property value for browser type| |17006|Internal error occurred updating the browser type| |17008|Invalid input for viewport property|

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