Die Befehle in diesem Artikel werden mit dem Workiva Chains Connector verwendet. Um Ihre Ketten-IDs zu finden, schauen Sie sich diesen Artikel an: find IDs in Workiva.
Konnektor an die Workiva Rest-API
Wenn nicht anders angegeben, stellen Sie den Wert so ein, dass er Ihrem Appspot entspricht.
| Eingabe | Typ | AppSpot | Einzelheiten |
| Basis-URL | TextFeld | Prod (US) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | TextFeld | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | TextFeld | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Kette ausführen
Führt eine Kette aus und wartet, bis sie abgeschlossen ist.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-startchain/
Hinweis: Obwohl dieser Befehl verwendet werden kann, wenn eine dynamische Ketten-ID erforderlich ist, empfehlen wir in den meisten Fällen die Verwendung eines Run Chain Events. Das Ereignis "Run Chain" ist enger mit der auszuführenden Kette verbunden und bietet eine einfachere Benutzererfahrung.
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Umgebung. |
| Ketten-ID | TextFeld | Die ID der Kette. |
| Ausführungszeitvariablen | GroupField | Die Werte für die in der Kette verwendeten Laufzeitvariablen. |
| Abfrageintervall | ZahlenFeld | Optional: Die Zeitspanne (in Sekunden), die gewartet wird, bevor geprüft wird, ob die Kette abgeschlossen ist. Dieser Wert ist standardmäßig auf fünf Sekunden eingestellt und sollte nur dann angepasst werden, wenn Sie erwarten, dass Ihre Kette lange läuft. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kettenlauf | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Suche nach Kettenläufen nach Eingabewert
Ruft alle Kettenläufe ab, die den angegebenen Text enthalten.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Umgebung, in der Sie suchen. |
| Text suchen | TextFeld | Der Eingabewert, nach dem gesucht werden soll. |
| Maximale Ergebnisse | ZahlenFeld | Die maximale Anzahl der abzurufenden Ergebnisse. Verwenden Sie 0, um alle Einträge abzurufen. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kette wird ausgeführt | Datei |
| Anzahl von Kettenläufen | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Kette erhalten
Ruft Eigenschaften für eine Kette ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getchain/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Zielumgebung. |
| Ketten-ID | TextFeld | Die ID der Kette. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kette | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Kettenbefehle abrufen
Ruft Eigenschaften für alle Befehle in einer Kette ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getcommands/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Zielumgebung. |
| Ketten-ID | TextFeld | Die ID der Kette. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Befehle | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Kettenverlauf abrufen
Ruft die historischen Kettenläufe für eine Kette ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Zielumgebung. |
| Ketten-ID | TextFeld | Die ID der Kette. |
| Maximale Ergebnisse | ZahlenFeld | Die maximale Anzahl der abzurufenden Ergebnisse. Verwenden Sie 0, um alle Einträge abzurufen. |
| Startdatum | TextFeld | Filtert Kettenläufe, die nach dem angegebenen Startdatum stattgefunden haben. Dieser Wert kann das ISO8601-Format oder einen Unix-Zeitstempel verwenden. |
| Enddatum | TextFeld | Filtert Kettenläufe, die vor dem angegebenen Enddatum stattgefunden haben. Dieser Wert kann das ISO8601-Format oder einen Unix-Zeitstempel verwenden. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kette wird ausgeführt | Datei |
| Anzahl von Kettenläufen | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Kettenlauf erhalten
Erhalten Sie die Details zu einem Kettenlauf.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getchainrun/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Kettenlauf-ID | TextFeld | Die ID des Kettenlaufs. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kettenlauf | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Get Chain Run mit Knoten
Abrufen der Details eines Kettenlaufs einschließlich der Knotendetails.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Kettenlauf-ID | TextFeld | Die ID des Kettenlaufs. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kettenlauf | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Ketten erhalten
Ruft alle Ketten und ihre Eigenschaften in einer bestimmten Umgebung ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getchains/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Umwelt-ID | TextFeld | Die ID der Zielumgebung. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Chains | Datei |
| Anzahl der Ketten | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Umgebung erhalten
Ruft Eigenschaften für eine bestimmte Umgebung ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getenvironment/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Arbeitsbereich-ID | TextFeld | Die ID des Arbeitsbereichs, in dem sich die Umgebung befindet. |
| Umwelt-ID | TextFeld | Die ID der Zielumgebung. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Umgebung | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Umgebungen erhalten
Ruft eine Liste der Umgebungen in einem Arbeitsbereich ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getenvironments/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Arbeitsbereich-ID | TextFeld | Die ID des Arbeitsbereichs, der die Umgebungen enthält. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Umgebungen | Datei |
| Anzahl der Umgebungen | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Arbeitsbereich erhalten
Ruft einen Arbeitsbereich und seine Eigenschaften ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getworkspace/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Arbeitsbereich-ID | TextFeld | Die ID des Arbeitsbereichs. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Arbeitsbereich | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Arbeitsbereiche erhalten
Ruft eine Liste aller Arbeitsbereiche für ein Unternehmen ab.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Eingaben
Keine
Ausgaben
| Ausgabe | Ausgangstyp |
| Arbeitsbereiche | Datei |
| Anzahl der Arbeitsbereiche | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Mapping-Gruppe veröffentlichen
Veröffentlicht eine Mapping-Gruppe, wie durch die Mapping-Group-GUID angegeben.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-publish/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Mapping-Gruppe GUID | TextFeld | Die GUID der Mapping-Gruppe. |
Ausgaben
Keine
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Suche nach Kettenläufen
Sucht nach Kettenläufen, die den angegebenen Filtern entsprechen.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Hinweis: Der Parameter environment_id ist für Superuser oder Org-Admins nicht erforderlich.
Eingaben
| Eingabe | Typ | Einzelheiten |
| Filter | GroupField | Die Filter, die auf die Suche angewendet werden sollen. |
| Maximale Ergebnisse | ZahlenFeld | Die maximale Anzahl der abzurufenden Ergebnisse. Verwenden Sie 0, um alle Einträge abzurufen. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kette wird ausgeführt | Datei |
| Anzahl von Kettenläufen | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Kette anhalten
Stoppt eine gerade laufende Kette.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-stopchain/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Kettenlauf-ID | TextFeld | Die ID des zu stoppenden Kettenlaufs. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Kettenlauf | Datei |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |
Mapping-Regeln hochladen
Lädt einen Mapping-Gruppen-Regelsatz hoch, wie durch die Mapping-Gruppen-GUID angegeben.
Äquivalenter API-Aufruf: https://developers.workiva.com/chains-v1/chains-updaterules/
Eingaben
| Eingabe | Typ | Einzelheiten |
| Mapping-Gruppe GUID | TextFeld | Die GUID der Mapping-Gruppe. |
| Upload-Modus | DropdownFeld | Der Upload-Modus. Wenn mode=published, wird die aktuell veröffentlichte Version aktualisiert und neu veröffentlicht. Wenn mode=draft, wird nur der Entwurf aktualisiert. Wenn mode=both, werden sowohl die veröffentlichte Version als auch der Entwurf aktualisiert. |
| Mapping-Regel-Datei | FileField | Die Datei, die die hochzuladenden Zuordnungsregeln enthält. |
Ausgaben
| Ausgabe | Ausgangstyp |
| Upload-Fehler | Datei |
| Ergebnis hochladen | Datei |
| Anzahl der hochgeladenen Regeln | Ganzzahl |
| Anzahl von Fehlern | Ganzzahl |
Codes beenden
| Code beenden | Typ | Einzelheiten |
| 0 | Erfolgreich | Erfolgreich |
| 1 | Fehler | Allgemeines Versagen |
| 2 | Fehler | Authentifizierung fehlgeschlagen |