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.
Pour activer ces commandes, un administrateur informatique commence par définir un connecteur Workiva.
Données de la feuille effacée
Pour effacer toutes les données d'une feuille, utilisez la commande Clear sheet data .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul contenant la feuille à effacer. |
| ID/nom de la feuille | Saisissez le nom ou l'identifiant unique de la feuille à effacer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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® vers un fichier dans un seau 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é. Le fait de télécharger à nouveau le fichier permet de télécharger la source.
- S'il s'agit d'une URL, le point d'accès effectue une demande d'obtention d'un fichier à l'aide d'une simple requête non authentifiée
GET.
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'ID du tableau dont les fichiers doivent être répertoriés. |
| Fichier | Saisissez le fichier à charger. Ignoré si l'URL de téléchargement est saisi. 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 Download URL est saisi, entrez le nom du fichier à charger ; par défaut, le nom de base de Download URL. |
| Télécharger l'URL | Saisissez l'URL qui pointe vers le fichier à télécharger, par exemple une URL signée Amazon S3. Option si le fichier est saisi. Note : La commande effectue une simple requête |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultats | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Créer de nouvelles éditions d'enregistrements
Pour créer de nouvelles éditions d'enregistrements en fonction des propriétés fournies, utilisez la commande Créer de nouvelles éditions d'enregistrements . Chaque édition nécessite au moins une opération et un identifiant de cible.
Limites :
- Jusqu'à 1000 éditions peuvent être traitées par demandeur.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-createedits/
Propriétés
| Propriétés | Détail |
|---|---|
| Fonctionnement |
Sélectionnez l'opération à effectuer. Options :
|
| Étiquette | Saisissez une étiquette décrivant la relation entre les deux enregistrements. Permet de créer ou de supprimer une relation. |
| Propriétés | Saisissez les propriétés liées au type d'enregistrement. Permet de créer un enregistrement ou d'en définir les propriétés. |
| ID de l'enregistrement | Saisissez l'ID ou l'ID d'enregistrement temporaire de la source. Permet de créer ou de supprimer une relation. |
| ID cible | Saisissez 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'identifiant temporaire qui sera utilisé lors de la création d'un enregistrement ; cet identifiant temporaire est remplacé à l'heure du processus. Vous pouvez utiliser cet identifiant dans le même demandeur pour créer des relations entre les enregistrements créés. |
| Type | Saisissez le type d'enregistrement à créer. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisée dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Créer un affichage croisé dynamique
Pour créer une nouvelle vue Wdata à partir de la requête et du résultat de la requête, utilisez la commande Créer une vue croisée dynamique .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Propriétés
| Propriétés | Détail |
|---|---|
| Nom | Entrez un nom unique pour aider à identifier l'affichage. |
| ID de la requête | Saisissez l'ID de la requête à partir de laquelle créer l'affichage. |
| ID du résultat de la requête | Saisissez l'ID du résultat de la requête à partir duquel créer l'affichage. |
| Métadonnées supplémentaires | Saisissez les métadonnées définies par l'utilisateur à joindre à l'affichage sous la forme d'un objet JSON (optionnel). |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisée dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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 : https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'ID du tableau à requêtes. |
| Limite | Saisissez le nombre maximum de résultats à renvoyer. |
| Fichier | Si spécifié, entrez le nom du fichier dans le tableau à requêtes. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Créer une requête
Pour créer une nouvelle requête Wdata, utilisez la commande Create query .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createquery/
Propriétés
| Propriétés | Détail |
|---|---|
| Nom | Entrez un nom unique pour aider à identifier la requête. |
| Description | Saisissez une description de la requête. |
| ID du résultat principal | S'il est spécifié, entrez l'ID du résultat par défaut à intégrer aux résultats de la requête. |
| Texte de la requête | Saisissez la définition de la requête en syntaxe SQL Presto, 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 pas dans votre espace de travail, cochez cette case. |
| Paramètres | Saisissez les paramètres nécessaires pour exécuter la requête. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Créer un enregistrement
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour créer un nouvel enregistrement, utilisez le point de contact Create new record edits .
Créer une liste de sélection
Pour créer une liste de valeurs pour un paramètre de requête multi-sélection, utilisez la commande Create select list .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Propriétés
| Propriétés | Détail |
|---|---|
| Nom | Saisissez un nom unique pour aider à identifier la liste sélectionnée. |
| Description | Pour aider à mieux identifier la liste de sélection, entrez une description de ses valeurs ou de ses paramètres. |
| Type de valeur | Sélectionnez le type de données des valeurs de la liste, par exemple chaîne de caractères ou entier. |
| Valeurs | Saisissez 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 | Avec succès | Avec succès |
| 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és | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul à laquelle ajouter la feuille. |
| Nom | Saisissez un nom unique pour aider à identifier la feuille. |
| Index des feuilles | Saisissez l'index de la nouvelle feuille de calcul. Note : Par défaut, la commande ajoute la feuille en tant que feuille supérieure. |
| ID de la feuille parentale | Saisissez l'ID de la feuille parente sous laquelle créer la feuille. Pour ajouter à la feuille de calcul racine, laisser en blanc. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Métadonnées de la feuille | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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/spreadsheets-v1/spreadsheets-createspreadsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| Nom | Saisissez le nom unique qui aidera à 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Créer un tableau
Pour créer un nouveau tableau Wdata dans votre espace de travail, utilisez la commande Create table .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-createtable/
Propriétés
| Propriétés | Détail |
|---|---|
| Nom | Entrez un nom unique pour aider à identifier le tableau. |
| Description | Entrez une description du nouveau tableau. |
| Type | Sélectionnez si vous souhaitez créer un tableau de données (ou fait) ou un tableau de consultation (ou dimension). |
| Colonnes | Ajoutez les colonnes à inclure dans le tableau :
|
Sorties
| Sortie | Type de sortie |
|---|---|
| Tableau | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer le fichier
Pour supprimer un fichier de votre espace de travail Wdata, utilisez la commande Delete file .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletefile/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du fichier | Saisissez l'ID du fichier à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer l'affichage de la croisée dynamique
Pour supprimer un affichage Wdata de votre espace de travail, utilisez la commande Delete croisée dynamique .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Propriétés
| Propriétés | Détail |
|---|---|
| ID | Saisissez l'ID de l'affichage à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer la requête
Pour supprimer une requête Wdata de votre espace de travail, utilisez la commande Delete query .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletequery/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la requête | Saisissez l'ID de la requête à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer l'enregistrement
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour supprimer un enregistrement, Créer un nouvel enregistrement édite endpoint.Supprimer la feuille
Pour supprimer une feuille et ses feuilles enfants (de manière récursive) d'une feuille de calcul, utilisez la commande Supprimer la feuille.Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul contenant la feuille à supprimer. |
| ID/nom de la feuille | Saisissez le nom ou l'identifiant unique de la feuille à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer la feuille de calcul
Pour supprimer une feuille de calcul de votre espace de travail, utilisez la commande Delete spreadsheet .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul à supprimer. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer le tableau
Pour supprimer un tableau Wdata de votre espace de travail, utilisez la commande Delete table .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-deletetable/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'identifiant unique du tableau à supprimer |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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 Download file .
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és | Détail |
|---|---|
| ID du fichier | Saisissez l'ID du fichier à télécharger. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Fichier | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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 le résultat de la requête
Pour télécharger les résultats d'une requête Wdata dans un fichier, utilisez la commande Download query result .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du résultat de la requête | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Édition
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour éditer un enregistrement, utilisez le point de terminaison Créer une nouvelle édition d'enregistrement .
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 Export file to spreadsheet .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du fichier | Saisissez l'ID du jeu de données du tableau à exporter. |
| URL de la feuille de calcul | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Exporter le résultat de la requête
Pour exporter le résultat d'une requête Wdata vers une feuille de calcul nouvelle ou existante, utilisez la commande Exporter le résultat de la requête .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du résultat de la requête | Saisissez l'ID du résultat de la requête à exporter. |
| URL de la feuille de calcul |
Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir les propriétés d'un fichier
Pour récupérer les propriétés d'un fichier dans votre espace de travail Wdata, utilisez la commande Get file properties .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getfile/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du fichier | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir l'affichage de la croisée dynamique
Pour récupérer les métadonnées d'un affichage Wdata, utilisez la commande Get pivot view .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Propriétés
| Propriétés | Détail |
|---|---|
| ID | Saisissez l'ID de l'affichage croisé dynamique à partir duquel vous souhaitez obtenir des métadonnées. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisée dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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 Get query metadata .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getquery/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la requête | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir un enregistrement
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour obtenir un enregistrement, utilisez le point de terminaison Retrieve a single record .
Obtenir des enregistrements
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour obtenir plusieurs enregistrements, utilisez le point d'accès Retrieve a list of records .
Obtenir des rapports
Pour récupérer tous les rapports du Compte de la base de données SOX et d'audit interne de votre organisation, utilisez la commande Get reports .
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-graphreportexport/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Rapports | Fichier |
| Rapport de comptage | Entier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir une liste de sélection
Pour récupérer une liste de valeurs pour un paramètre de requête multi-sélection en fonction de l'identifiant de la liste, utilisez la commande Get select list .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Propriétés
| Propriétés | Détail |
|---|---|
| Sélectionner l'ID de la liste | Saisissez l'identifiant unique de la liste sélectionnée à récupérer. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Obtenir la charge utile de la liste sélectionnée | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir les données de la feuille
Pour récupérer toutes les données d'une région spécifiée d'une feuille, utilisez la commande Get sheet data .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul à partir de laquelle les données doivent être obtenues. |
| ID/nom de la feuille | Saisissez le nom ou l'identifiant unique de la feuille à partir de laquelle vous souhaitez obtenir des données. |
| Région | Saisissez 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 pas tenir compte de la colonne ou de la ligne correspondante. |
| Style de valeur | Sélectionner si la valeur de la cellule doit être brute ou calculée. 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 | Saisis la version de la feuille à partir de laquelle les données doivent être extraites. Pour la version actuelle, entrez -1. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Nombre de lignes | Entier |
| Données | Fichier |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir les métadonnées de la feuille
Pour récupérer les métadonnées d'une feuille d'un calcul, utilisez la commande Get sheet metadata .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul contenant la feuille à partir de laquelle les métadonnées doivent être obtenues. |
| ID/nom de la feuille | Saisissez 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 | Avec succès | Avec succès |
| 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 Get spreadsheet metadata .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez 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 | Avec succès | Avec succès |
| 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 Get table metadata .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-gettable/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Obtenir le type
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour obtenir un enregistrement, utilisez le point d'accès Retrieve a single record .
Obtenir des types
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour obtenir plusieurs types d'enregistrements, utilisez le point de terminaison Retrieve a list of types .
<!-- display page content -->
Bilan de santé/intégrité
Pour vérifier la santé/intégrité de l'API Wdata, utilisez la commande Health check .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Réponse | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Importer un fichier dans un tableau
Pour importer un fichier dans un tableau Wdata, utilisez la commande Import file into table .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-importfile/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'ID du tableau dans lequel importer le fichier. |
| ID du fichier | Saisissez l'ID du fichier à importer dans le tableau. |
| Mappages des colonnes | Mappez chaque colonne du fichier sur les colonnes du tableau. |
| Exécuter de manière asynchrone | Pour que la commande soit exécutée de manière asynchrone et que et non attende que l'importation soit terminée avant de poursuivre 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 leurs noms et valeurs. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importer un fichier | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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és | Détail |
|---|---|
| ID du tableau | Saisissez l'identifiant unique du tableau dans lequel importer le fichier. |
| ID du fichier | Saisissez l'identifiant unique du fichier dans lequel importer la feuille de calcul (optionnel). |
| Nom du fichier | Saisissez le nom unique à donner au fichier lors de son importation dans le tableau. |
| URL de la feuille de calcul | Saisissez l'URL complète de la feuille de calcul à partir de laquelle vous souhaitez importer des données. |
| Exécuter de manière asynchrone | Pour que la commande soit exécutée de manière asynchrone et que et non attende que l'importation soit terminée avant de poursuivre 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 leurs noms et valeurs. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importer un fichier | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Lister les connexions
Pour répertorier les données entre les fonctionnalités de la plateforme Workiva, utilisez la commande List connections .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Propriétés | 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. |
| Source ID | Saisissez l'identifiant unique du fichier ou de l'élément à partir duquel les données doivent être extraites. |
| ID de destination | Saisissez l'identifiant unique du fichier ou de l'élément auquel envoyer les données. |
Note : Votre demandeur doit contenir soit Source Type + Source ID soit Destination Type + Destination ID; la demande é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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Liste des erreurs de fichiers
Pour dresser la liste des erreurs associées à un fichier, dues par exemple à une importation, utilisez la commande List file errors .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-geterrors/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du fichier | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Lister les fichiers
Pour récupérer la liste des fichiers d'un tableau Wdata et leurs métadonnées, utilisez la commande List files .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-getfiles/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'ID 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Affichage de la liste des croisés dynamiques
Pour dresser la liste des affichages Wdata de votre espace de travail et récupérer leurs métadonnées, utilisez la commande List pivot views .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichages croisés dynamiques | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Requêtes de liste
Pour dresser la liste des requêtes Wdata de votre espace de travail et récupérer leurs métadonnées, utilisez la commande List queries .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listqueries/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Requêtes | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Liste des résultats de la requête
Pour dresser la liste des résultats disponibles pour une requête Wdata, utilisez la commande List query results .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la requête | Saisissez l'ID de la requête dont vous souhaitez obtenir les résultats. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Résultats des requêtes | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Liste sélectionner les listes
Pour dresser la liste de toutes les listes de valeurs des paramètres de requête multi-sélection dans votre espace de travail et récupérer leurs métadonnées, utilisez la commande List select lists .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Liste sélectionner les listes | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Liste des 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 List sheets .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Liste des 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 List tables .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-gettables/
Propriétés
Aucun
Sorties
| Sortie | Type de sortie |
|---|---|
| Liste des tableaux | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Lister les utilisateurs
Pour récupérer une liste de détails sur les utilisateurs d'une organisation, utilisez la commande List users . 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 de l'affichage des personnes par 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 électroniques
- ID SAML
- Dernières connexions
- Adhésion à l'espace de travail
- Licences et rôles
Appel API équivalent : https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de l’organisation | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Ecraser 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/spreadsheets-v1/spreadsheets-updatedata/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul dans laquelle écraser les données de la feuille. |
| ID/nom de la feuille | Saisissez le nom ou l'identifiant unique de la feuille dans laquelle écraser les données. |
| Fichier de données | Saisissez le fichier CSV contenant les données avec lesquelles la feuille doit être alimentée. |
| Séparateur | Saisissez le délimiteur utilisé dans le fichier de données . |
| Utiliser l'API de la plateforme | Pour utiliser le format Saisis 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Publier la feuille de calcul
Pour publier les liens dans une feuille de calcul, utilisez la commande Publish spreadsheet .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Actualiser la connexion
Pour actualiser une connexion spécifique en fonction de son identifiant, utilisez la commande Refresh connection .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de connexion | Saisissez 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 source de l'exécution précédente ; cela remplace tous les autres paramètres source 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 la source* |
Saisissez en les paramètres à envoyer à la source avec succès de l'actualisation. (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 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*. |
Saisissez 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 multi-sélectionnés ne sont pas pris en charge actuellement.
Sorties
| Sortie | Type de sortie |
|---|---|
| Actualiser le statut | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Actualiser un lot de connexions
Pour actualiser plusieurs connexions à la fois, utilisez la commande Refresh batch of connections .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Propriétés
| Propriétés | Détail |
|---|---|
| Connexions |
Permet d'activer ou de désactiver l'utilisation des variables. Lorsqu'elle est activée :
|
| ID de connexion | Saisissez 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 source de l'exécution précédente ; cela remplace tous les autres paramètres source 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 la source |
Saisissez en les paramètres à envoyer à la source avec succès de l'actualisation. (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 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 |
Saisissez les paramètres à envoyer à la destination avec succès de l'actualisation. (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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Supprimer le bord
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour supprimer un bord, utilisez l'extrémité Créer un nouvel enregistrement édition .
Récupérer une liste d'enregistrements
Pour obtenir une liste d'enregistrements correspondant aux filtres fournis, utilisez la commande Retrieve a list of records . Au moins un filtre est toujours nécessaire.
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-getrecords/
Propriétés
| Propriétés | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| Filtrer | Les propriétés par lesquelles filtrer les résultats. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Statut d'actualisation des lots | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Récupérer une liste de types
Pour obtenir une liste des types d'enregistrements et de leurs attributs, utilisez la commande Retrieve a list of 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és | 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Récupérer un seul enregistrement
Pour récupérer un seul enregistrement, utilisez la commande Récupérer une liste d'enregistrements . 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és | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| ID de l'enregistrement | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Récupérer un seul type
Pour récupérer un seul enregistrement, utilisez la commande Récupérer une liste d'enregistrements . 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és | Détail |
|---|---|
| Développer |
Renvoie les ressources connexes en ligne avec la ressource principale. Options :
|
| ID de l'enregistrement | Saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Exécuter une requête
Pour exécuter une requête Wdata et en extraire les résultats, utilisez la commande Run query .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-runquery/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la requête | Saisissez 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 : Saisissez les valeurs de tous les paramètres de multisélection dans Multi-select params. |
| Exécuter de manière asynchrone | Pour exécuter la requête de manière asynchrone et pas attendre la fin de la requête pour terminer la commande, cochez cette case. |
| Paramètres multi-sélectionnés | Si la requête comporte plusieurs paramètres de sélection, 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 du résultat de la requête inclut un identifiant, qui peut être utilisé pour télécharger et exporter les résultats.
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 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 la forme d'un fichier CSV, utilisez la commande Run report .
Appel API équivalent : https://developers.workiva.com/platform-v1/platform-getreportascsv/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du rapport | Entrez l'identifiant unique du rapport qui contient le rapport enregistré. |
| Prévisualisation 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Définir le bord
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour définir un bord, utilisez le point de terminaison Créer un nouvel enregistrement édition .
Définir les propriétés de l'enregistrement
Cette commande n'est disponible que par l'intermédiaire de l'API de la plate-forme. Pour définir les propriétés d'un enregistrement, utilisez le point de contact Créer de nouvelles éditions d'enregistrements .
Désimporter le fichier du tableau
Pour désimporter et supprimer un fichier d'un tableau Wdata, utilisez la commande Un-import file From table .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'identifiant unique du tableau à partir duquel le fichier doit être supprimé. |
| ID du fichier | Saisissez l'identifiant unique du fichier à supprimer du tableau. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Importer un fichier | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à jour de l'affichage croisée dynamique
Pour mettre à jour les métadonnées d'un affichage Wdata, utilisez la commande Update pivot view .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Propriétés
| Propriétés | Détail |
|---|---|
| ID | Saisissez l'ID de l'affichage à mettre à jour. |
| Nom | Saisissez le nouveau nom de l'affichage. |
| ID de la requête | Saisissez l'ID de la requête à partir de laquelle créer l'affichage. |
| ID du résultat de la requête | Saisissez l'ID du résultat de la requête à partir duquel créer l'affichage. |
| Métadonnées supplémentaires | Saisissez les métadonnées définies par l'utilisateur à joindre à l'affichage, sous la forme d'un objet JSON (optionnel). |
Sorties
| Sortie | Type de sortie |
|---|---|
| Affichage croisée dynamique | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à jour de la définition de la requête
Pour mettre à jour les propriétés d'une requête Wdata, utilisez la commande Update query definition .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatequery/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la requête | Saisissez l'ID de la requête à mettre à jour. |
| Nom | Saisissez le nouveau nom de la requête. |
| Description | Saisissez la nouvelle description de la requête. |
| ID du résultat principal | S'il est spécifié, entrez l'ID du résultat par défaut à intégrer aux résultats de la requête. |
| Texte de la requête | Saisissez la définition de la requête en syntaxe SQL Presto, comme vous le feriez dans l'éditeur SQL de la requête. |
| Temporaire | Pour que la requête ne soit générée que temporairement et qu'elle n'apparaisse pas pas dans votre espace de travail, cochez cette case. |
| Paramètres | Saisissez les paramètres nécessaires pour exécuter la requête. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Requête | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à 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 multi-sélection, utilisez une commande Update select list .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Propriétés
| Propriétés | Détail |
|---|---|
| ID | Saisissez l'ID de la liste de sélection à mettre à jour. |
| Nom | Saisissez le nouveau nom de la liste sélectionnée. |
| Description | Saisissez la nouvelle description de la liste sélectionnée. |
| Type de valeur | Sélectionnez le type de données des valeurs de la liste, par exemple chaîne de caractères ou entier. |
| Valeurs | Saisissez les valeurs de la liste, y compris les éventuelles mises à jour. |
Sorties
| Sortie | Type de sortie |
|---|---|
| Mise à jour de la liste de sélection | JSON |
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à jour des métadonnées de la feuille
Pour mettre à jour les métadonnées d'une feuille d'un calcul, utilisez la commande Update sheet metadata .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul dans laquelle les métadonnées doivent être mises à jour. |
| ID/nom de la feuille | Saisissez le nom ou l'identifiant unique de la feuille dans laquelle les métadonnées doivent être mises à jour. |
| Nom | Saisissez le nouveau nom de la feuille. |
| Index des feuilles | Saisissez le nouvel indice de la feuille de calcul. Par défaut, la commande met à jour la feuille en tant que feuille supérieure. |
| ID de la feuille parentale | Saisissez l'ID de la feuille parente sous laquelle créer la feuille. Pour ajouter à la feuille de calcul racine, laisser en blanc. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à 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 Update spreadsheet metadata .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul dans laquelle les métadonnées doivent être mises à jour. |
| Nom | Saisissez le nouveau nom de la feuille de calcul. |
Sorties
Aucun
Codes de sortie
| Code | Type | Détail |
|---|---|---|
| 0 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Mise à jour du tableau
Pour mettre à jour les colonnes d'un tableau Wdata, utilisez la commande Update table .
Appel API équivalent : https://developers.workiva.com/wdata-v1/wdata-updatetable/
Propriétés
| Propriétés | Détail |
|---|---|
| ID du tableau | Saisissez l'identifiant unique du tableau à mettre à jour. |
| Nom | Saisissez le nom du tableau à mettre à jour. |
| Description | Entrez une description du tableau à mettre à jour. |
| Type | Sélectionner s'il faut mettre à jour un tableau de données ou un fait - ou un tableau de consultation ou une dimension -. |
| Colonnes | Ajoutez les colonnes à mettre à jour dans le tableau. Pour chaque colonne, saisissez 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |
Données de la feuille d'écriture
Pour écrire les données d'un ensemble de données CSV dans une région spécifique d'une feuille, utilisez la commande Write sheet data .
Appel API équivalent : https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/
Propriétés
| Propriétés | Détail |
|---|---|
| ID de la feuille de calcul | Saisissez l'identifiant unique de la feuille de calcul dans laquelle les données doivent être écrites. |
| ID/nom de la feuille | Saisissez l'identifiant unique de la feuille sur laquelle les données doivent être écrites. |
| Fichier de données | Saisissez le fichier CSV contenant les données à écrire sur la feuille. L'étendue des données ne doit pas dépasser la région . |
| Séparateur | Saisissez le délimiteur utilisé dans le fichier de données . |
| Région | Saisissez 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 l'intervalle ne soit pas borné dans une ou toutes les directions, laissez la colonne ou la ligne correspondante vide. |
| Utiliser l'asynchrone |
Pour charger les données de manière asynchrone, par exemple pour un jeu de données volumineux, cochez cette case. Note: Lorsque vous utilisez async, vous devez ajouter votre propre interrogation pour déterminer l'état de la tâche. |
| Utiliser l'API de la plateforme |
Pour mettre en formentered-in les 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 endpointde l'API feuille de calcul. Note: Cette commande sera toujours exécutée de manière asynchrone lors de l'utilisation de l'API de la plateforme. 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 | Avec succès | Avec succès |
| 1 | Erreur | Erreur |