Method: cases.search

Suchen Sie mit einer Abfrage nach Fällen.

BEISPIELE:

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())

HTTP-Anfrage

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

Die URL verwendet die Syntax der gRPC-Transcodierung.

Pfadparameter

Parameter
parent

string

Der Name der übergeordneten Ressource, unter der nach Fällen gesucht werden soll.

Abfrageparameter

Parameter
query

string

Ein Ausdruck, der zum Filtern von Fällen verwendet wird.

Für Ausdrücke werden die folgenden durch AND getrennten Felder verwendet, die mit = angegeben werden:

  • organization: Ein Organisationsname im Format organizations/<organizationId>.
  • project: Ein Projektname im Format projects/<projectId>.
  • state: Kann OPEN oder CLOSED sein.
  • priority: Kann P0, P1, P2, P3 oder P4 sein. Mit dem Operator OR können Sie mehrere Werte für die Priorität angeben. z. B. priority=P1 OR priority=P2.
  • creator.email: Die E-Mail-Adresse des Erstellers der Anfrage.

Sie müssen entweder organization oder project angeben.

Wenn Sie in displayName, description und Kommentaren suchen möchten, verwenden Sie eine globale Einschränkung ohne Suchbegriff und Operator. Beispiel: "my search"

Wenn Sie nur in Fällen suchen möchten, die nach einem bestimmten Datum aktualisiert wurden, verwenden Sie updateTime mit einem bestimmten Datum, einer Uhrzeit und einer Zeitzone im ISO-Datum/Uhrzeit-Format. Beispiel: updateTime>"2020-01-01T00:00:00-05:00". updateTime unterstützt nur den Größer-als-Operator (>).

Beispiele:

  • 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

Die maximale Anzahl der Fälle, die mit jeder Anfrage abgerufen werden. Die Standardseitengröße ist 10.
pageToken

string

Ein Token, das die Ergebnisseite identifiziert, die zurückgegeben werden soll. Wenn keine Angabe erfolgt, wird die erste Seite abgerufen.

Anfragetext

Der Anfragetext muss leer sein.

Antworttext

Die Antwortnachricht für den Endpunkt „case.search“.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "cases": [
    {
      object (Case)
    }
  ],
  "nextPageToken": string
}
Felder
cases[]

object (Case)

Die Liste der Fälle, die dem übergeordneten Element zugeordnet sind, nachdem alle Filter angewendet wurden.
nextPageToken

string

Ein Token, mit dem die nächste Ergebnisseite abgerufen werden kann. Legen Sie dies im Feld pageToken der nachfolgenden cases.search-Anfragen fest. Wenn keine Angabe erfolgt, sind keine weiteren Ergebnisse zum Abrufen vorhanden.

Autorisierungsbereiche

Erfordert einen der folgenden OAuth-Bereiche:

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

Weitere Informationen finden Sie in der Authentifizierungsübersicht.