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 filter language.

A query uses the following fields with the operators equals (=) and AND:

  • organization: An organization name in the form organizations/<organizationId>.
  • project: A project name in the form projects/<projectId>.
  • state: The accepted values are OPEN or CLOSED.
  • priority: The accepted values are P0, P1, P2, P3, or P4. You can specify multiple values for priority using the OR operator. For example, priority=P1 OR priority=P2.
  • [DEPRECATED] severity: The accepted values are S0, S1, S2, S3, or S4.
  • creator.email: The email address of the case creator.

You must specify eitehr organization or project.

To search across displayName, description, and comments, use a global restriction with no keyword or operator. For example, "my search".

To search only cases updated after a certain date, use updateTime retricted with that particular date, time, and timezone in ISO datetime format. For example, updateTime>"2020-01-01T00:00:00-05:00". updateTime only supports the greater than operator (>).

Examples:

  • organization="organizations/123456789"
  • project="projects/my-project-id"
  • project="projects/123456789"
  • organization="organizations/123456789" AND state=CLOSED
  • project="projects/my-project-id" AND creator.email="tester@example.com"
  • project="projects/my-project-id" AND (priority=P0 OR priority=P1)
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.