Method: projects.locations.dataStores.branches.documents.list

Obtient une liste de Document.

Requête HTTP

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom de la ressource de branche parente, par exemple projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Utilisez default_branch comme ID de branche pour lister les documents de la branche par défaut.

Si l'appelant n'est pas autorisé à lister les Document sous cette branche, qu'elle existe ou non, une erreur PERMISSION_DENIED est renvoyée.

Paramètres de requête

Paramètres
pageSize

integer

Nombre maximal de Document à renvoyer. Si aucune valeur n'est spécifiée, la valeur par défaut est 100. La valeur maximale autorisée est de 1 000. Les valeurs supérieures à 1 000 sont définies sur 1 000.

Si ce champ est négatif, une erreur INVALID_ARGUMENT est renvoyée.
pageToken

string

Jeton de page ListDocumentsResponse.next_page_token reçu d'un appel DocumentService.ListDocuments précédent. Fournissez-le pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à DocumentService.ListDocuments doivent correspondre à l'appel ayant fourni le jeton de page. Dans le cas contraire, une erreur INVALID_ARGUMENT est renvoyée.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient une instance de ListDocumentsResponse.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • discoveryengine.documents.list

Pour en savoir plus, consultez la documentation IAM.