Centro assistenza di Workiva

Introduzione

Questo articolo spiega come sostituire un file in Wdata utilizzando le API di Workiva. Si recupera il file esistente, lo si disimporta e lo si elimina, quindi si carica una nuova versione.

Prerequisiti

Prima di iniziare, accertarsi di aver completato tutti i passaggi della guida Importare le collezioni API di Workiva in Postman. Questo assicura che la collezione di API e le variabili d'ambiente siano configurate correttamente.

Autenticazione

1. Aprite l'area di lavoro di Postman e confermate di utilizzare l'ambiente corretto.
2. Espandere la raccolta IAM Services, aprire la cartella oauth2 e selezionare la richiesta Retrieve a token.
3. Fare clic su Inviare per generare il token di autenticazione. Il token viene automaticamente memorizzato nella variabile d'ambiente {{access_token}} e sarà utilizzato in tutte le chiamate API successive.

Nota: i token di scadono dopo 600 secondi (10 minuti). In tal caso, è sufficiente ripetere questo passaggio per generarne uno nuovo.

Recuperare l'ID del file utilizzando l'API Retrieve a List of Files (Recupera un elenco di file)

Prima di caricare o sostituire un file in una tabella Wdata, verificare se il file esiste già. A questo scopo si può usare l'API Retrieve a List of Files per localizzare il file e ottenere il suo File ID.

Seguire i passaggi indicati di seguito.

1. Aprire l'endpoint API
   • Accedere a Wdata API → File → Recuperare un elenco di file.
2. Inserire i parametri richiesti
   • TableId: l'ID della vostra tabella Wdata
   • SearchText: il nome del file (ad esempio, Control Table (3).csv)
3. Eseguire la richiesta
   • L'API restituirà tutti i file corrispondenti alla ricerca.
4. Trovare l'ID del file
   • Nella risposta JSON, cercare:
     • id → l'ID del file
     • nome → conferma il file corretto

(Facoltativo) Verifica in Wdata
Aprire il set di dati nell'interfaccia utente e verificare che l'ID del file corrisponda.

Disimportare il file utilizzando l'ID del file

Utilizzare l'endpoint Unimport a single file per rimuovere un file importato da una tabella Wdata. Questo passaggio prepara la tabella a ricevere un file sostitutivo.

1. In Postman, aprire la richiesta Unimport a single file.
2. In Variabili di percorso, impostare:
   • TableId all'ID della tabella Wdata.
   • FileId all'ID del file recuperato nel passaggio precedente.
3. Fare clic su Inviare per eseguire la richiesta.
4. Nel corpo della risposta, confermare che il record del file mostra ora uno stato aggiornato (ad esempio, spostato di nuovo a staged). 
   
5. In Wdata → Datasets, aprire il dataset e verificare che il file non sia più visualizzato come importato. 
   

Eliminare il file utilizzando l'ID del file

1. In Postman, aprire la richiesta Cancellare un singolo file.
2. In Variabili di percorso, incollate lo stesso fileId.
3. Invia la richiesta.
4. Confermare che il corpo della risposta restituisce che fileId, questo conferma che il file è stato eliminato dalla tabella.

Opzionale: Disimportare ed eliminare il file in un unico passaggio utilizzando force=true

Per impostazione predefinita, quando un file viene disimportato, viene rimosso dalla tabella e riportato in modalità staged, ma non viene eliminato. Per rimuovere definitivamente il file come parte di una singola operazione, includere il parametro di query force.

Quando force=true è specificato, il file viene disimportato ed eliminato in un'unica richiesta. Non è necessaria una chiamata API separata per eliminare un singolo file.

Esempio:

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

Caricare il nuovo file

Dopo aver rimosso il file precedente, per caricare e importare la nuova versione seguire i passaggi della guida Upload and Import a File.