REST API for Oracle Commerce Cloud December 2017

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: Type: string

Required: true

ID of the browser type. Must be 'snapshot' for the user agents that should be served static snapshots.

Body Parameter

Root Schema : setBrowserType_request

Example


{
    "call":"curl -H 'Content-type: application/json' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.somehost.com}/ccadmin/v1/browserTypes/snapshot -d '{sampleRequestData}'",
    "data":{
        "patterns":[
            ".*[Gg]oogle[Bb]ot",
            ".*[Ss]lurp"
        ]
    }
}

Properties

patterns: Type: array patterns

Additional Properties Allowed:

List of user agent string patterns
regexPatterns: Type: array regexPatterns

Additional Properties Allowed:

List of user agent string regular expression patterns

Nested Schema : patterns

Type: array

List of user agent string patterns

Items

Type: string

Nested Schema : regexPatterns

Type: array

List of user agent string regular expression patterns

Items

Type: string

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : setBrowserType_response

Properties

id: Type: string

ID of the browser type
patterns: Type: array patterns

Additional Properties Allowed:

List of user agent string patterns
regexPatterns: Type: array regexPatterns

Additional Properties Allowed:

List of user agent string regular expression patterns

Nested Schema : patterns

Type: array

List of user agent string patterns

Items

Type: string

Nested Schema : regexPatterns

Type: array

List of user agent string regular expression patterns

Items

Type: string

Example application/json


{
    "regexPatterns":[
    ],
    "patterns":[
        ".*[Gg]oogle[Bb]ot",
        ".*[Ss]lurp"
    ],
    "links":[
        {
            "rel":"self",
            "href":"/ccadminui/v1/browserTypes/snapshot"
        }
    ],
    "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|

Body

Root Schema : errorModel

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
errors: Type: array errors

Additional Properties Allowed:

An optional list of errors if multiple errors were encountered
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code
type: Type: string

The URI to the HTTP state code definition

Nested Schema : errors

Type: array

An optional list of errors if multiple errors were encountered

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

devMessage: Type: string

An optional non-localized message containing technical information for developers
errorCode: Type: string

The numerical code identifying the error
message: Type: string

The localized message describing the error
moreInfo: Type: string

An optional non-localized message with more information
o:errorPath: Type: string

An optional machine readable description of where the error occurred
status: Type: string

The HTTP status code

Examples

Sample Request:

{
  "call": "curl -H 'Content-type: application/json' -H 'Authorization: Bearer {Access-Token}' -H PUT https://{www.somehost.com}/ccadmin/v1/browserTypes/snapshot -d '{sampleRequestData}'",
  "data": {"patterns": [
    ".*[Gg]oogle[Bb]ot",
    ".*[Ss]lurp"
  ]}
}

Sample Response Payload returned by endpoint:

{
  "regexPatterns": [],
  "patterns": [
    ".*[Gg]oogle[Bb]ot",
    ".*[Ss]lurp"
  ],
  "links": [{
    "rel": "self",
    "href": "/ccadminui/v1/browserTypes/snapshot"
  }],
  "id": "snapshot"
}