Pour automatiser des tâches au sein de la plateforme Workiva dans le cadre d’une chaîne, par exemple pour permettre l’échange de données avec d’autres sources de données, ajoutez une étape qui inclut une commande de connexion Workiva.
Pour activer ces commandes, un administrateur informatique doit d’abord configurer un connecteur Workiva.
Effacer les données de la feuille
Pour effacer toutes les données d’une feuille, utilisez la commande Effacer les données de la feuille.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul contenant la feuille à effacer. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille à effacer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer un fichier
Pour charger un fichier CSV (valeurs séparées par des virgules), JSON (Javascript object notation) ou ZIP compressé et dresser la liste de ses enregistrements, utilisez la commande Créer un fichier. Vous pouvez également charger l’URL du fichier, par exemple une URL signée Amazon S3® pour un fichier dans un panier S3.
- S’il s’agit d’un fichier JSON, il doit comporter un seul enregistrement JSON par ligne. Un fichier JSON est une série d’objets JSON délimités par un caractère de retour à la ligne.
- S’il s’agit d’un fichier ZIP, il doit contenir un seul fichier CSV ou JSON, dont le nom est utilisé pour nommer le fichier importé. En téléchargeant à nouveau le fichier, vous téléchargez la source.
- S’il s’agit d’une URL, le point d’accès demande à obtenir un fichier à l’aide d’une simple requête
GETnon authentifiée.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant du tableau dont vous souhaitez répertorier les fichiers. |
| Fichier | Entrez le fichier à charger. Ignoré si l’URL du téléchargement est entrée. Note : le fichier doit avoir une extension .CSV ou .JSON, ou être un fichier ZIP qui contient un fichier avec une extension .CSV ou .JSON. |
| Nom | Si l’URL du téléchargement est entrée, entrez le nom du fichier à charger ; par défaut, le nom de base est URL du téléchargement. |
| URL du téléchargement | Entrez l’URL qui pointe vers le fichier à télécharger, par exemple une URL signée Amazon S3. Facultatif si le Fichier est entré. Note : la commande effectue une simple requête |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultats | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer de nouvelles modifications d’enregistrements
Pour créer de nouvelles modifications d’enregistrements à partir des propriétés fournies, utilisez la commande Créer de nouvelles modifications d’enregistrements. Chaque modification nécessite au moins une opération et un targetId.
Limite : Jusqu’à 1000 vérifications peuvent être traitées par demande.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-createedits/
Propriétés
| Propriété | Détail |
|---|---|
| Opération |
Sélectionnez l’opération à effectuer. Options :
|
| Étiquette | Entrez une étiquette décrivant la relation entre les deux enregistrements. Permet de créer ou de supprimer une relation. |
| Propriétés | Entrez les propriétés liées au type d’enregistrement. Permet de créer un enregistrement ou de définir ses propriétés. |
| ID de l’enregistrement | Entrez l’ID ou l’ID de l’enregistrement temporaire de la source. Permet de créer ou de supprimer une relation. |
| ID cible | Entrez l’ID de l’enregistrement cible. Si vous créez un enregistrement, vous pouvez utiliser l’ID de l’enregistrement ou l’ID de l’enregistrement temporaire ; si vous supprimez un enregistrement, vous devez utiliser l’ID de l’enregistrement réel. |
| ID de l’enregistrement temporaire | Entrez l’ID temporaire qui sera utilisé lors de la création d’un enregistrement ; cet ID temporaire est remplacé au moment du traitement. Vous pouvez utiliser cet ID dans la même requête pour créer des relations entre les enregistrements créés. |
| Type | Entrez le type d’enregistrement à créer. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisé dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer un affichage croisé dynamique
Pour créer un nouvel affichage Wdata à partir de la requête et du résultat de la requête, utilisez la commande Créer un affichage croisé dynamique.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Propriétés
| Propriété | Détail |
|---|---|
| Nom | Entrez un nom unique pour identifier l’affichage. |
| ID de la requête | Entrez l’ID de la requête à partir de laquelle l’affichage doit être créé. |
| ID du résultat de la requête | Entrez l’ID du résultat de la requête à partir duquel l’affichage doit être créé. |
| Métadonnées supplémentaires | Entrez les métadonnées définies par l’utilisateur à joindre à l’affichage sous la forme d’un objet JSON (facultatif). |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisé dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer une requête de prévisualisation
Pour créer une requête temporaire de prévisualisation sur un tableau qui peut ensuite être exécutée, utilisez la commande Créer une requête de prévisualisation.
Appel API équivalent : N/A
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’ID du tableau à interroger. |
| Limite | Entrez le nombre maximum de résultats à renvoyer. |
| Fichier | Si spécifié, entrez le nom du fichier dans le tableau à interroger. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer une requête
Pour créer une nouvelle requête Wdata, utilisez la commande Créer une requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createquery/
Propriétés
| Propriété | Détail |
|---|---|
| Nom | Entrez un nom unique pour identifier la requête. |
| Description | Entrez une description de la requête. |
| ID du résultat principal | Si cette option est spécifiée, entrez l’ID du résultat par défaut à ajouter aux résultats de la requête. |
| Texte de la requête | Entrez la définition de la requête en syntaxe Presto SQL, comme vous le feriez dans l’éditeur SQL de la requête. |
| Temporaire | Pour générer temporairement la requête afin qu’elle n’apparaisse pas dans votre espace de travail, cochez cette case. |
| Paramètres | Entrez les paramètres nécessaires à l’exécution de la requête. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer un enregistrement
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour créer un nouvel enregistrement, utilisez le point de terminaison Créer de nouvelles modifications d’enregistrements.
Créer une liste de sélection
Pour créer une liste de valeurs pour un paramètre de requête à sélection multiple, utilisez la commande Créer une liste de sélection.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Propriétés
| Propriété | Détail |
|---|---|
| Nom | Entrez un nom unique pour identifier la liste de sélection. |
| Description | Pour mieux identifier la liste de sélection, entrez une description de ses valeurs ou de son paramètre. |
| Type de valeur | Sélectionnez le type de données des valeurs de la liste, par exemple chaîne de caractères ou nombre entier. |
| Valeurs | Entrez les valeurs de la liste. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Créer des métadonnées de liste de sélection | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur |
Erreur |
Créer une feuille
Pour ajouter une nouvelle feuille à une feuille de calcul, utilisez la commande Créer une feuille.
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul à laquelle vous souhaitez ajouter la feuille. |
| Nom | Entrez un nom unique pour aider à identifier la feuille. |
| Index des feuilles | Entrez l’index de la nouvelle feuille dans la feuille de calcul. Note : par défaut, la commande ajoute la feuille comme feuille supérieure. |
| ID de la feuille mère | Entrez l’ID de la feuille mère sous laquelle la feuille doit être créée. Pour ajouter à la feuille de calcul racine, laissez ce champ vide. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Métadonnées de la feuille | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer une feuille de calcul
Pour créer une nouvelle feuille de calcul, utilisez la commande Créer une feuille de calcul.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Propriétés
| Propriété | Détail |
|---|---|
| Nom | Entrez le nom unique permettant d’identifier la feuille de calcul. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Métadonnées de la feuille | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Créer un tableau
Pour créer une nouvelle table Wdata dans votre espace de travail, utilisez la commande Créer un tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createtable/
Propriétés
| Propriété | Détail |
|---|---|
| Nom | Entrez un nom unique pour identifier le tableau. |
| Description | Entrez une description du nouveau tableau. |
| Type | Choisissez de créer une table de données (ou de faits) ou un tableau de recherche (ou de dimension). |
| Colonnes | Ajouter les colonnes à inclure dans le tableau :
|
Sorties
| Sortie | Type de sortie |
|---|---|
| Tableau | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer le fichier
Pour supprimer un fichier de votre espace de travail Wdata, utilisez la commande Supprimer le fichier.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletefile/
Propriétés
| Propriété | Détail |
|---|---|
| ID du fichier | Entrez l’ID du fichier à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer l’affichage croisé dynamique
Pour supprimer un affichage Wdata de votre espace de travail, utilisez la commande Supprimer l’affichage croisé dynamique.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Propriétés
| Propriété | Détail |
|---|---|
| ID | Entrez l’ID de l’affichage à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer la requête
Pour supprimer une requête Wdata de votre espace de travail, utilisez la commande Supprimer la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletequery/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la requête | Entrez l’ID de la requête à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer l’enregistrement
Supprimer la feuille
Pour supprimer une feuille et ses feuilles enfants (récursivement) d’une feuille de calcul, utilisez la commande Delete sheet.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/deletelegacysheet.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul contenant la feuille à supprimer. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer la feuille de calcul
Pour supprimer une feuille de calcul de votre espace de travail, utilisez la commande Supprimer la feuille de calcul.
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer le tableau
Pour supprimer un tableau Wdata de votre espace de travail, utilisez la commande Supprimer le tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletetable/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant unique du tableau à supprimer |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Télécharger le fichier
Pour télécharger un jeu de données à partir de votre espace de travail Wdata, utilisez la commande Télécharger le fichier.
Note : cette commande n’est pas compatible avec d’autres types d’objets tels que les feuilles de calcul, les tableaux ou les requêtes.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Propriétés
| Propriété | Détail |
|---|---|
| ID du fichier | Entrez l’ID du fichier à télécharger. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Fichier | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
| Input | Detail |
| ID | Enter the ID of the pivot view to download |
Outputs
| Output | Output Type |
| Pivot View Content | File |
Exit Codes
| Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to download. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view content | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Télécharger les résultats de la requête
Pour télécharger les résultats d’une requête Wdata dans un fichier, utilisez la commande Télécharger les résultats de la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Propriétés
| Propriété | Détail |
|---|---|
| ID du résultat de la requête | Entrez l’ID du résultat de la requête à télécharger. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultat de la requête | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Édition
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour modifier un enregistrement, utilisez le point de terminaison Créer de nouvelles modifications d’enregistrements.
Exporter le fichier vers une feuille de calcul
Pour exporter un jeu de données d’un tableau Wdata vers une feuille de calcul nouvelle ou existante, utilisez la commande Exporter le fichier vers une feuille de calcul.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Propriétés
| Propriété | Détail |
|---|---|
| ID du fichier | Entrez l’ID du jeu de données du tableau à exporter. |
| URL de la feuille de calcul | Entrez l’URL de la feuille de calcul vers laquelle exporter. Pour créer une nouvelle feuille de calcul, laissez le champ vide. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Fiche info | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Exporter les résultats de la requête
Pour exporter les résultats d’une requête Wdata vers une feuille de calcul nouvelle ou existante, utilisez la commande Exporter les résultats de la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Propriétés
| Propriété | Détail |
|---|---|
| ID du résultat de la requête | Entrez l’ID des résultats de la requête à exporter. |
| URL de la feuille de calcul |
Entrez l’URL de la feuille de calcul vers laquelle exporter. Pour créer une nouvelle feuille de calcul, laissez le champ vide. |
| Exporter en tant que jeu de données |
Lorsque cette case est cochée, les données sont exportées sous la forme d’un jeu de données connecté et les cellules ne peuvent être éditées qu’en mettant à jour le jeu de données dans la feuille de calcul. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les propriétés du fichier
Pour récupérer les propriétés d’un fichier dans votre espace de travail Wdata, utilisez la commande Obtenir les propriétés du fichier.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getfile/
Propriétés
| Propriété | Détail |
|---|---|
| ID du fichier | Entrez l’ID du fichier dont vous souhaitez obtenir les propriétés. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Propriétés du fichier | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir un affichage croisé dynamique
Pour récupérer les métadonnées d’un affichage Wdata, utilisez la commande Obtenir un affichage croisé dynamique.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Propriétés
| Propriété | Détail |
|---|---|
| ID | Entrez l’identifiant de l’affichage croisé dynamique à partir duquel vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisé dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les métadonnées de la requête
Pour récupérer les métadonnées d’une requête Wdata, utilisez la commande Obtenir les métadonnées de la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getquery/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la requête | Entrez l’ID de la requête à partir de laquelle vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir un enregistrement
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour obtenir un enregistrement, utilisez le point de terminaison Récupérer un enregistrement unique.
Obtenir des enregistrements
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour obtenir plusieurs enregistrements, utilisez le point d’accès Récupérer la liste des enregistrements.
Obtenir des rapports
Pour récupérer tous les rapports du compte de base de données SOX et d’audit interne de votre organisation, utilisez la commande Obtenir des rapports.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-graphreportexport/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Rapports | Fichier |
| Nombre de rapports | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir la liste de sélection
Pour récupérer la liste des valeurs pour un paramètre de requête à sélection multiple en fonction de l’ID de la liste, utilisez la commande Obtenir la liste de sélection.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la liste de sélection | Entrez l’identifiant unique de la liste de sélection à récupérer. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Obtenir la charge utile de la liste de sélection | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les données de la feuille
Pour récupérer toutes les données d’une région spécifique d’une feuille, utilisez la commande Obtenir les données de la feuille.
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul avec la feuille à partir de laquelle les données doivent être obtenues. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille à partir de laquelle vous souhaitez obtenir des données. |
| Région | Entrez la représentation en style A1 d’une cellule ou d’une plage, par exemple [Colonne de départ][Ligne de départ] : [Colonne d’arrêt][Ligne d’arrêt]. Pour que l’intervalle ne soit pas borné dans une direction ou dans toutes les directions, ne tenez pas compte de la colonne ou de la ligne correspondante. |
| Style de valeur | Choisissez de renvoyer la valeur brute ou calculée de la cellule. Par exemple, si la valeur d’une cellule est =1+:1, sélectionnez Brut pour =1+1 ou Calculé pour la valeur calculée de 2. |
| Révision | Entrez la version de la feuille à partir de laquelle les données doivent être extraites. Pour la version actuelle, entrez -1. |
| Utiliser l'API de la plate-forme | Lorsque cette case est cochée, cette commande renvoie les données de la feuille en utilisant la notation décimale standard. S’il est vide, les données de la feuille sont renvoyées en utilisant la notation scientifique. Ceci forcera la commande à utiliser le point de terminaison Récupérer des données à partir d’une feuille plutôt que le point de terminaison de l’API du tableur Retourner des données à partir d’un point de terminaison de région. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Nombre de lignes | Entier |
| Données | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les métadonnées de la feuille
Pour récupérer les métadonnées d’une feuille de calcul, utilisez la commande Obtenir les métadonnées de la feuille.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/getsheetdata.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul contenant la feuille à partir de laquelle vous souhaitez obtenir des métadonnées. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille à partir de laquelle vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Métadonnées de la feuille | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les métadonnées de la feuille de calcul
Pour récupérer les métadonnées d’une feuille de calcul, utilisez la commande Obtenir les métadonnées de la feuille de calcul.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul à partir de laquelle vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Métadonnées de la feuille de calcul | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir les métadonnées du tableau
Pour récupérer les métadonnées d’un tableau Wdata, utilisez la commande Obtenir les métadonnées du tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-gettable/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant unique du tableau à partir duquel vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Tableau | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Obtenir le type
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour obtenir un enregistrement, utilisez le point de terminaison Récupérer un enregistrement unique.
Obtenir des types
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour obtenir plusieurs types d’enregistrements, utilisez le point de terminaison Récupérer la liste des types.
<!-- display page content -->
Contrôle d’intégrité
Pour vérifier l’intégrité de l’API Wdata, utilisez la commande Contrôle d’intégrité.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Réponse | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Importer un fichier dans un tableau
Pour importer un fichier dans un tableau Wdata, utilisez la commande Importer un fichier dans un tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-importfile/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’ID du tableau dans lequel le fichier doit être importé. |
| ID du fichier | Entrez l’ID du fichier à importer dans le tableau. |
| Mappages de colonnes | Mappez chaque colonne du fichier aux colonnes du tableau. |
| Exécution asynchrone | Pour que la commande s’exécute de manière asynchrone et pour ne pas attende que l’importation soit terminée avant de poursuivre avec la chaîne, cochez cette case. |
| Balises | Pour inclure les métadonnées que votre organisation suit à propos des données, ajoutez des balises et sélectionnez leur nom et leur valeur. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importation de fichiers | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Importer une feuille de calcul dans un tableau
Pour importer une feuille de calcul dans un tableau et renvoyer le résultat sous forme de méta-fichier, utilisez la commande Importer une feuille de calcul dans un tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant unique du tableau dans lequel le fichier doit être importé. |
| ID du fichier | Entrez l’identifiant unique du fichier dans lequel vous souhaitez importer la feuille de calcul (facultatif). |
| Nom du fichier | Entrez le nom unique à donner au fichier lors de son importation dans le tableau. |
| URL de la feuille de calcul | Entrez l’URL complète de la feuille de calcul à partir de laquelle vous souhaitez importer des données. |
| Exécution asynchrone | Pour que la commande s’exécute de manière asynchrone et pour ne pas attende que l’importation soit terminée avant de poursuivre avec la chaîne, cochez cette case. |
| Balises | Pour inclure les métadonnées que votre organisation suit à propos des données, ajoutez des balises et sélectionnez leur nom et leur valeur. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importation de fichiers | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les connexions
Pour répertorier les données entre les fonctionnalités de la plateforme Workiva, utilisez la commande Lister les connexions.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Propriété | Détail |
|---|---|
| Type de source | À l’aide du menu déroulant, sélectionnez le type de fichier ou d’élément dont vous souhaitez extraire les données. |
| Type de destination | À l’aide du menu déroulant, sélectionnez le type de fichier ou d’élément vers lequel envoyer les données. |
| ID source | Entrez l’identifiant unique du fichier ou de l’élément dont vous souhaitez extraire les données. |
| ID de destination | Entrez l’identifiant unique du fichier ou de l’élément vers lequel envoyer les données. |
Note : votre requête doit contenir soit Type de s ource + ID source, soit Type de destination + ID de destination ; la requête échouera si l’une de ces paires n’est pas présente.
Sorties
| Sortie | Type de sortie |
|---|---|
| Connexions | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les erreurs de fichiers
Pour dresser la liste des erreurs associées à un fichier, par exemple à la suite d’une importation, utilisez la commande Lister les erreurs de fichiers.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-geterrors/
Propriétés
| Propriété | Détail |
|---|---|
| ID du fichier | Entrez l’ID du fichier pour lequel vous souhaitez obtenir des erreurs. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Liste d’erreurs | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les fichiers
Pour obtenir la liste des fichiers d’un tableau Wdata et de leurs métadonnées, utilisez la commande Lister les fichiers.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getfiles/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant du tableau à partir duquel vous souhaitez obtenir des fichiers. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Liste des fichiers | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Liste des affichages croisés dynamiques
Pour répertorier les affichages Wdata de votre espace de travail et récupérer leurs métadonnées, utilisez la commande Liste des affichages croisés dynamiques.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichages croisés dynamiques | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les requêtes
Pour dresser la liste des requêtes Wdata dans votre espace de travail et récupérer leurs métadonnées, utilisez la commande Lister les requêtes.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listqueries/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Requêtes | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les résultats de la requête
Pour dresser la liste des résultats disponibles pour une requête Wdata, utilisez la commande Lister les résultats de la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la requête | Entrez l’ID de la requête dont vous souhaitez obtenir les résultats. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultats de la requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les listes de sélection
Pour répertorier toutes les listes de valeurs des paramètres de requête à sélection multiple dans votre espace de travail et extraire leurs métadonnées, utilisez la commande Lister les listes de sélection.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Lister les listes de sélection | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les feuilles
Pour dresser la liste de toutes les feuilles d’une feuille de calcul et récupérer leurs métadonnées, utilisez la commande Lister les feuilles.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/getlegacysheets.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul dont vous souhaitez lister les feuilles. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Feuilles | JSON |
| Nombre de feuilles | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les tableaux
Pour dresser la liste de tous les tableaux Wdata de votre espace de travail et récupérer leurs métadonnées, utilisez la commande Lister les tableaux.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-gettables/
Propriétés
Aucune
Sorties
| Sortie | Type de sortie |
|---|---|
| Liste des tableaux | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Lister les utilisateurs
Pour obtenir la liste des détails sur les utilisateurs d’une organisation, utilisez la commande Lister les utilisateurs. L’utilisateur chargé de l’intégration doit avoir le rôle d’administrateur de l’organisation pour exécuter cette commande.
Comme pour l’exportation « Affichage des personnes » de l’administrateur d’une organisation, les détails sont triés par nom d’affichage et incluent les noms des utilisateurs :
- Noms d’utilisateur
- Adresses e-mail
- ID SAML
- Dernières connexions
- Adhésions à l’espace de travail
- Licences et rôles
Appel API équivalent : https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Propriétés
| Propriété | Détail |
|---|---|
| ID de l’organisation | Entrez l’identifiant unique de l’organisation pour laquelle vous souhaitez répertorier les utilisateurs. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Rapport des utilisateurs | Fichier |
| Nombre d’enregistrements | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Écraser les données de la feuille
Pour effacer toutes les cellules d’une feuille et les remplacer par les valeurs fournies dans le fichier, utilisez la commande Écraser les données de la feuille.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/updatesheet.html#
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul dans laquelle vous souhaitez écraser les données de la feuille. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille dans laquelle les données doivent être écrasées. |
| Fichier de données | Entrez le fichier CSV contenant les données qui alimenteront la feuille. |
| Séparateur | Entrez le séparateur utilisé dans le fichier de données. |
| Utiliser l’API de la plateforme | Pour utiliser le format Saisies en des valeurs des cellules de la feuille de calcul, cochez cette case. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Ligne écrite | Entier |
| Cellules écrites | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Publier une feuille de calcul
Pour publier les liens dans une feuille de calcul, utilisez la commande Publier une feuille de calcul.
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul à publier. |
| Publier tous les liens | Sélectionnez les liens de la feuille de calcul à publier :
|
Sorties
| Sortie | Type de sortie |
|---|---|
| Message | Chaîne |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Actualiser la connexion
Pour actualiser une connexion spécifique en fonction de son ID, utilisez la commande Actualiser la connexion.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Propriétés
| Propriété | Détail |
|---|---|
| ID de connexion | Entrez l’identifiant unique de la connexion à actualiser. |
| Utiliser les paramètres de la source précédente | Cochez cette case pour utiliser les paramètres sources de l’exécution précédente ; cela remplace tous les autres paramètres sources que vous avez spécifiés. Cette entrée sera ignorée par le point de terminaison « Actualiser le lot de connexions ». |
| Paramètres sources* |
Entrez les paramètres à envoyer à la source en cas d’actualisation réussie. (Ces paramètres seront ignorés si l’option « Utiliser les paramètres de la source précédente » est activée.) |
| Utiliser les paramètres de la destination précédente | Cochez cette case pour utiliser les paramètres de la destination de l’exécution précédente ; cela remplace tous les autres paramètres de destination que vous avez spécifiés. Cette entrée sera ignorée par le point de terminaison « Actualiser le lot de connexions ». |
| Paramètres de destination* |
Entrez les paramètres à envoyer à la destination en cas d’actualisation réussie. (Ces paramètres seront ignorés si l’option « Utiliser les paramètres de la destination précédente » est activée.) |
Note : les paramètres à sélection multiple ne sont pas pris en charge actuellement.
Sorties
| Sortie | Type de sortie |
|---|---|
| Actualiser le statut | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Actualiser le lot de connexions
Pour actualiser plusieurs connexions à la fois, utilisez la commande Actualiser le lot de connexions.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Propriétés
| Propriété | Détail |
|---|---|
| Connexions |
Permet d’activer ou de désactiver l’utilisation des variables. Lorsqu’elle est activée :
|
| ID de connexion | Entrez l’identifiant unique de la connexion à actualiser. |
| Utiliser les paramètres de la source précédente | Cochez cette case pour utiliser les paramètres sources de l’exécution précédente ; cela remplace tous les autres paramètres sources que vous avez spécifiés. Cette entrée sera ignorée par le point de terminaison « Actualiser le lot de connexions ». |
| Paramètres sources |
Entrez les paramètres à envoyer à la source en cas d’actualisation réussie. (Ces paramètres seront ignorés si l’option « Utiliser les paramètres de la source précédente » est activée.) |
| Utiliser les paramètres de la destination précédente | Cochez cette case pour utiliser les paramètres de la destination de l’exécution précédente ; cela remplace tous les autres paramètres de destination que vous avez spécifiés. Cette entrée sera ignorée par le point de terminaison « Actualiser le lot de connexions ». |
| Paramètres de destination |
Entrez les paramètres à envoyer à la destination en cas d’actualisation réussie. (Ces paramètres seront ignorés si l’option « Utiliser les paramètres de la destination précédente » est activée.) |
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d’actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Supprimer le bord
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour supprimer un bord, utilisez le point de terminaison Créer de nouvelles modifications d’enregistrements.
Récupérer la liste des enregistrements
Pour obtenir la liste des enregistrements correspondant aux filtres fournis, utilisez la commande Récupérer la liste des enregistrements. Au moins un filtre est toujours nécessaire.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-getrecords/
Propriétés
| Propriété | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| Filtrer | Les propriétés par lesquelles les résultats doivent être filtrés. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d’actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Récupérer la liste des types
Pour obtenir la liste des types d’enregistrements et de leurs attributs, utilisez la commande Récupérer la liste des types. Cette commande vous permet de savoir à quoi vous attendre lors de la récupération des enregistrements.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-gettypes/
Propriétés
| Propriété | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d’actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Récupérer un seul enregistrement
Pour récupérer un seul enregistrement, utilisez la commande Récupérer un seul enregistrement. L’identifiant unique est généralement un UUID, mais cela peut varier.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Propriétés
| Propriété | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| ID de l’enregistrement | Entrez l’identifiant unique de l’enregistrement. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d’actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Récupérer un seul type
Pour récupérer un seul enregistrement, utilisez la commande Récupérer un seul enregistrement. L’identifiant unique est généralement un UUID, mais cela peut varier.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-gettypebyid/
Propriétés
| Propriété | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| ID de l’enregistrement | Entrez l’identifiant unique de l’enregistrement. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d’actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Exécuter la requête
Pour exécuter une requête Wdata et récupérer ses résultats, utilisez la commande Exécuter la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-runquery/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la requête | Entrez l’ID de la requête à exécuter. |
| Paramètres | Si la requête a des paramètres définis, ajoutez une carte de leurs noms et de leurs valeurs. Note : entrez les valeurs des paramètres à sélection multiple dans Paramètres à sélection multiple. |
| Exécution asynchrone | Pour exécuter la requête de manière asynchrone et ne pas attendre la fin de la requête pour terminer la commande, cochez cette case. |
| Paramètres à sélection multiple | Si la requête comporte des paramètres à sélection multiple, ajoutez le nom et les valeurs de chacun d’entre eux. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultat de la requête | JSON |
Note : la sortie Résultat de la requête comprend un identifiant qui peut être utilisé pour télécharger et exporter les résultats.
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Exécuter le rapport
Pour exécuter un rapport enregistré dans le compte de la base de données SOX et d’audit interne de votre organisation et renvoyer ses résultats sous forme de fichier CSV, utilisez la commande Exécuter le rapport.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-getreportascsv/
Propriétés
| Propriété | Détail |
|---|---|
| ID de rapport | Entrez l’identifiant unique du rapport qui contient le rapport enregistré. |
| Aperçu du contenu | Pour inclure un aperçu des résultats du rapport dans le journal de la commande, cochez cette case. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Rapport | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Définir le bord
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour définir un bord, utilisez le point de terminaison Créer de nouvelles modifications d’enregistrements.
Définir les propriétés de l’enregistrement
Cette commande n’est disponible que par l’intermédiaire de l’API de la plateforme. Pour définir les propriétés d’un enregistrement, utilisez le point de terminaison Créer de nouvelles modifications d’enregistrements.
Annuler l’importation d’un fichier à partir d’un tableau
Pour annuler l’importation et supprimer un fichier d’un tableau Wdata, utilisez la commande Annuler l’importation d’un fichier à partir d’un tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant unique du tableau à partir duquel le fichier doit être supprimé. |
| ID du fichier | Entrez l’identifiant unique du fichier à supprimer du tableau. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importation de fichiers | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour un affichage croisé dynamique
Pour mettre à jour les métadonnées d’un affichage Wdata, utilisez la commande Mettre à jour un affichage croisé dynamique.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Propriétés
| Propriété | Détail |
|---|---|
| ID | Entrez l’ID de l’affichage à mettre à jour. |
| Nom | Entrez le nouveau nom de l’affichage. |
| ID de la requête | Entrez l’ID de la requête à partir de laquelle l’affichage doit être créé. |
| ID du résultat de la requête | Entrez l’ID du résultat de la requête à partir duquel l’affichage doit être créé. |
| Métadonnées supplémentaires | Entrez les métadonnées définies par l’utilisateur à joindre à l’affichage, sous la forme d’un objet JSON (facultatif). |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisé dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour de la définition de la requête
Pour mettre à jour les propriétés d’une requête Wdata, utilisez la commande Mettre à jour de la définition de la requête.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatequery/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la requête | Entrez l’ID de la requête à mettre à jour. |
| Nom | Entrez le nouveau nom de la requête. |
| Description | Entrez la nouvelle description de la requête. |
| ID du résultat principal | Si cette option est spécifiée, entrez l’ID du résultat par défaut à ajouter aux résultats de la requête. |
| Texte de la requête | Entrez la définition de la requête en syntaxe Presto SQL, comme vous le feriez dans l’éditeur SQL de la requête. |
| Temporaire | Pour générer seulement temporairement la requête afin qu’elle n’apparaisse pas dans votre espace de travail, cochez cette case. |
| Paramètres | Entrez les paramètres nécessaires à l’exécution de la requête. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour de la liste de sélection
Pour mettre à jour les propriétés ou les éléments d’une liste de valeurs pour un paramètre de requête à sélection multiple, utilisez la commande Mettre à jour de la liste de sélection.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Propriétés
| Propriété | Détail |
|---|---|
| ID | Entrez l’ID de la liste de sélection à mettre à jour. |
| Nom | Entrez le nouveau nom de la liste de sélection. |
| Description | Entrez la nouvelle description de la liste de sélection. |
| Type de valeur | Sélectionnez le type de données des valeurs de la liste, par exemple chaîne de caractères ou nombre entier. |
| Valeurs | Entrez les valeurs de la liste, y compris les éventuelles mises à jour. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Mettre à jour de la liste de sélection | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour les métadonnées de la feuille
Pour mettre à jour les métadonnées d’une feuille dans une feuille de calcul, utilisez la commande Mettre à jour les métadonnées de la feuille.
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul contenant la feuille dans laquelle les métadonnées doivent être mises à jour. |
| ID/nom de la feuille | Entrez le nom ou l’identifiant unique de la feuille dans laquelle les métadonnées doivent être mises à jour. |
| Nom | Entrez le nouveau nom de la feuille. |
| Index des feuilles | Entrez le nouvel index de la feuille dans la feuille de calcul. Par défaut, les commandes mettent à jour la feuille en tant que feuille supérieure. |
| ID de la feuille mère | Entrez l’ID de la feuille mère sous laquelle la feuille doit être créée. Pour ajouter à la feuille de calcul racine, laissez ce champ vide. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour des métadonnées de la feuille de calcul
Pour mettre à jour les métadonnées d’une feuille de calcul, utilisez la commande Mettre à jour des métadonnées de la feuille de calcul.
Appel API équivalent : https ://developers.workiva.com/2022-01-01/updatesheet.html
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul contenant la feuille dans laquelle les métadonnées doivent être mises à jour. |
| Nom | Entrez le nouveau nom de la feuille de calcul. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Mettre à jour le tableau
Pour mettre à jour les colonnes d’un tableau Wdata, utilisez la commande Mettre à jour le tableau.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatetable/
Propriétés
| Propriété | Détail |
|---|---|
| ID du tableau | Entrez l’identifiant unique du tableau à mettre à jour. |
| Nom | Entrez le nom du tableau à mettre à jour. |
| Description | Entrez une description du tableau à mettre à jour. |
| Type | Choisissez de mettre à jour une table de données (ou de faits) ou un tableau de recherche (ou de dimension) |
| Colonnes | Ajoutez les colonnes avec lesquelles mettre à jour le tableau. Pour chaque colonne, entrez son nom, son type de données, son alias et sa description. Pour Mode, laissez la valeur par défaut de Nullable. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Tableau | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |
Écrire les données de la feuille
Pour écrire des données dans un jeu de données CSV dans une région spécifique d’une feuille, utilisez la commande Écrire les données de la feuille.
Propriétés
| Propriété | Détail |
|---|---|
| ID de la feuille de calcul | Entrez l’identifiant unique de la feuille de calcul dans laquelle les données doivent être écrites. |
| ID/nom de la feuille | Entrez l’identifiant unique de la feuille dans laquelle les données doivent être écrites. |
| Fichier de données | Entrez le fichier CSV contenant les données à écrire dans la feuille. La plage de données ne doit pas dépasser la région. |
| Séparateur | Entrez le séparateur utilisé dans le fichier de données. |
| Région | Entrez une représentation A1 de la cellule ou de la plage de cellules de la feuille dans laquelle les données doivent être écrites. Pour que la plage ne soit pas bornée dans une ou toutes les directions, laissez la colonne ou la ligne correspondante vide. |
| Utilisation asynchrone |
Pour charger les données de manière asynchrone, par exemple pour un grand jeu de données, cochez cette case. Note: En cas d'utilisation de la fonction asynchrone, vous devez ajouter votre propre interrogation pour déterminer l'état de la tâche. |
| Utiliser l’API de la plateforme |
Pour utiliser le formatntered-in des valeurs des cellules de la région , cochez cette case. Cela forcera la commande à utiliser le point de terminaison update values in a range endpoint plutôt que le point de terminaison write data to a region endpoint de l'API du tableur. Note: Cette commande sera toujours exécutée de manière asynchrone lors de l'utilisation de l'API de la plate-forme. Vous devez ajouter vos propres sondages pour déterminer l'état du travail. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Lignes écrites | Entier |
| Cellules écrites | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Réussite | Réussite |
| 1 | Erreur | Erreur |