Method: caseCloseDefinitions.list

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

Lists CaseCloseDefinitions.

HTTP request


Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of CaseCloseDefinitions to return. The service may return fewer than this value. If unspecified, at most 50 CaseCloseDefinitions 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 caseCloseDefinitions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of CaseCloseDefinitions. Supported filter fields: * reason: Filter by the reason. * rootCause: Filter by the root cause. Example: filter="reason='MALICIOUS'"
orderBy

string

Optional. Configures ordering of CaseCloseDefinitions in the response. If not specified, CaseCloseDefinitions 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: * reason * rootCause For example: "reason desc" example: "displayName desc, default"

Request body

The request body must be empty.

Response body

Response message for caseCloseDefinitions.list.

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

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

object (CaseCloseDefinition)

The list of CaseCloseDefinitions.
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

Total number of CaseCloseDefinitions includes filter without pagination.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.