Method: cases.search

Search cases using the specified query.

HTTP request

GET https://cloudsupport.googleapis.com/v2beta/cases:search

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
query

string

An expression written in the Cloud filter language. Filter strings can use the following fields:

  • organization (A name of the form organizations/)
  • project (A name of the form projects/)
  • customer (A name of the form customers/)
  • state (Accepted values: OPEN or CLOSED)
  • severity (Accepted values: S0, S1, S2, S3, or S4)
  • creator.email

with the operators equals (=) and AND. Additionally, a global restriction (with no key/operator) can be used to search across displayName, description, and comments (e.g. "my search"). One of organization, project, or customer field must be specified.

pageSize

integer

The maximum number of cases fetched with each request. The default page size is 10.

pageToken

string

A token identifying the page of results to return. If unspecified, the first page is retrieved.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The response message for the cases.search endpoint.

JSON representation
{
  "cases": [
    {
      object (Case)
    }
  ],
  "nextPageToken": string
}
Fields
cases[]

object (Case)

The list of Case associated with the cloud resource, after any filters have been applied.

nextPageToken

string

A token to retrieve the next page of results. This should be set in the pageToken field of subsequent SearchCaseRequest message that is issued. If unspecified, there are no more results to retrieve.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloudsupport
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.