Status

The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).

HealthcareFHIRHL7v2DICOMMedical ImagingDe-identificationInteroperabilityCloud

Properties

Name Type Description
code integer The status code, which should be an enum value of google.rpc.Code.
details array A list of messages that carry the error details. There is a common set of message types for APIs to use.
message string A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
View JSON Schema on GitHub

JSON Schema

Status.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Status",
  "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
  "properties": {
    "code": {
      "description": "The status code, which should be an enum value of google.rpc.Code.",
      "format": "int32",
      "type": "integer"
    },
    "details": {
      "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
      "items": {
        "additionalProperties": {
          "description": "Properties of the object. Contains field @type with type URL."
        },
        "type": "object"
      },
      "type": "array"
    },
    "message": {
      "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
      "type": "string"
    }
  },
  "type": "object"
}