REST Resource: cases

Resource: Case

A Case is an object that contains the details of a support case. It contains fields for the time it was created, its priority, its classification, and more. Cases can also have comments and attachments that get added over time.

A case is parented by a Google Cloud organization or project.

Organizations are identified by a number, so the name of a case parented by an organization would look like this:

organizations/123/cases/456

Projects have two unique identifiers, an ID and a number, and they look like this:

projects/abc/cases/456

projects/123/cases/456

You can use either of them when calling the API. To learn more about project identifiers, see AIP-2510.

JSON representation 
{
  "name": string,
  "displayName": string,
  "description": string,
  "classification": {
    object (CaseClassification)
  },
  "timeZone": string,
  "subscriberEmailAddresses": [
    string
  ],
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "creator": {
    object (Actor)
  },
  "contactEmail": string,
  "escalated": boolean,
  "testCase": boolean,
  "languageCode": string,
  "priority": enum (Priority)
}
Fields
name

string

Identifier. The resource name for the case.
displayName

string

The short summary of the issue reported in this case.
description

string

A broad description of the issue.
classification

object (CaseClassification)

The issue classification applicable to this case.
timeZone

string

The timezone of the user who created the support case. It should be in a format IANA recognizes: https://www.iana.org/time-zones. There is no additional validation done by the API.
subscriberEmailAddresses[]

string

The email addresses to receive updates on this case.
state

enum (State)

Output only. The current status of the support case.
createTime

string (Timestamp format)

Output only. The time this case was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time this case was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
creator

object (Actor)

The user who created the case.

Note: The name and email will be obfuscated if the case was created by Google Support.
contactEmail

string

A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.
escalated

boolean

Whether the case is currently escalated.
testCase

boolean

Whether this case was created for internal API testing and should not be acted on by the support team.
languageCode

string

The language the user has requested to receive support in. This should be a BCP 47 language code (e.g., "en", "zh-CN", "zh-TW", "ja", "ko"). If no language or an unsupported language is specified, this field defaults to English (en).

Language selection during case creation may affect your available support options. For a list of supported languages and their support working hours, see: https://cloud.google.com/support/docs/language-working-hours
priority

enum (Priority)

The priority of this case.

State

The status of a support case.

Enums
STATE_UNSPECIFIED Case is in an unknown state.
NEW The case has been created but no one is assigned to work on it yet.
IN_PROGRESS_GOOGLE_SUPPORT The case is currently being handled by Google support.
ACTION_REQUIRED Google is waiting for a response.
SOLUTION_PROVIDED A solution has been offered for the case, but it isn't yet closed.
CLOSED The case has been resolved.

Priority

The case Priority. P0 is most urgent and P4 the least.

Enums
PRIORITY_UNSPECIFIED Priority is undefined or has not been set yet.
P0 Extreme impact on a production service. Service is hard down.
P1 Critical impact on a production service. Service is currently unusable.
P2 Severe impact on a production service. Service is usable but greatly impaired.
P3 Medium impact on a production service. Service is available, but moderately impaired.
P4 General questions or minor issues. Production service is fully available.

Methods

close

 Close a case.

create

 Create a new case and associate it with a parent.

escalate

 Escalate a case, starting the Google Cloud Support escalation management process.

get

 Retrieve a case.

list

 Retrieve all cases under a parent, but not its children.

patch

 Update a case.
Search for cases using a query.