Error

Defines the error that occurred.

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
code	string	The error code that identifies the category of error.
message	string	A description of the error.
moreDetails	string	A description that provides additional information about the error.
parameter	string	The parameter in the request that caused the error.
subCode	string	The error code that further helps to identify the error.
value	string	The parameter's value in the request that was not valid.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Error",
  "title": "Error",
  "required": [
    "code",
    "message"
  ],
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "The error code that identifies the category of error.",
      "default": "None",
      "enum": [
        "None",
        "ServerError",
        "InvalidRequest",
        "RateLimitExceeded",
        "InvalidAuthorization",
        "InsufficientAuthorization"
      ],
      "x-ms-enum": {
        "modelAsString": true,
        "name": "ErrorCode"
      }
    },
    "message": {
      "type": "string",
      "description": "A description of the error."
    },
    "moreDetails": {
      "type": "string",
      "description": "A description that provides additional information about the error.",
      "readOnly": true
    },
    "parameter": {
      "type": "string",
      "description": "The parameter in the request that caused the error.",
      "readOnly": true
    },
    "subCode": {
      "type": "string",
      "description": "The error code that further helps to identify the error.",
      "readOnly": true,
      "enum": [
        "UnexpectedError",
        "ResourceError",
        "NotImplemented",
        "ParameterMissing",
        "ParameterInvalidValue",
        "HttpNotAllowed",
        "Blocked",
        "AuthorizationMissing",
        "AuthorizationRedundancy",
        "AuthorizationDisabled",
        "AuthorizationExpired"
      ],
      "x-ms-enum": {
        "modelAsString": true,
        "name": "ErrorSubCode"
      }
    },
    "value": {
      "type": "string",
      "description": "The parameter's value in the request that was not valid.",
      "readOnly": true
    }
  },
  "description": "Defines the error that occurred."
}