Polecenia w tym artykule są używane z łącznikiem Workiva Chains . Aby znaleźć identyfikatory łańcucha, zapoznaj się z tym artykułem na temat znajdowania identyfikatorów w Workiva .
Łącznik do interfejsu API Workiva REST
Jeżeli nie podano inaczej, ustaw wartość odpowiadającą Twojemu Appspot.
| Wejście | Typ | AppSpot | Szczegół |
| Podstawowy adres URL | Pole tekstowe | Produkcja (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Podstawowy adres URL | Pole tekstowe | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
| Podstawowy adres URL | Pole tekstowe | Prod-CA | https://h.ca.wdesk.com/s/wdata/oc/api/ |
| Podstawowy adres URL | Pole tekstowe | Prod-UE | https://h.eu.wdesk.com/s/wdata/oc/api/ |
Wykonaj łańcuch
Wykonuje łańcuch i czeka na jego zakończenie.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-startchain/
Uwaga : Chociaż polecenie to można wykorzystać, gdy wymagany jest dynamiczny identyfikator łańcucha, w większości przypadków zalecamy użycie zdarzenia Run Chain . Zdarzenie Run Chain jest ściślej powiązane z wykonywanym łańcuchem i zapewnia prostsze środowisko użytkownika.
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska. |
| Identyfikator łańcucha | Pole tekstowe | Identyfikator łańcucha. |
| Zmienne czasu wykonania | Pole grupy | Wartości zmiennych czasu wykonania używanych w łańcuchu. |
| Interwał sondowania | Pole liczbowe | Opcjonalnie : Ilość czasu (w sekundach) oczekiwania przed sprawdzeniem, czy łańcuch został zakończony. Domyślnie jest to pięć sekund i należy to zmienić tylko wtedy, gdy spodziewasz się, że łańcuch będzie działał przez długi czas. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Bieg łańcuchowy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Znajdź przebiegi łańcucha według wartości wejściowej
Pobiera wszystkie przebiegi łańcucha zawierające podany tekst.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska, którego szukasz. |
| Wyszukaj tekst | Pole tekstowe | Wartość wejściowa do wyszukania. |
| Maksymalne wyniki | Pole liczbowe | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Biegi łańcuchowe | Plik |
| Liczba przebiegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uzyskaj łańcuch
Pobiera właściwości łańcucha.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-getchain/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | Pole tekstowe | Identyfikator łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Łańcuch | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uzyskaj polecenia łańcuchowe
Pobiera właściwości wszystkich poleceń w łańcuchu.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getcommands/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | Pole tekstowe | Identyfikator łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Polecenia | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz historię łańcucha
Pobiera historyczne przebiegi łańcucha.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | Pole tekstowe | Identyfikator łańcucha. |
| Maksymalne wyniki | Pole liczbowe | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
| Data rozpoczęcia | Pole tekstowe | Filtruje przebiegi łańcucha, które miały miejsce po określonej dacie rozpoczęcia. Wartość ta może być w formacie ISO8601 lub znaczniku czasu Unix. |
| Data zakończenia | Pole tekstowe | Filtry Łańcuchy przebiegów, które miały miejsce przed określoną datą zakończenia. Wartość ta może być w formacie ISO8601 lub znaczniku czasu Unix. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Biegi łańcuchowe | Plik |
| Liczba przebiegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Zdobądź Chain Run
Poznaj szczegóły dotyczące biegu łańcuchowego.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getchainrun/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator przebiegu łańcucha | Pole tekstowe | Identyfikator przebiegu łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Bieg łańcuchowy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uzyskaj uruchomienie łańcucha z węzłami
Uzyskaj szczegóły przebiegu łańcucha, łącznie ze szczegółami węzłów.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Wejścia
| Wejście | Typ | Szczegół |
| Wejście | Typ | Szczegół |
| Identyfikator przebiegu łańcucha | Pole tekstowe | Identyfikator przebiegu łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Bieg łańcuchowy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Zdobądź łańcuchy
Pobiera wszystkie łańcuchy i ich właściwości w określonym środowisku.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getchains/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska docelowego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Chains | Plik |
| Liczba łańcuchów | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz środowisko
Pobiera właściwości dla określonego środowiska.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getenvironment/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator obszaru roboczego | Pole tekstowe | Identyfikator obszaru roboczego, w którym znajduje się środowisko. |
| Identyfikator środowiska | Pole tekstowe | Identyfikator środowiska docelowego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Środowisko | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz środowiska
Pobiera listę środowisk w obszarze roboczym.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getenvironments/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator obszaru roboczego | Pole tekstowe | Identyfikator obszaru roboczego zawierającego środowiska. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Środowiska | Plik |
| Liczba środowisk | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz obszar roboczy
Pobiera obszar roboczy i jego właściwości.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getworkspace/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator obszaru roboczego | Pole tekstowe | Identyfikator obszaru roboczego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Obszar roboczy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz obszary robocze
Pobiera listę wszystkich obszarów roboczych firmy.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-getworkspaces/
Wejścia
Nic
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Obszary robocze | Plik |
| Liczba obszarów roboczych | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Publikuj grupę mapowania
Publikuje grupę mapowania określoną przez identyfikator GUID grupy mapowania.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-publish/
Wejścia
| Wejście | Typ | Szczegół |
| Mapowanie GUID grupy | Pole tekstowe | Identyfikator GUID grupy mapowania. |
Dane wyjściowe
Nic
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Wyszukaj przebiegi łańcucha
Wyszukuje serie łańcuchów, które spełniają podane filtry.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Uwaga : Parametr environment_id nie jest wymagany dla superużytkowników ani administratorów organizacji.
Wejścia
| Wejście | Typ | Szczegół |
| Filtry | Pole grupy | Filtry, które należy zastosować podczas wyszukiwania. |
| Maksymalne wyniki | Pole liczbowe | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Biegi łańcuchowe | Plik |
| Liczba przebiegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Zatrzymaj łańcuch
Zatrzymuje aktualnie działający łańcuch.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-stopchain/
Wejścia
| Wejście | Typ | Szczegół |
| Identyfikator przebiegu łańcucha | Pole tekstowe | Identyfikator łańcucha, który ma zostać zatrzymany. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Bieg łańcuchowy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Prześlij reguły mapowania
Przesyła zestaw reguł grupy mapowania określony przez identyfikator GUID grupy mapowania.
Równoważne wywołanie API : https://developers.workiva.com/chains-v1/chains-updaterules/
Wejścia
| Wejście | Typ | Szczegół |
| Mapowanie GUID grupy | Pole tekstowe | Identyfikator GUID grupy mapowania. |
| Tryb przesyłania | Pole rozwijane | Tryb przesyłania. Gdy mode=published , aktualnie opublikowana wersja jest aktualizowana i ponownie publikowana. Gdy mode=draft , aktualizowany jest tylko szkic. Gdy mode=both , aktualizowana jest zarówno wersja opublikowana, jak i wersja robocza. |
| Plik reguł mapowania | Pole pliku | Plik zawierający reguły mapowania do przesłania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Błędy przesyłania | Plik |
| Prześlij wynik | Plik |
| Liczba przesłanych reguł | Liczba całkowita |
| Liczba błędów | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegół |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |