Jump to

• Request
• Response

logClientErrors

post

/ccstore/v1/logging/logClientErrors

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

Request

Supported Media Types

• application/json

Body ()

Root Schema : logClientErrors_request

Type: object

Show Source

• clientSideErrors: array clientSideErrors
  The array of client side errors to print to error log.

{
    "properties":{
        "clientSideErrors":{
            "description":"The array of client side errors to print to error log.",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "clientErrorCode":{
                        "description":"Client error code for client side error.",
                        "type":"string"
                    },
                    "osVersion":{
                        "description":"OS version for client side error.",
                        "type":"string"
                    },
                    "line":{
                        "description":"Line for client side error.",
                        "type":"string"
                    },
                    "browserVersion":{
                        "description":"Browser version for client side error.",
                        "type":"string"
                    },
                    "time":{
                        "description":"Time for client side error.",
                        "type":"string"
                    },
                    "message":{
                        "description":"Message for client side error.",
                        "type":"string"
                    },
                    "locale":{
                        "description":"Locale for client side error.",
                        "type":"string"
                    },
                    "url":{
                        "description":"URL for client side error.",
                        "type":"string"
                    }
                }
            }
        }
    },
    "required":[
        "clientSideErrors"
    ],
    "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"
            }
        ]
    }
}

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

Nested Schema : clientSideErrors

Type: array

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

Show Source

• Array of: object items

{
    "description":"The array of client side errors to print to error log.",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "clientErrorCode":{
                "description":"Client error code for client side error.",
                "type":"string"
            },
            "osVersion":{
                "description":"OS version for client side error.",
                "type":"string"
            },
            "line":{
                "description":"Line for client side error.",
                "type":"string"
            },
            "browserVersion":{
                "description":"Browser version for client side error.",
                "type":"string"
            },
            "time":{
                "description":"Time for client side error.",
                "type":"string"
            },
            "message":{
                "description":"Message for client side error.",
                "type":"string"
            },
            "locale":{
                "description":"Locale for client side error.",
                "type":"string"
            },
            "url":{
                "description":"URL for client side error.",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• browserVersion(optional): string
  Browser version for client side error.
• clientErrorCode(optional): string
  Client error code for client side error.
• line(optional): string
  Line for client side error.
• locale(optional): string
  Locale for client side error.
• message(optional): string
  Message for client side error.
• osVersion(optional): string
  OS version for client side error.
• time(optional): string
  Time for client side error.
• url(optional): string
  URL for client side error.

{
    "type":"object",
    "properties":{
        "clientErrorCode":{
            "description":"Client error code for client side error.",
            "type":"string"
        },
        "osVersion":{
            "description":"OS version for client side error.",
            "type":"string"
        },
        "line":{
            "description":"Line for client side error.",
            "type":"string"
        },
        "browserVersion":{
            "description":"Browser version for client side error.",
            "type":"string"
        },
        "time":{
            "description":"Time for client side error.",
            "type":"string"
        },
        "message":{
            "description":"Message for client side error.",
            "type":"string"
        },
        "locale":{
            "description":"Locale for client side error.",
            "type":"string"
        },
        "url":{
            "description":"URL for client side error.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Following model is returned when operation succeeds.

Body ()

Root Schema : logClientErrors_response

Show Source

{
    "properties":{
    }
}

Default Response

The error response

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