Configurer REST dans une activité de copie
Cet article explique comment utiliser l'activité de copie dans le pipeline de données pour copier des données depuis et vers un point de terminaison REST.
Plus précisément, ce connecteur REST générique prend en charge ce qui suit :
- La copie de données à partir d’un point de terminaison REST à l’aide des méthodes GET ou POST et la copie de données vers un point de terminaison REST à l’aide des méthodes POST, PUT ou PATCH.
- La Pagination dans les API REST.
- Pour REST en tant que source, copiez la réponse JSON REST telle quelle ou analysez-la à l'aide du mappage de schéma. Seule la charge utile de réponse au format JSON est prise en charge.
Configuration prise en charge
Pour la configuration de chaque onglet sous une activité de copie, accédez respectivement aux sections suivantes.
Général
Pour la configuration de l'onglet Général, accédez à Général.
Source
Les propriétés suivantes sont prises en charge pour REST sous l'onglet Source d'une activité de copie.
Les trois premières propriétés suivantes sont requises :
- Type de magasin de données : Sélectionnez Externe.
- Connexion : Sélectionnez une connexion REST dans la liste des connexions. Si aucune connexion n'existe, créez une nouvelle connexion REST en sélectionnant Nouveau.
- Type de connexion : Sélectionnez REST.
- URL relative : Une URL relative à la ressource qui contient les données. Quand cette propriété n’est pas spécifiée, seule l’URL indiquée dans la définition de connexion est utilisée. Le connecteur HTTP copie les données à partir de l’URL combinée :
[URL specified in connection]/[relative URL specified].
Sous Avancé, vous pouvez spécifier les champs suivants :
Méthode de demande : méthode HTTP. Les valeurs autorisées sont GET (par défaut) et POST.
Délai d’expiration : Le délai (valeur TimeSpan) pour l’obtention d’une réponse par la demande HTTP. Cette valeur correspond au délai d’expiration pour l’obtention d’une réponse, et non au délai d’expiration pour la lecture des données de la réponse. La valeur par défaut est 00:01:40.
Intervalle de demande (ms): Intervalle de temps entre différentes requêtes pour plusieurs pages en millisecondes. La valeur de l’intervalle de demande doit être un nombre compris entre [10, 60000].
En-têtes supplémentaires : en-têtes de demande HTTP supplémentaires.
Règles de pagination: Les règles de pagination pour composer les requêtes de page suivante. Reportez-vous à la section de support de pagination pour plus de détails.
Colonnes supplémentaires: Ajoutez plus de colonnes de données pour stocker le chemin relatif ou la valeur statique des fichiers source. Si vous utilisez une valeur statique, vous pouvez utiliser des expressions personnalisées pour la générer.
Destination
Les propriétés suivantes sont prises en charge pour REST sous l'onglet Destination d'une activité de copie.
Les trois premières propriétés suivantes sont requises :
- Type de magasin de données: Sélectionner Externe.
- Connexion: Sélectionnez une connexion REST dans la liste des connexions. Si aucune connexion n'existe, créez une nouvelle connexion REST en sélectionnant Nouveau.
- Type de connexion : Sélectionnez REST.
- URL relative : Une URL relative à la ressource qui contient les données. Quand cette propriété n’est pas spécifiée, seule l’URL indiquée dans la définition de connexion est utilisée. Le connecteur HTTP copie les données à partir de l’URL combinée :
[URL specified in connection]/[relative URL specified].
Sous Avancé, vous pouvez spécifier les champs suivants :
Méthode de demande : méthode HTTP. Les valeurs autorisées sont POST (valeur par défaut), PUT et PATCH.
Délai d’expiration : Le délai (valeur TimeSpan) pour l’obtention d’une réponse par la demande HTTP. Cette valeur correspond au délai d’expiration pour l’obtention d’une réponse, et non au délai d’expiration pour l’écriture des données. La valeur par défaut est 00:01:40.
Intervalle de demande (ms): Intervalle de temps entre différentes requêtes pour plusieurs pages en millisecondes. La valeur de l’intervalle de demande doit être un nombre compris entre [10, 60000].
Taille du lot d'écriture : nombre d'enregistrements à écrire dans la destination REST par lot. La valeur par défaut est 10 000.
Type de compression HTTP : type de compression HTTP à utiliser lors de l'envoi de données avec un niveau de compression optimal. Les valeurs autorisées sont None et GZip.
En-têtes supplémentaires: En-têtes de requête HTTP supplémentaires.
Mappage
Pour la configuration de l'onglet Mapping, accédez à Configurer vos mappings sous l'onglet mapping. Le mappage n'est pas pris en charge lorsque la source et la destination sont des données hiérarchiques.
Paramètres
Pour la configuration de l’onglet Paramètres, accédez à Configurer vos autres paramètres sous l’onglet Paramètres.
Résumé du tableau
Les tableaux suivants contiennent plus d'informations sur l'activité de copie dans REST.
Informations sur la source
| Nom | Description | Valeur | Obligatoire | Propriété de script JSON |
|---|---|---|---|---|
| Type de banque de données | Votre type de magasin de données. | • Espace de travail • Externe • Exemple d'ensemble de données |
Oui | type |
| Connection | Votre connexion au magasin de données source. | <votre connexion> | Oui | connection |
| Type de connexion | Votre type de connexion. Sélectionnez REST. | REST | Oui | type : RestResource |
| URL relative | URL relative de la ressource qui contient les données. Quand cette propriété n’est pas spécifiée, seule l’URL indiquée dans la définition de connexion est utilisée. Le connecteur HTTP copie les données à partir de l’URL combinée : [URL specified in connection]/[relative URL specified]. |
<votre URL relative de serveur> | Non | relativeUrl |
| Méthode de demande | Méthode HTTP. Les valeurs autorisées sont GET (par défaut) et POST. | • OBTENIR • POST |
Non | requestMethod |
| Délai d’expiration de la demande | Délai d’expiration (la valeur TimeSpan) pour l’obtention d’une réponse par la demande HTTP. Cette valeur correspond au délai d’expiration pour l’obtention d’une réponse, et non au délai d’expiration pour la lecture des données de la réponse. La valeur par défaut est 00:01:40. | intervalle de temps | Non | httpRequestTimeout |
| Intervalle de requête (ms) | Intervalle de temps entre différentes requêtes pour plusieurs pages en millisecondes. La valeur de l’intervalle de demande doit être un nombre compris entre [10, 60000]. | [10, 60000] | Non | requestInterval |
| En-têtes supplémentaires | En-têtes de requête HTTP supplémentaires. | <vos en-têtes supplémentaires> | Non | additionalHeaders |
| Règles de pagination | Règles de pagination pour composer des requêtes de page suivantes. Reportez-vous à la section de support de pagination pour plus de détails. | Accéder à la pagination | Non | paginationRules |
| Colonnes supplémentaires | Ajoutez plus de colonnes de données au chemin relatif ou à la valeur statique des fichiers source du magasin. L’expression est prise en charge pour ce dernier. | • Name • Valeur |
Non | additionalColumns : • nom • valeur |
Informations de destination
| Nom | Description | Valeur | Obligatoire | Propriété de script JSON |
|---|---|---|---|---|
| Type de banque de données | Votre type de magasin de données. | • Espace de travail • Externe |
Oui | type |
| Connection | Votre connexion au magasin de données source. | <votre connexion> | Oui | connection |
| Type de connexion | Votre type de connexion. Sélectionnez REST. | REST | Oui | type : RestResource |
| URL relative | URL relative de la ressource qui contient les données. Quand cette propriété n’est pas spécifiée, seule l’URL indiquée dans la définition de connexion est utilisée. Le connecteur HTTP copie les données à partir de l’URL combinée : [URL specified in connection]/[relative URL specified]. |
<votre URL relative de serveur> | Non | relativeUrl |
| Méthode de demande | Méthode HTTP. Les valeurs autorisées sont POST (valeur par défaut), PUT et PATCH. | • POST • OBTENIR • CORRECTIF |
Non | requestMethod |
| Délai d’expiration de la demande | Délai d’expiration (la valeur TimeSpan) pour l’obtention d’une réponse par la demande HTTP. Cette valeur correspond au délai d’expiration pour l’obtention d’une réponse, et non au délai d’expiration pour la lecture des données de la réponse. La valeur par défaut est 00:01:40. | intervalle de temps | Non | httpRequestTimeout |
| Intervalle de requête (ms) | Intervalle de temps entre différentes requêtes pour plusieurs pages en millisecondes. La valeur de l’intervalle de demande doit être un nombre compris entre [10, 60000]. | [10, 60000] | Non | requestInterval |
| Écrire la taille du lot | Nombre d'enregistrements à écrire dans la destination REST par lot. La valeur par défaut est 10 000. | <Nombre de rangées> (entier) |
Non | writeBatchSize |
| Type de compression HTTP | Type de compression HTTP à utiliser lors de l’envoi de données avec un niveau de compression optimal. Les valeurs autorisées sont None et GZip. | • Aucun • GZip |
Non | httpCompressionType |
| En-têtes supplémentaires | En-têtes de requête HTTP supplémentaires. | <vos en-têtes supplémentaires> | Non | additionalHeaders |