Exemples de champs de recherche externe dans un formulaire personnalisé

Ouvrez le formulaire personnalisé.

Dans la partie gauche de l’écran, recherchez Recherche externe et faites-le glisser vers une section de la zone de travail.

Saisissez le Libellé et Nom pour le champ .

Sélectionnez la variable Format pour le champ .

Saisissez l’appel d’URL d’API dans la variable URL de l’API de base champ .

• Vous pouvez ajouter $$HOST pour référencer la même instance.
• Vous pouvez ajouter $$QUERY pour filtrer les résultats en fonction de l’interrogation d’un autre champ.

Exemple
$$HOST/attask/api/v15.0/project/search?status={DE:StatusQuery}&$$QUERY

Consultez la section Dépendances pour les champs référencés par ce champ de recherche dans l’API.

Un champ de dépendance peut être n’importe quel champ personnalisé ou natif existant dans la page de détails de l’objet.

Dans cet exemple, la variable {DE:StatusQuery} sera remplacé par la valeur du champ personnalisé StatusQuery .

Sélectionnez la variable Méthode HTTP.

Cela sera probablement le cas Get.

Saisissez le Chemin JSON pour obtenir les résultats de votre appel API.

Exemple
$.data[*].name

Cliquez sur Appliquer.

Lorsque le formulaire personnalisé est ajouté à un objet Workfront (dans cet exemple, un projet), il ressemble à ceci.

Ouvrez le formulaire personnalisé.

Dans la partie gauche de l’écran, recherchez Recherche externe et faites-le glisser vers une section de la zone de travail.

Saisissez le Libellé et Nom pour le champ .

Sélectionnez la variable Format pour le champ .

Saisissez l’appel d’URL d’API dans la variable URL de l’API de base champ .

• Vous pouvez ajouter $$QUERY pour implémenter le filtrage des requêtes pour vos utilisateurs finaux.

Exemples
Répertorie tous les pays : https://api.first.org/data/v1/countries

Permet à l’utilisateur de rechercher n’importe quel pays dans le champ déroulant : https://api.first.org/data/v1/countries?q=$$QUERY

Permet à l’utilisateur de rechercher un pays dans une région : https://api.first.org/data/v1/countries?region={DE:Region}&q=$$QUERY

• Les régions disponibles sont définies dans un champ personnalisé distinct dans Workfront.
• Lorsque l’utilisateur sélectionne une région sur le formulaire, le champ Recherche externe affiche uniquement les pays de cette région (le pays dans lequel la région est définie dans l’API). L’utilisateur peut également rechercher un pays dans la région sélectionnée.

Consultez la section Dépendances pour les champs référencés par ce champ de recherche dans l’API.

Un champ de dépendance peut être n’importe quel champ personnalisé ou natif existant dans la page de détails de l’objet.

Dans cet exemple, la variable {DE:Region} sera remplacé par la valeur du champ personnalisé Région .

Sélectionnez la variable Méthode HTTP.

Cela sera probablement le cas Get.

Saisissez le Chemin JSON pour obtenir les résultats de votre appel API.

Cette option permet d’extraire des données du code JSON renvoyé par l’URL de l’API. Il sert à sélectionner les valeurs qui, à l’intérieur du fichier JSON, apparaîtront dans les options de la liste déroulante.

Exemple
$.data[*].country

(Facultatif) Cliquez sur Ajouter un en-tête et saisissez ou collez la paire clé-valeur requise pour l’authentification avec l’API.

(Facultatif) Sélectionnez Menu déroulant à sélection multiple pour permettre à l’utilisateur de sélectionner plusieurs valeurs dans la liste déroulante.

Cliquez sur Appliquer.

Lorsque le formulaire personnalisé est ajouté à un objet Workfront (dans cet exemple, un projet), il ressemble à ceci.