Centrum wsparcia Workiva

Wprowadzenie

W tym artykule opisano sposób zastępowania pliku w bazie danych Wdata przy użyciu interfejsów API Workiva. Pobierzesz istniejący plik, anulujesz import i usuniesz go, a następnie prześlesz nową wersję.

Wymagania wstępne

Przed rozpoczęciem upewnij się, że wykonałeś wszystkie kroki opisane w przewodniku Importowanie kolekcji API Workiva do programu Postman. Dzięki temu masz pewność, że kolekcja API i zmienne środowiskowe będą poprawnie skonfigurowane.

Uwierzytelnianie

1. Otwórz obszar roboczy Postman i sprawdź, czy używasz właściwego środowiska.
2. Rozwiń kolekcję Usługi IAM, otwórz folder oauth2 i wybierz żądanie Pobierz token.
3. Kliknij Wyślij, aby wygenerować token uwierzytelniający. Token jest automatycznie zapisywany w zmiennej środowiskowej {{access_token}} i będzie używany przy wszystkich kolejnych wywołaniach API.

Uwaga: Tokeny wygasają po 600 sekundach (10 minutach). Jeśli tak się stanie, po prostu powtórz ten krok, aby wygenerować nowy.

Pobierz identyfikator pliku za pomocą interfejsu API Pobierz listę plików

Przed przesłaniem lub zastąpieniem pliku w tabeli Wdata należy sprawdzić, czy plik już istnieje. Można to zrobić za pomocą interfejsu API Pobierz listę plików, aby zlokalizować plik i uzyskać jego Identyfikator pliku.

Wykonaj poniższe kroki.

1. Otwórz punkt końcowy API
   • Przejdź do Wdata API → Plik → Pobierz listę plików.
2. Wprowadź wymagane parametry
   • TableId: identyfikator Twojej tabeli Wdata
   • SearchText: nazwa pliku (np. Tabela kontrolna (3).csv)
3. Uruchom żądanie
   • API zwróci wszystkie pliki spełniające kryteria wyszukiwania.
4. Znajdź identyfikator pliku
   • W odpowiedzi JSON poszukaj:
     • id → identyfikator pliku
     • nazwa → potwierdza poprawność pliku

(Opcjonalnie) Sprawdź w Wdata
Otwórz zbiór danych w interfejsie użytkownika i sprawdź, czy identyfikator pliku jest zgodny.

Odimportuj plik, używając identyfikatora pliku

Użyj punktu końcowego Unimport a single file, aby usunąć zaimportowany plik z tabeli Wdata. Ten krok przygotowuje tabelę do przyjęcia pliku zastępczego.

1. W programie Postman otwórz żądanie Unimport a single file.
2. W Zmienne ścieżkiustaw:
   • TableId do identyfikatora tabeli Wdata.
   • FileId do identyfikatora pliku pobranego w poprzednim kroku.
3. Kliknij Wyślij, aby uruchomić żądanie.
4. W treści odpowiedzi potwierdź, że rekord pliku wyświetla teraz zaktualizowany status (na przykład przeniesiony z powrotem do przygotowany). 
   
5. W Wdata → Zestawy danychotwórz zestaw danych i sprawdź, czy plik nie jest już wyświetlany jako zaimportowany. 
   

Usuń plik, używając identyfikatora pliku

1. W programie Postman otwórz żądanie Usuń pojedynczy plik.
2. W Zmienne ścieżkiwklej ten sam fileId.
3. Wyślij prośbę.
4. Potwierdź, że treść odpowiedzi zwraca fileId, co potwierdza usunięcie pliku z tabeli.

Opcjonalnie: Odimportuj i usuń plik w jednym kroku, używając force=true

Domyślnie po anulowaniu importu plik jest usuwany z tabeli i przywracany do trybu przejściowego, ale nie jest usuwany. Aby trwale usunąć plik w ramach pojedynczej operacji, należy uwzględnić parametr zapytania force.

Jeśli określono force=true, plik zostanie anulowany i usunięty w jednym żądaniu. Nie jest wymagane oddzielne wywołanie API Usuń pojedynczy plik.

Przykład:

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

Prześlij nowy plik

Po usunięciu poprzedniego pliku wykonaj czynności opisane w przewodniku Przesyłanie i importowanie pliku, aby przesłać i zaimportować nową wersję.