Polecenia w tym artykule są używane ze złączem Workiva Chains. Aby znaleźć identyfikatory łańcucha, zapoznaj się z tym artykułem na stronie , aby znaleźć identyfikatory w Workiva.
Konektor do interfejsu API Workiva Rest
Jeśli nie podano inaczej, ustaw wartość odpowiadającą Twojemu Appspot.
| Wejście | Typ | AppSpot | Szczegóły |
| Podstawowy adres URL | TextField | Prod (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Podstawowy adres URL | TextField | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| Podstawowy adres URL | TextField | Prod-APAC | https://h.apac.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że być używane, 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 doświadczenie użytkownika.
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator środowiska | TextField | Identyfikator środowiska. |
| Identyfikator łańcucha | TextField | Identyfikator łańcucha. |
| Zmienne czasu wykonywania | GroupField | Wartości zmiennych runtime używanych w łańcuchu. |
| Interwał odpytywania | NumberField | Opcjonalnie: Czas (w sekundach) oczekiwania przed sprawdzeniem, czy łańcuch został zakończony. Domyślnie jest to pięć sekund i powinno być regulowane 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 |
| Chain Run | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Znajdź łańcuchy według wartości wejściowej
Pobiera wszystkie przebiegi łańcucha, które zawierają podany tekst.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator środowiska | TextField | Identyfikator środowiska, które przeszukujesz. |
| Wyszukaj tekst | TextField | Wartość wejściowa do wyszukania. |
| Maksymalne wyniki | NumberField | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Łańcuchy | Plik |
| Liczba biegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Get Chain
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óły |
| Identyfikator środowiska | TextField | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | TextField | Identyfikator łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Łańcuch | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Polecenia Get Chain
Pobiera właściwości dla 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óły |
| Identyfikator środowiska | TextField | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | TextField | Identyfikator łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Polecenia | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uzyskaj historię łańcucha
Pobiera historyczne przebiegi łańcucha dla łańcucha.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator środowiska | TextField | Identyfikator środowiska docelowego. |
| Identyfikator łańcucha | TextField | Identyfikator łańcucha. |
| Maksymalne wyniki | NumberField | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
| Data rozpoczęcia | TextField | Filtruje przebiegi łańcucha, które miały miejsce po określonej dacie rozpoczęcia. Wartość ta może używać formatu ISO8601 lub uniksowego znacznika czasu. |
| Data zakończenia | TextField | Filtruje przebiegi łańcucha, które miały miejsce przed określoną datą końcową. Wartość ta może używać formatu ISO8601 lub uniksowego znacznika czasu. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Łańcuchy | Plik |
| Liczba biegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz Chain Run
Uzyskaj szczegółowe informacje o przebiegu łańcucha.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-getchainrun/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator przebiegu łańcucha | TextField | Identyfikator przebiegu łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Chain Run | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uruchom łańcuch z węzłami
Pobierz szczegóły przebiegu łańcucha, w tym szczegóły węzła.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator przebiegu łańcucha | TextField | Identyfikator przebiegu łańcucha. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Chain Run | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 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óły |
| Identyfikator środowiska | TextField | 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óły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Get Environment
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óły |
| Identyfikator obszaru roboczego | TextField | Identyfikator obszaru roboczego, w którym znajduje się środowisko. |
| Identyfikator środowiska | TextField | Identyfikator środowiska docelowego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Środowisko | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Pobierz środowiska
Pobiera listę środowisk w przestrzeni roboczej.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-getenvironments/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator obszaru roboczego | TextField | 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óły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Uzyskaj przestrzeń roboczą
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óły |
| Identyfikator obszaru roboczego | TextField | Identyfikator obszaru roboczego. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Obszar roboczy | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 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 dla firmy.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Wejścia
Brak
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Obszary robocze | Plik |
| Liczba miejsc pracy | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Opublikuj 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óły |
| Identyfikator GUID grupy mapowania | TextField | Identyfikator GUID grupy mapowania. |
Dane wyjściowe
Brak
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Przeszukuj łańcuchy
Wyszukuje łańcuchy pasujące do podanych filtrów.
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 lub administratorów organizacji.
Wejścia
| Wejście | Typ | Szczegóły |
| Filtry | GroupField | Filtry, które mają zostać zastosowane do wyszukiwania. |
| Maksymalne wyniki | NumberField | Maksymalna liczba wyników do pobrania. Użyj 0, aby pobrać wszystkie elementy. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Łańcuchy | Plik |
| Liczba biegów łańcucha | Liczba całkowita |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |
Zatrzymaj łańcuch
Zatrzymuje aktualnie uruchomiony łańcuch.
Równoważne wywołanie API: https://developers.workiva.com/chains-v1/chains-stopchain/
Wejścia
| Wejście | Typ | Szczegóły |
| Identyfikator przebiegu łańcucha | TextField | Identyfikator łańcucha do zatrzymania. |
Dane wyjściowe
| Dane wyjściowe | Typ wyjścia |
| Chain Run | Plik |
Kody wyjścia
| Kod wyjścia | Typ | Szczegóły |
| 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óły |
| Identyfikator GUID grupy mapowania | TextField | Identyfikator GUID grupy mapowania. |
| Tryb przesyłania | DropdownField | Tryb przesyłania. Gdy mode=published, aktualnie opublikowana wersja jest aktualizowana i ponownie publikowana. Gdy mode=draft, aktualizowana jest tylko wersja robocza. Gdy mode=both, aktualizowana jest zarówno wersja opublikowana, jak i wersja robocza. |
| Plik reguły 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óły |
| 0 | Powodzenie | Powodzenie |
| 1 | Błąd | Ogólna awaria |
| 2 | Błąd | Uwierzytelnianie nie powiodło się |