Method: legacySdk.legacyGetCasesIdByFilter

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

Legacy RPC for getting cases id by filter.

HTTP request


Path parameters

Parameters
instance

string

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

Request body

The request body contains data with the following structure:

JSON representation 
{
  "maxResults": integer,
  "startTimeFromUnixTimeInMs": string,
  "startTimeToUnixTimeInMs": string,
  "closeTimeFromUnixTimeInMs": string,
  "closeTimeToUnixTimeInMs": string,
  "updateTimeFromUnixTimeInMs": string,
  "updateTimeToUnixTimeInMs": string,
  "status": string,
  "sortOrder": string,
  "sortBy": string,
  "operator": string,
  "environments": [
    string
  ],
  "tags": [
    string
  ]
}
Fields
maxResults

integer

Optional. Maximum number of results to return.
startTimeFromUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the start of the time range to filter by.
startTimeToUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the end of the time range to filter by.
closeTimeFromUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the start of the close time range to filter by.
closeTimeToUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the end of the close time range to filter by.
updateTimeFromUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the start of the update time range to filter by.
updateTimeToUnixTimeInMs

string (int64 format)

Optional. Unix timestamp in milliseconds for the end of the update time range to filter by.
status

string

Optional. Status to filter by.
sortOrder

string

Optional. Sort order to filter by.
sortBy

string

Optional. Sort by field to filter by.
operator

string

Optional. Operator to filter by.
environments[]

string

Optional. Environments to filter by.
tags[]

string

Optional. Tags to filter by.

Response body

The GetCasesIdByFilterResponse message.

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

JSON representation 
{
  "payload": [
    string
  ]
}
Fields
payload[]

string (int64 format)

The list of case IDs that match the filter criteria.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.