Accéder à la documentation de l'API REST de Talend Dictionary Service - 7.3

Guide d'administration de Talend Dictionary Service

EnrichVersion
7.3
EnrichProdName
Talend Big Data Platform
Talend Data Fabric
Talend Data Management Platform
Talend Data Services Platform
Talend MDM Platform
Talend Real-Time Big Data Platform
EnrichPlatform
Talend Data Preparation
Talend Data Stewardship
task
Qualité et préparation de données > Gestion des types sémantiques

L'API REST simplifie vos interactions avec les données stockées sur le serveur de Talend Dictionary Service en utilisant un certain nombre de méthodes ou de types 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. Vous pouvez télécharger un fichier JSON à partir des pages de documentation de l'API REST.

Avant de commencer

Vous devez avoir installé et configuré Talend Dictionary Service lors de l'installation de Talend Data Stewardship ou de Talend Data Preparation.

Procédure

  1. Démarrez tous les modules dans le dossier d'installation de Talend Data Stewardship ou Talend Data Preparation, selon l'application depuis laquelle vous souhaitez accéder à la documentation.
    Remarque : Pour accéder à l'API REST de Talend Dictionary Service depuis Talend Data Preparation, vous devez d'abord configurer la valeur du paramètre service.documentation à true dans le fichier de configuration <Installation_Path>/dataprep/config/application.properties.
  2. Ouvrez un navigateur Web et saisissez l'URL suivante où <host> et <port> dépendent de votre installation :
    http://<host>:<port>/docs/api/swagger-ui.html
  3. Dans le champ en haut de la page, sélectionnez Semantic Service pour ouvrir la page de documentation de Talend Dictionary Service dans laquelle les opérations sont classées en différentes catégories.

    Exemple

  4. Cliquez sur un nom de catégorie pour afficher la liste d'opérations de la catégorie.
  5. Dans la liste des catégories :
    Sélectionnez Pour
    Show/Hide afficher ou masquer la liste des opérations
    List Operations développer ou réduire la liste des opérations
    Expand Operations développer les détails de l'opération
  6. Cliquez sur user-controller > /user/login et utilisez vos identifiants pour vous connecter.
    Dans la zone Response Headers, vous obtenez un jeton (bearer) d'authentification.
  7. Commencez à tester l'exécution des différentes opérations.

    Pour obtenir les résultats des opérations exécutées, utilisez la commande Curl obtenue dans la réponse.

    Ajoutez le jeton (bearer) d'authentification obtenu lorsque vous vous êtes connecté dans l'en-tête d'autorisation.

    Exemple

    curl -X GET --header 'Authorization: Bearer <token>' --header 'Accept: application/json' 'http://<host>:<port>/categories?caseSensitive=false&isExact=false'