Polecenia Workiva Connector korzystają z interfejsu API platformy Workiva. Aktualna wersja to 2022-01-01, ale zostanie ona wycofana. Aby łańcuchy działały prawidłowo, przenosimy wszystkie polecenia łącznika Workiva do wersji 2026-01-01.
Większość poleceń Workiva Connector zostanie automatycznie przeniesiona na datę 2026-01-01 30 listopada 2026 r. i nie będzie trzeba nic robić. Pełną listę można znaleźć w dokumencie Workiva Connector: Commands moving to Platform API 2026-01-01 . Polecenia Uruchom raport i Wyświetl listę użytkowników zawierają zmiany wymagające Twojego działania, dlatego musisz wybrać, kiedy je przełączyć. Masz czas do 31 października 2027 r., aby wprowadzić te zmiany. Tego dnia polecenia te zostaną zastąpione nowymi poleceniami API i nie będą działać, dopóki nie zostaną poprawnie skonfigurowane.
Wybór wersji API
Oba polecenia mają teraz pole Wersja API , które umożliwia określenie roku 2022 lub 2026. Wartością domyślną jest 2022, więc polecenie bez wartości używa 2022.
Inne zmiany
Uwaga: Nazwy wyników pozostają takie same, więc reszta łańcucha nadal działa.
- Uruchom raport teraz eksportuje raport przed jego pobraniem. Może to potrwać dłużej i zakończyć się niepowodzeniem, jeśli eksport trwa dłużej niż około 5 minut. Nie powinien trwać dłużej niż 10 minut.
- Lista użytkowników wymaga, aby zakres
organizacja:odczyt został uwzględniony w Twoim udzieleniu autoryzacji OAuth2.
Aby uzyskać więcej informacji na temat zmian w interfejsie API, w tym zmian poleceń arkusza kalkulacyjnego, zapoznaj się ze stroną pomocy technicznej Workiva Łącznik Workiva: polecenia przenoszone do interfejsu API platformy 2026-01-01 .
Uruchom raport
Co pozostaje takie samo
- Dane wejściowe: Identyfikator
raportu,Podgląd zawartości . - Dane wyjściowe: plik CSV raportu .
- Polecenie zostanie zakończone dopiero po przygotowaniu pliku.
Jakie zmiany w 2026-01-01
- Polecenie rozpoczyna eksportowanie raportu, sprawdza jego status mniej więcej co sekundę, a następnie pobiera plik CSV.
- W dzienniku łańcucha pojawi się komunikat „Sprawdzanie statusu operacji...”, status potwierdzono , w kolejce lub rozpoczęto oraz komunikat „Operacja zakończona pomyślnie”, jeśli polecenie zostanie wykonane prawidłowo. Jeśli polecenie nie zostanie wykonane prawidłowo, w dzienniku zostanie zapisany komunikat „Operacja nie powiodła się”.
- Wykonanie tego polecenia może potrwać dłużej niż w wersji z 1 stycznia 2022 r., ponieważ łącznik sprawdza eksport nawet 300 razy lub maksymalnie 10 minut, w zależności od tego, co nastąpi wcześniej. Przy założeniu, że kontrola odbywa się raz na sekundę, czas ten wynosi około 5 minut. Jeżeli do tego czasu eksport nie zostanie ukończony, polecenie zakończy się niepowodzeniem.
- Wskazówka: Jeśli limit czasu polecenia łańcuchowego jest krótszy niż limit czasu eksportu, należy go zwiększyć, aby plik mógł dotrzeć.
- Błędny identyfikator raportu zazwyczaj powoduje wyświetlenie komunikatu „operacja nie powiodła się”.
- Nie jest wymagane żadne nowe pozwolenie. Przyznanie OAuth2 nadal wymaga
graph:read .
Przełącz polecenie na 2026
- Otwórz łańcuch i wybierz polecenie Uruchom raport .
- Ustaw wersję API na 2026 .
- Zapisz i uruchom łańcuch.
- Sprawdź, czy w raporcie znajdują się dane, których oczekujesz.
Rozwiązywanie problemów
| Wiadomość | Co robić |
|---|---|
przekroczono limit 300 prób lub przekroczono limit czasu 10m0s |
Eksport raportu nie zakończył się na czas. Zmniejsz rozmiar raportu lub użyj innych filtrów albo ustaw polecenie z powrotem na „2022” i skontaktuj się z pomocą techniczną. |
operacja nie powiodła się lub operacja została anulowana |
Sprawdź identyfikator raportu. Jeśli jest to poprawne, skontaktuj się z pomocą techniczną, podając identyfikatory widoczne w dzienniku. |
BŁĄD: Nie można uruchomić raportu użytkownika. |
Sprawdź identyfikator raportu i czy grant ma graph:read . Poniższa wiadomość zawiera szczegóły API. |
Lista użytkowników
Co pozostaje takie samo
- Dane wejściowe: Identyfikator
organizacji . - Wyniki: plik JSON [ raportu użytkowników i liczba rekordów .
- Użytkownik przyznający autoryzację OAuth2 musi być administratorem organizacji.
Jakie zmiany w 2026-01-01
- Uprawnienie OAuth2 używane przez połączenie musi mieć zakres
organization:read . - Bez tego zakresu polecenie zakończy się błędem HTML „Nieautoryzowane (401)” lub „Zabronione (403)” zamiast zwrócić listę użytkowników.
Przełącz polecenie na 2026
-
Administrator zabezpieczeń organizacji dodaje
organization:readdo przyznania API, którego identyfikator klienta jest zapisany w połączeniu Workiva:- W prawym górnym rogu kliknij ikonę użytkownika, wybierz Administrator , a następnie Administrator organizacji .
- W menu po lewej stronie wybierz Bezpieczeństwo , a następnie kartę Zaopatrzenie .
- Znajdź ten grant i otwórz go z menu Akcje .
- W Zakresy wybierz
organizacja:odczyti zapisz. Tajemnica klienta pozostaje taka sama.
Uwaga:
organizacja:odczytto zakres organizacji. Nie jest przypisywana w Ustawieniach obszaru roboczego. Aby uzyskać
więcej informacji, zobacz stronę pomocy technicznej Workiva Tworzenie i zarządzanie przyznaniami API w panelu administracyjnym organizacji . - Otwórz łańcuch i wybierz polecenie Wyświetl listę użytkowników .
- Ustaw wersję API na 2026 .
- Zapisz i uruchom łańcuch.
- (Opcjonalne, ale zalecane) Zapisz wartość Liczba rekordów .
- Zmień
- Sprawdź, czy wartość Liczba rekordów jest taka sama dla obu przebiegów.
Uwagi
- Domyślna wersja API to 2022-01-01 i właśnie tej wersji użyje polecenie bez żadnej wartości.
- Nowe polecenia powinny zostać ustawione na rok 2026.
- Można wybrać rok 2022 lub 2026 dla każdego wystąpienia polecenia Uruchom raport i Wyświetl listę użytkowników .
- Wersja z 2022-01-01 przestanie działać 30 listopada 2027 r . Będziesz musiał przenieść swoje polecenia na rok 2026 przed tą datą.
- Pozostałe polecenia wykresu łącznika Workiva zostaną automatycznie przeniesione na datę 2026-01-01 30 listopada 2026 r. i nie trzeba ich zmieniać.
- Dane wyjściowe JSON mogą zawierać pola i elementy w innej kolejności. Wartości są takie same.
Rozwiązywanie problemów
| Wiadomość | Co robić |
|---|---|
BŁĄD: Nie można pobrać raportu użytkownika. , ze statusem 401 lub 403 w tabeli błędów |
Sprawdź, czy przyznanie API ma organization:read i czy użytkownik przyznający przyznanie jest administratorem organizacji. Następnie uruchom polecenie ponownie. |
BŁĄD: Nie można pobrać raportu użytkownika. , z innym statusem |
Sprawdź, czy identyfikator organizacji jest poprawny. Szczegóły API znajdują się w tabeli błędów. |
Zmiany poleceń arkusza kalkulacyjnego
Te informacje również zostaną automatycznie zaktualizowane i nie będzie wymagana żadna edycja łańcucha. Dane wejściowe i wyjściowe pozostają takie same, ale kilka rzeczy działa inaczej:
- Usuń arkusz kalkulacyjny przenosi arkusz kalkulacyjny do kosza zamiast usuwać go trwale.
- Pobierz dane arkusza ignoruje wartość wersji i zwraca najnowsze dane z ostrzeżeniem.
- Funkcje Zapisz , Nadpisz , Wyczyść dane arkusza , Aktualizuj metadane arkusza , Publikuj arkusz kalkulacyjny i Usuń arkusz kalkulacyjny teraz czekają na zakończenie zmian i ignorują ustawienie Użyj asynchronicznie . Polecenia te nie zostaną wykonane, jeśli wprowadzenie zmian zajmie więcej niż około 5 minut.
- Pobierz dane arkusza , Zapisz dane arkusza i Nadpisz dane arkusza ignorują ustawienie Użyj interfejsu API platformy .
A co jeśli nic nie zrobię?
Polecenia korzystające z tych poleceń będą nadal obowiązywać od 2022-01-01 do 31 października 2027 . Po tej dacie polecenia ustawione na 2022-01-01 przestaną działać.
Potrzebujesz pomocy?
Skontaktuj się z Wsparciem Workiva .