Workiva-ondersteuningscentrum

Invoering

Dit artikel beschrijft hoe je een bestand in Wdata kunt vervangen met behulp van de Workiva API's. Je haalt het bestaande bestand op, verwijdert het uit de import en uploadt vervolgens een nieuwe versie.

Voorwaarden

Voordat je begint, zorg ervoor dat je alle stappen in de handleiding Workiva API-collecties importeren in Postman hebt voltooid. Dit zorgt ervoor dat uw API-verzameling en omgevingsvariabelen correct zijn geconfigureerd.

Authenticatie

1. Open je Postman-werkruimte en controleer of je de juiste omgeving gebruikt.
2. Vouw de verzameling IAM-services uit, open de map oauth2 en selecteer het verzoek Een token ophalen.
3. Klik op Verzenden om uw authenticatietoken te genereren. Het token wordt automatisch opgeslagen in de omgevingsvariabele {{access_token}} en zal worden gebruikt bij alle volgende API-aanroepen.

Opmerking: Tokens verlopen na 600 seconden (10 minuten). Als dit gebeurt, herhaal dan deze stap om een ​​nieuwe te genereren.

De bestands-ID ophalen met behulp van de API voor het ophalen van een lijst met bestanden.

Controleer voordat u een bestand uploadt of vervangt in een Wdata-tabel of het bestand al bestaat. Je kunt dit doen met behulp van de API Retrieve a List of Files om het bestand te vinden en de bijbehorende File IDte verkrijgen.

Volg de onderstaande stappen.

1. Open het API-eindpunt
   • Ga naar Wdata API → Bestand → Een lijst met bestanden ophalen.
2. Voer de vereiste parameters in.
   • TableId: uw Wdata-tabel-ID
   • SearchText: de bestandsnaam (bijv. Control Table (3).csv)
3. Voer het verzoek uit
   • De API retourneert alle bestanden die overeenkomen met uw zoekopdracht.
4. Zoek de bestands-ID
   • Zoek in het JSON-antwoord naar:
     • id → de bestands-ID
     • naam → bevestigt het juiste bestand

(Optioneel) Verifiëren in Wdata
Open de dataset in de gebruikersinterface en controleer of de bestands-ID overeenkomt.

Verwijder het bestand uit de import met behulp van de bestands-ID.

Gebruik het eindpunt Unimport a single file om een ​​geïmporteerd bestand uit een Wdata-tabel te verwijderen. Deze stap bereidt de tabel voor op het ontvangen van een vervangend bestand.

1. Open in Postman het verzoek Een enkel bestand verwijderen
2. In Padvariabelen, stel in:
   • TableId naar de ID van uw Wdata-tabel.
   • FileId naar de bestands-ID die in de vorige stap is opgehaald.
3. Klik op Verzenden om het verzoek uit te voeren.
4. Bevestig in de reactiebody dat het bestandsrecord nu een bijgewerkte status weergeeft (bijvoorbeeld: terugverplaatst naar in de wachtstand). 
   
5. In Wdata → Datasets, open de dataset en controleer of het bestand niet langer als geïmporteerd wordt weergegeven. 
   

Verwijder het bestand met behulp van de bestands-ID.

1. Open in Postman het verzoek Een enkel bestand verwijderen.
2. Plak in Padvariabelendezelfde bestands-ID.
3. Verzend het verzoek.
4. Controleer of de responsbody fileId retourneert; dit bevestigt dat het bestand uit de tabel is verwijderd.

Optioneel: Verwijder en deïnstalleer het bestand in één stap met force=true

Standaard wordt een bestand, wanneer het niet meer wordt geïmporteerd, uit de tabel verwijderd en teruggezet naar de staging-modus, maar het wordt niet verwijderd. Om het bestand permanent te verwijderen als onderdeel van één enkele bewerking, voegt u de queryparameter force toe.

Wanneer force=true is opgegeven, wordt het bestand in één verzoek gedeïmporteerd en verwijderd. Een aparte API -aanroep voor het verwijderen van een enkel bestand is niet nodig.

Voorbeeld:

DELETE /api/v1/table/{tableId}/import/{fileId}?force=true 

Upload het nieuwe bestand

Nadat je het vorige bestand hebt verwijderd, volg je de stappen in de handleiding Een bestand uploaden en importeren om de nieuwe versie te uploaden en te importeren.