REST API for Oracle Commerce Cloud December 2017

logClientErrors

post

/ccadmin/v1/logging/logClientErrors

Log Client Errors. Creates an error log entry for client errors. Expects the JSON to contain an clientSideErrors array.

Request

Supported Media Types

application/json

Body Parameter

Root Schema : logClientErrors_request

Example


{
    "clientSideErrors":[
        {
            "clientErrorCode":"15006",
            "osVersion":"Win32",
            "line":"",
            "browserVersion":"Chrome 33.0.1750.154",
            "time":"2014-03-21T11:33:18.170Z",
            "message":"Error: Script error\nhttp://requirejs.org/docs/errors.html#scripterror",
            "locale":"en-US",
            "url":"http://localhost:9080/random"
        }
    ]
}

Properties

clientSideErrors: Type: array clientSideErrors

Required: true

Additional Properties Allowed:

The array of client side errors to print to error log.

Nested Schema : clientSideErrors

Type: array

The array of client side errors to print to error log.

Items

Type: object items

Additional Properties Allowed:

Nested Schema : items

Type: object

Properties

browserVersion: Type: string

Browser version for client side error.
clientErrorCode: Type: string

Client error code for client side error.
line: Type: string

Line for client side error.
locale: Type: string

Locale for client side error.
message: Type: string

Message for client side error.
osVersion: Type: string

OS version for client side error.
time: Type: string

Time for client side error.
url: Type: string

URL for client side error.

Response

Supported Media Types

application/json

200 Response

Following model is returned when operation succeeds.

Body

Root Schema : logClientErrors_response

Properties

Default Response

The error response

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:

{"clientSideErrors": [{
  "clientErrorCode": "15006",
  "osVersion": "Win32",
  "line": "",
  "browserVersion": "Chrome 33.0.1750.154",
  "time": "2014-03-21T11:33:18.170Z",
  "message": "Error: Script error\nhttp://requirejs.org/docs/errors.html#scripterror",
  "locale": "en-US",
  "url": "http://localhost:9080/admin/#/random"
}]}