Accéder au contenu principal Passer au contenu complémentaire

Accéder à la documentation de l'API REST de Talend Data Stewardship

L'API REST simplifie vos interactions avec les données stockées sur le serveur de Talend Data Stewardship 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 sur les utilisateurs et utilisatrices, les campagnes, les schémas, les tâches et l'historique des tâches. Vous pouvez télécharger un fichier JSON à partir des pages de documentation de l'API REST.

Procédure

  1. Démarrez tous les modules dans le dossier d'installation de Talend Data Stewardship.
  2. Ouvrez un navigateur Web et saisissez l'URL suivante, dans laquelle les valeurs de l'hôte et du port dépendent de votre installation.
    http://<host>:<port>/docs/api/swagger-ui.html
    La page Data Stewardship API s'ouvre et les opérations sont classées en différentes catégories.
  3. Cliquez sur le nom d'une catégorie pour afficher ou masquer ses opérations.
  4. Commencez à tester l'exécution des différentes opérations.
    Résolution de problèmes : Utiliser une URL avec un nom d'ordinateur dans Swagger provoque une erreur dans l'URL générée pour les endpoints de service. Talend recommande d'utiliser une URL localhost pour accéder à Swagger, par exemple : http://localhost:19999//docs/api/swagger-ui.html.

    Sinon, l'URL générée ressemblera à ceci : http://<computer-name>.talend.com:19999/data-stewardship/internal/data-stewardship/api/v1/campaigns?taskType=ARBITRATION. Vous devez supprimer le premier data-stewardship.

  5. Pour accéder aux autres pages de documentation, cliquez dans le champ en haut de la page et choisissez d'accéder à la page Data Models Service ou à la page Data Stewardship History Service.
    Les API du modèle de données se trouvent dans Data Models Service et l'espace de noms par défaut pour toutes les API de service est org.talend.schema.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – dites-nous comment nous améliorer !

Laissez vos commentaires ici