Introduction
Cet article explique comment remplacer un fichier dans Wdata en utilisant les API de Workiva. Vous récupérerez le fichier existant, le désimporterez et le supprimerez, puis vous téléchargerez une nouvelle version.
Conditions préalables
Avant de commencer, assurez-vous d'avoir effectué toutes les étapes du guide Importing Workiva API Collections into Postman. Cela permet de s'assurer que votre collection d'API et vos variables d'environnement sont correctement configurées.
Authentification
- Ouvrez votre espace de travail Postman et confirmez que vous utilisez l'environnement correct.
- Développez la collection IAM Services, ouvrez le dossier oauth2 et sélectionnez la demande Retrieve a token.
- Cliquez sur Send pour générer votre jeton d'authentification. Le jeton est automatiquement stocké dans la variable d'environnement {{access_token}} et sera utilisé dans tous les appels ultérieurs à l'API.
Remarque : les jetons expirent au bout de 600 secondes (10 minutes). Dans ce cas, il suffit de répéter cette étape pour en générer un nouveau.
Récupérer l'ID du fichier à l'aide de l'API Récupérer une liste de fichiers
Avant de télécharger ou de remplacer un fichier dans une table Wdata, il faut vérifier si le fichier existe déjà. Pour ce faire, vous pouvez utiliser l'API Retrieve a List of Files pour localiser le fichier et obtenir son File ID.
Suivez les étapes ci-dessous.
- Ouvrir le point de terminaison de l'API
- Allez sur Wdata API → File → Retrieve a List of Files.
- Saisir les paramètres requis
- TableId: l'identifiant de votre table Wdata
- SearchText: le nom du fichier (par exemple,
Control Table (3).csv)
- Exécuter la demande
- L'API renverra tous les fichiers correspondant à votre recherche.
- Recherche de l'ID du fichier
- Dans la réponse JSON, cherchez :
-
id→ l'ID du fichier -
nom→ confirme le fichier correct
-
- Dans la réponse JSON, cherchez :
(Facultatif) Vérifiez dans Wdata
Ouvrez le jeu de données dans l'interface utilisateur et confirmez que l'ID de fichier correspond.
Désimporter le fichier à l'aide de l'ID du fichier
Utilisez le point de terminaison Unimport a single file pour supprimer un fichier importé d'une table Wdata. Cette étape prépare la table à recevoir un fichier de remplacement.
- Dans Postman, ouvrez la demande Unimport a single file.
- Dans Path Variables, définir :
- Cliquez sur Send pour exécuter la demande.
- Dans le corps de la réponse, confirmez que l'enregistrement du fichier présente désormais un statut mis à jour (par exemple, déplacé vers mis en scène).
- Dans Wdata → Datasets, ouvrez le jeu de données et vérifiez que le fichier n'est plus affiché comme étant importé.
Supprimer le fichier à l'aide de l'ID du fichier
- Dans Postman, ouvrez la demande Delete a single file.
- Dans Path Variables, collez le même fileId.
- Envoyez la demande.
- Confirmez que le corps de la réponse renvoie que fileId, ce qui confirme que le fichier a été supprimé de la table.
Facultatif : Désimporter et supprimer le fichier en une seule étape en utilisant force=true
Par défaut, lorsqu'un fichier n'est pas importé, il est supprimé de la table et renvoyé en mode statique, mais il n'est pas supprimé. Pour supprimer définitivement le fichier en une seule opération, incluez le paramètre de requête force.
Lorsque force=true est spécifié, le fichier est désimporté et supprimé en une seule demande. Il n'est pas nécessaire d'appeler séparément l'API Delete a single file.
Exemple :
DELETE /api/v1/table/{tableId}/import/{fileId}?force=true Télécharger le nouveau fichier
Après avoir supprimé le fichier précédent, suivez les étapes du guide Upload and Import a File pour télécharger et importer la nouvelle version.