Accès à la documentation API REST de Talend Data Preparation

Guide utilisateur de Talend Data Preparation

author
Talend Documentation Team
EnrichVersion
6.4
2.1
EnrichProdName
Talend Data Services Platform
Talend Big Data Platform
Talend ESB
Talend Data Management Platform
Talend Data Integration
Talend Data Fabric
Talend Big Data
Talend Real-Time Big Data Platform
Talend MDM Platform
task
Qualité et préparation de données > Nettoyage de données
EnrichPlatform
Talend Data Preparation

L'API REST simplifie votre interaction avec les données stockées sur le serveur Talend Data Preparation, en utilisant plusieurs types de méthodes ou de requêtes.

Vous pouvez accéder à toutes les pages de la documentation de l'API REST, basée sur Swagger et exécuter des requêtes.

Tout d'abord, vous allez devoir activer l'accès à Swagger en éditant l'un des paramètres dans le fichier de configuration de Talend Data Preparation.

Procédure

  1. Ouvrez le fichier de configuration <Installation_Path>/dataprep/config/application.properties.
  2. Saisissez la valeur true pour le paramètre service.documentation.
    # Service documentation
    service.documentation=true
    service.documentation.name=Talend Data Preparation - API
    service.documentation.description=This service exposes high level services that may involve services orchestration.
    service.paths=api
  3. Redémarrez Talend Data Preparation.
  4. Ouvrez votre navigateur Internet et saisissez l'URL suivante, où l'hôte et le port correspondent à l'URL de votre instance de Talend Data Preparation :
    http://<host>:<port>/docs/index.html

    La page Talend Data Preparation - API s'ouvre, où les opérations sont classées dans différentes catégories, comme illustré ci-dessous :

  5. Cliquez sur le nom d'une catégorie pour afficher la liste des opérations disponibles pour cette catégorie.
  6. Commencez à tester l'exécution des différentes opérations.