Custom error.
| JSON representation |
|---|
{
"code": enum ( |
| Fields | |
|---|---|
code |
The custom error code. |
message |
The error message. |
CustomError
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-07 UTC.
[null,null,["Last updated 2024-08-07 UTC."],[[["\u003cp\u003eThe provided content defines a custom error structure for API responses.\u003c/p\u003e\n"],["\u003cp\u003eThe custom error is represented in JSON format with two fields: \u003ccode\u003ecode\u003c/code\u003e and \u003ccode\u003emessage\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003ecode\u003c/code\u003e field is an enumeration (\u003ccode\u003eenum\u003c/code\u003e) that refers to a specific \u003ccode\u003eCustomErrorCode\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003emessage\u003c/code\u003e field is a string containing the error's description.\u003c/p\u003e\n"]]],["The core content defines a custom error using a JSON representation. This representation includes two fields: `code` and `message`. The `code` field is an enumerated type referencing `CustomErrorCode`, specifying the particular custom error. The `message` field is a string that provides a description of the error. The information is structured to provide specific error identification and a related description.\n"],null,["# CustomError\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n\nCustom error.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------|\n| ``` { \"code\": enum (/zero-touch/reference/customer/rest/v1/CustomErrorCode), \"message\": string } ``` |\n\n| Fields ||\n|-----------|-------------------------------------------------------------------------------------------------------------|\n| `code` | `enum (`[CustomErrorCode](/zero-touch/reference/customer/rest/v1/CustomErrorCode)`)` The custom error code. |\n| `message` | `string` The error message. |"]]