v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13183063.3 KB
cases

Update a case. Only some fields can be updated. EXAMPLES: cURL: shell case="projects/some-project/cases/43595344" curl \ --request PATCH \ --header "Authorization: Bearer $(gcloud auth print-access-token)" \ --header "Content-Type: application/json" \ --data '{ "priority": "P1" }' \ "https://cloudsupport.googleapis.com/v2/$case?updateMask=priority" Python: python import googleapiclient.discovery api_version = "v2" supportApiService = googleapiclient.discovery.build( serviceName="cloudsupport", version=api_version, discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={api_version}", ) request = supportApiService.cases().patch( name="projects/some-project/cases/43112854", body={ "displayName": "This is Now a New Title", "priority": "P2", }, ) print(request.execute())

patch/v2/{+name}

Path parameters

namestring required

Identifier. The resource name for the case.

Query parameters

updateMaskstring

A list of attributes of the case that should be updated. Supported values are priority, display_name, and subscriber_email_addresses. If no fields are specified, all supported fields are updated. Be careful - if you do not provide a field mask, then you might accidentally clear some fields. For example, if you leave the field mask empty and do not provide a value for subscriber_email_addresses, then subscriber_email_addresses is updated to empty.

Request body

displayNamestring

The short summary of the issue reported in this case.

state'STATE_UNSPECIFIED' | 'NEW' | 'IN_PROGRESS_GOOGLE_SUPPORT' | 'ACTION_REQUIRED' | 'SOLUTION_PROVIDED' | 'CLOSED'

Output only. The current status of the support case.

descriptionstring

A broad description of the issue.

contactEmailstring

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.

escalatedboolean

Whether the case is currently escalated.

testCaseboolean

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

createTimestring google-datetime

Output only. The time this case was created.

namestring

Identifier. The resource name for the case.

priority'PRIORITY_UNSPECIFIED' | 'P0' | 'P1' | 'P2' | 'P3' | 'P4'

The priority of this case.

updateTimestring google-datetime

Output only. The time this case was last updated.

languageCodestring

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

subscriberEmailAddressesstring[]

The email addresses to receive updates on this case.

timeZonestring

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.

Response

Successful response