Method: cases.search

Pesquisar casos usando uma consulta.

EXEMPLOS:

cURL

parent="projects/some-project"
curl \
  --header "Authorization: Bearer $(gcloud auth print-access-token)" \
  "https://cloudsupport.googleapis.com/v2/$parent/cases:search"

Python:

import googleapiclient.discovery


apiVersion = "v2"
supportApiService = googleapiclient.discovery.build(
    serviceName="cloudsupport",
    version=apiVersion,
    discoveryServiceUrl=f"https://cloudsupport.googleapis.com/$discovery/rest?version={apiVersion}",
)
request = supportApiService.cases().search(
    parent="projects/some-project", query="state=OPEN"
)
print(request.execute())

Solicitação HTTP

GET https://cloudsupport.googleapis.com/v2/{parent=*/*}/cases:search

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

O nome do recurso pai em que os casos serão pesquisados.

Parâmetros de consulta

Parâmetros
query

string

Uma expressão usada para filtrar casos.

As expressões usam os seguintes campos separados por AND e especificados com =:

  • organization: um nome de organização no formato organizations/<organizationId>.
  • project: um nome de projeto no formato projects/<projectId>.
  • state: pode ser OPEN ou CLOSED.
  • priority: pode ser P0, P1, P2, P3 ou P4. É possível especificar diversos valores para prioridade usando o operador OR. Exemplo: priority=P1 OR priority=P2.
  • creator.email: o endereço de e-mail do criador do caso.

É necessário especificar organization ou project.

Para pesquisar displayName, description e comentários, use uma restrição global sem palavra-chave ou operador. Por exemplo, "my search".

Para pesquisar apenas casos atualizados após uma determinada data, use updateTime restrito a essa data, hora e fuso horário específicos no formato de data e hora ISO. Por exemplo, updateTime>"2020-01-01T00:00:00-05:00". updateTime só oferece suporte ao operador "maior que" (>).

Por exemplo:

  • 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

O número máximo de casos buscados com cada solicitação. O tamanho de página padrão é 10.

pageToken

string

Um token que identifica a página de resultados a serem retornados. Se não for especificado, a primeira página será recuperada.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A mensagem de resposta para o endpoint case.search.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "cases": [
    {
      object (Case)
    }
  ],
  "nextPageToken": string
}
Campos
cases[]

object (Case)

A lista de casos associados ao pai após a aplicação de todos os filtros.

nextPageToken

string

Um token para recuperar a próxima página de resultados. Defina isso no campo pageToken das solicitações cases.search subsequentes. Se não for especificado, não haverá mais resultados para recuperar.

Escopos de autorização

Requer um dos seguintes escopos de OAuth:

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

Para saber mais, consulte a Visão geral da autenticação.