Les commandes de cet article sont utilisées avec le connecteur Workiva Chains. Pour trouver vos identifiants de chaîne, consultez cet article sur trouver des identifiants dans Workiva.
Connecteur à l'API Workiva Rest
Sauf indication contraire, réglez la valeur pour qu'elle corresponde à votre Appspot.
| Entrée | Type | AppSpot | Détail |
| URL de base | Champ de texte | Prod (US) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| URL de base | Champ de texte | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| URL de base | Champ de texte | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Exécuter la chaîne
Exécute une chaîne et attend qu'elle se termine.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-startchain/
Note: Bien que cette commande puisse être utilisée lorsqu'un identifiant de chaîne dynamique est requis, nous recommandons d'utiliser un événement d'exécution de chaîne dans la plupart des cas. L'événement Run Chain est plus étroitement lié à la chaîne en cours d'exécution et offre une expérience utilisateur plus simple.
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement. |
| ID de la chaîne | Champ de texte | L'ID de la chaîne. |
| Variables d’exécution | Champ de groupe | Les valeurs des variables d'exécution utilisées dans la chaîne. |
| Intervalle d'interrogation | Champ numérique | Facultatif: Le temps (en secondes) à attendre avant de vérifier si la chaîne s'est terminée. La valeur par défaut est de cinq secondes et ne doit être ajustée que si vous prévoyez que votre chaîne fonctionnera longtemps. |
Sorties
| Sortie | Type de sortie |
| Course en chaîne | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Trouver des chaînes de production par valeur d'entrée
Récupère toutes les exécutions en chaîne qui contiennent le texte fourni.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement que vous recherchez. |
| Texte de recherche | Champ de texte | La valeur d'entrée à rechercher. |
| Résultats maximaux | Champ numérique | Le nombre maximum de résultats à extraire. Utilisez 0 pour récupérer tous les éléments. |
Sorties
| Sortie | Type de sortie |
| Courses en chaîne | Fichier |
| Nombre de passages de la chaîne | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir une chaîne
Récupère les propriétés d'une chaîne.
Appel API équivalent : https://developers.workiva.com/chains-v1/chains-getchain/
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement cible. |
| ID de la chaîne | Champ de texte | L'ID de la chaîne. |
Sorties
| Sortie | Type de sortie |
| Chaîne | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Commandes d'obtention de la chaîne
Récupère les propriétés de toutes les commandes d'une chaîne.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getcommands/
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement cible. |
| ID de la chaîne | Champ de texte | L'ID de la chaîne. |
Sorties
| Sortie | Type de sortie |
| Commandes | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir l'historique de la chaîne
Récupère l'historique des exécutions d'une chaîne.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement cible. |
| ID de la chaîne | Champ de texte | L'ID de la chaîne. |
| Résultats maximaux | Champ numérique | Le nombre maximum de résultats à extraire. Utilisez 0 pour récupérer tous les éléments. |
| Date de début | Champ de texte | Filtre les exécutions en chaîne qui ont eu lieu après la date de début spécifiée. Cette valeur peut utiliser le format ISO8601 ou un horodatage Unix. |
| Date de fin | Champ de texte | Filtre les exécutions en chaîne qui ont eu lieu avant la date de fin spécifiée. Cette valeur peut utiliser le format ISO8601 ou un horodatage Unix. |
Sorties
| Sortie | Type de sortie |
| Courses en chaîne | Fichier |
| Nombre de passages de la chaîne | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir une course en chaîne
Obtenir les détails d'exécution d'une chaîne.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getchainrun/
Les entrées
| Entrée | Type | Détail |
| ID d'exécution de la chaîne | Champ de texte | L'ID de l'exécution de la chaîne. |
Sorties
| Sortie | Type de sortie |
| Course en chaîne | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir l'exécution d'une chaîne avec des nœuds
Obtenir les détails d'une exécution en chaîne, y compris les détails du nœud.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Les entrées
| Entrée | Type | Détail |
| ID d'exécution de la chaîne | Champ de texte | L'ID de l'exécution de la chaîne. |
Sorties
| Sortie | Type de sortie |
| Course en chaîne | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir des chaînes
Récupère toutes les chaînes et leurs propriétés dans un environnement spécifique.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getchains/
Les entrées
| Entrée | Type | Détail |
| ID de l'environnement | Champ de texte | L'ID de l'environnement cible. |
Sorties
| Sortie | Type de sortie |
| Chaînes | Fichier |
| Nombre de chaînes | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir l'environnement
Récupère les propriétés d'un environnement spécifique.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getenvironment/
Les entrées
| Entrée | Type | Détail |
| ID de l'espace de travail | Champ de texte | L'ID de l'espace de travail où vit l'environnement. |
| ID de l'environnement | Champ de texte | L'ID de l'environnement cible. |
Sorties
| Sortie | Type de sortie |
| Environnement | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir des environnements
Récupère la liste des environnements d'un espace de travail.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getenvironments/
Les entrées
| Entrée | Type | Détail |
| ID de l'espace de travail | Champ de texte | L'ID de l'espace de travail contenant les environnements. |
Sorties
| Sortie | Type de sortie |
| Environnements | Fichier |
| Nombre d'environnements | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir l'espace de travail
Récupère un espace de travail et ses propriétés.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getworkspace/
Les entrées
| Entrée | Type | Détail |
| ID de l'espace de travail | Champ de texte | L'ID de l'espace de travail. |
Sorties
| Sortie | Type de sortie |
| Espace de travail | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Obtenir des espaces de travail
Récupère la liste de tous les espaces de travail d'une entreprise.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Les entrées
Aucune
Sorties
| Sortie | Type de sortie |
| Espaces de travail | Fichier |
| Nombre d'espaces de travail | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Publier le groupe de cartographie
Publie un groupe de mappage, tel que spécifié par le GUID du groupe de mappage.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-publish/
Les entrées
| Entrée | Type | Détail |
| Groupe de mappage GUID | Champ de texte | Le GUID du groupe de mappage. |
Sorties
Aucune
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Recherche de parcours de chaîne
Recherche les chaînes qui correspondent aux filtres indiqués.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Note: Le paramètre environment_id n'est pas nécessaire pour les superutilisateurs ou les administrateurs d'org.
Les entrées
| Entrée | Type | Détail |
| Filtres | Champ de groupe | Les filtres à appliquer à la recherche. |
| Résultats maximaux | Champ numérique | Le nombre maximum de résultats à extraire. Utilisez 0 pour récupérer tous les éléments. |
Sorties
| Sortie | Type de sortie |
| Courses en chaîne | Fichier |
| Nombre de passages de la chaîne | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Chaîne d'arrêt
Arrête une chaîne en cours d'exécution.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-stopchain/
Les entrées
| Entrée | Type | Détail |
| ID d'exécution de la chaîne | Champ de texte | L'ID de la chaîne à arrêter. |
Sorties
| Sortie | Type de sortie |
| Course en chaîne | Fichier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |
Télécharger les règles de mappage
Charge un jeu de règles de groupe de mappage, comme spécifié par le GUID du groupe de mappage.
Appel API équivalent: https://developers.workiva.com/chains-v1/chains-updaterules/
Les entrées
| Entrée | Type | Détail |
| Groupe de mappage GUID | Champ de texte | Le GUID du groupe de mappage. |
| Mode téléchargement | Champ déroulant | Le mode de téléchargement. Lorsque mode=published, la version publiée est mise à jour et republiée. Lorsque mode=draft, seul le projet est mis à jour. Lorsque mode=both, la version publiée et le brouillon sont tous deux mis à jour. |
| Fichier de règles de mappage | Champ de fichier | Le fichier contenant les règles de mappage à télécharger. |
Sorties
| Sortie | Type de sortie |
| Erreurs de téléchargement | Fichier |
| Télécharger le résultat | Fichier |
| Nombre de règles téléchargées | Entier |
| Nombre d'erreurs | Entier |
Codes de sortie
| Code de sortie | Type | Détail |
| 0 | Réussite | Réussite |
| 1 | Erreur | Échec général |
| 2 | Erreur | Échec de l'authentification |