Method: projects.locations.collections.dataConnector.startConnectorRun

Lance un processus de synchronisation immédiat pour un DataConnector. Les utilisateurs du connecteur tiers doivent spécifier les entités à synchroniser. Les connecteurs FHIR doivent fournir un code temporel pour indiquer le moment à partir duquel les données doivent être synchronisées.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataConnector}:startConnectorRun

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Nom du connecteur au format projects/{project}/locations/{location}/collections/{collectionId}/dataConnector

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "entities": [
    string
  ],
  "healthcareFhirResourceTypes": [
    string
  ],
  "forceRefreshContent": boolean,
  "syncIdentity": boolean,
  "syncSinceTimestamp": string
}
Champs
entities[]

string

Spécifie les entités du connecteur tiers à synchroniser. Si aucune n'est spécifiée, toutes les entités seront synchronisées.
healthcareFhirResourceTypes[]

string

Types de ressources FHIR à importer. Les types de ressources doivent être un sous-ensemble de tous les types de ressources FHIR acceptés. Si cette valeur est vide, la valeur par défaut est définie sur tous les types de ressources FHIR compatibles.
forceRefreshContent

boolean

Facultatif. Indique si le contenu non structuré des documents doit être actualisé de force.

Si la valeur est définie sur true, la partie contenu des documents sera actualisée, quel que soit l'état de mise à jour du contenu référencé.
syncIdentity

boolean

Si la valeur est "true", la synchronisation de l'identité est déclenchée.
syncSinceTimestamp

string (Timestamp format)

timestamp pour indiquer le point dans le temps à partir duquel les données doivent être synchronisées pour les connecteurs de données de flux/par lot. Ce champ n'est utilisé que pour les connecteurs de données de santé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Corps de la réponse

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

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la page Authentication Overview.

Autorisations IAM

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

  • discoveryengine.dataConnectors.startConnectorRun

Pour en savoir plus, consultez la documentation IAM.