Skip to main content

ErrorResponse

Detailed information about the error response

codestring

Error code

Example: ERR-142
messagestring

Error message

Example: Resource not found / Internal server error
details object[]

List of error details

  • Array [
  • codestring

    Error code

    Example: ER4001
    messagestring

    Detailed error message

    Example: Invalid input
    targetstring

    Target of the error

    Example: username
  • ]
  • suggestionsstring[]

    List of suggestions for resolving the error

    Example: ["Check the resource ID","Ensure the resource exists"]
    metaData object

    Additional metadata about the error, that could help in debugging

    property name*string

    Additional metadata about the error, that could help in debugging

    Example: {"requestId":"3c5e4cebf39cbc5b","operationId":"66fd4d2ae6b6"}
    ErrorResponse
    {
    "code": "ERR-142",
    "message": "Resource not found / Internal server error",
    "details": [
    {
    "code": "ER4001",
    "message": "Invalid input",
    "target": "username"
    }
    ],
    "suggestions": [
    "Check the resource ID",
    "Ensure the resource exists"
    ],
    "metaData": {
    "requestId": "3c5e4cebf39cbc5b",
    "operationId": "66fd4d2ae6b6"
    }
    }