Method: cases.list

Full name: projects.locations.instances.cases.list

Lists cases.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list Cases for. Format: projects/{project}/locations/{location}/instances/{instance}/cases

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of cases to return. The service may return fewer than this value. If unspecified, at most 50 Cases will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous cases.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to cases.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of Cases. Supported filter fields: * displayName * creatorUserId * creatorUser * lastModifyingUserId * lastModifyingUser * assignee * assignedUser * stage * priority * important * type * environment * case_data_state * score * alertsSla * sla * tags * products * closureDetails * tasks Example: filter="displayName='some_name'"
orderBy

string

Optional. Configures ordering of Cases in the response. If not specified, Cases are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * displayName * creatorUserId * creatorUser * lastModifyingUserId * lastModifyingUser * assignee * assignedUser * stage * priority * important * type * environment * case_data_state * score * alertsSla * sla * tags * products * closureDetails * tasks example: "displayName desc, priority"
expand

string

Optional. Expand the response to include the full case object. Supported values: * tasks * tags * products example: "tags, products"

Request body

The request body must be empty.

Response body

Response message for cases.list.

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

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

object (Case)

The list of cases.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

The total number of results matching the request.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.