Method: legacySdk.legacyGetCasesByRequest

Full name: projects.locations.instances.legacySdk.legacyGetCasesByRequest

Legacy RPC for get cases by request.

HTTP request


Path parameters

Parameters
instance

string

Required. The GetCasesByRequest request. Format: projects/{project}/locations/{location}/instances/{instance}/legacySdk:getCasesByRequest

Request body

The request body contains data with the following structure:

JSON representation
{
  "pageSize": integer,
  "sortType": enum (SortTypeEnum),
  "pageNumber": integer,
  "liveQueueSettings": {
    object (SdkLiveQueueSettingsDataModel)
  }
}
Fields
pageSize

integer

Optional. The page size.

sortType

enum (SortTypeEnum)

Required. The sort type.

pageNumber

integer

Optional. The page number.

liveQueueSettings

object (SdkLiveQueueSettingsDataModel)

Required. The live queue settings.

Response body

If successful, the response body contains an instance of Struct.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

SortTypeEnum

SortTypeEnum enum.

Enums
CREATION_TIME_DESCENDING Creation time descending.
CREATION_TIME_ASCENDING Creation time ascending.
MODIFICATION_TIME_DESCENDING Modification time descending.
MODIFICATION_TIME_ASCENDING Modification time ascending.
PRIORITY_DESCENDING Priority descending.
PRIORITY_ASCENDING Priority ascending.
ID_DESCENDING ID descending.
ID_ASCENDING ID ascending.
SLA_DESCENDING SLA descending.
SLA_ASCENDING SLA ascending.

SdkLiveQueueSettingsDataModel

LiveQueueSettingsDataModel message.

JSON representation
{
  "environments": [
    string
  ],
  "analysts": [
    string
  ],
  "stages": [
    string
  ],
  "priorities": [
    enum (CasePriority)
  ],
  "tags": [
    string
  ],
  "startTimeUnixTimeInMs": string,
  "endTimeUnixTimeInMs": string
}
Fields
environments[]

string

Optional. The environments.

analysts[]

string

Optional. The analysts.

stages[]

string

Optional. The stages.

priorities[]

enum (CasePriority)

Optional. The priorities.

tags[]

string

Optional. The tags.

startTimeUnixTimeInMs

string (int64 format)

Output only. The start time in unix ms.

endTimeUnixTimeInMs

string (int64 format)

Output only. The end time in unix ms.