Die klassischen Dateitypen können ab Januar 2021 nicht mehr verwendet werden. Sie können Ihre klassischen Dateien übertragen oder eine PDF herunterladen. Weitere Informationen

Workiva Support Center

Workiva-Konnektor-Befehle

Workiva-Konnektor-Befehle

  • Zuletzt aktualisiert am

Um Aufgaben innerhalb der Workiva-Plattform als Teil einer Kette zu automatisieren, z.B. um den Austausch von Daten mit anderen Datenquellen zu ermöglichen, fügen Sie einen Schritt hinzu, der einen Workiva-Verbindungsbefehl enthält.

Um diese Befehle zu aktivieren, richtet ein IT-Administrator zunächst einen Workiva-Connector ein.

Klarsichtfolie Daten

Um alle Daten in einem Blatt zu löschen, verwenden Sie den Befehl Blattdaten löschen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedataasync/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner für das Arbeitsblatt ein, das gelöscht werden soll.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des zu löschenden Blattes ein.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datei erstellen

Um eine durch Kommata getrennte Werte (CSV), Javascript-Objektnotation (JSON) oder eine komprimierte ZIP-Datei hochzuladen und deren Datensätze aufzulisten, verwenden Sie den Befehl Datei erstellen . Sie können auch die URL zur Datei hochladen, z. B. eine von Amazon S3® signierte URL zu einer Datei in einem S3-Bucket.

  • Wenn es sich um eine JSON-Datei handelt, muss sie einen einzelnen JSON-Datensatz pro Zeile enthalten - eine JSON-Datei ist eine Reihe von JSON-Objekten, die durch ein Zeilenumbruchzeichen getrennt sind.
  • Wenn es sich um eine ZIP-Datei handelt, muss sie eine einzelne CSV- oder JSON-Datei enthalten, deren Name als Name für die importierte Datei verwendet wird. Beim erneuten Herunterladen der Datei wird die Quelle heruntergeladen.
  • Wenn es sich um eine URL handelt, stellt der Endpunkt eine Anfrage zum Abrufen einer Datei mit einer einfachen, nicht authentifizierten GET Anfrage.

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-uploadfile/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie die ID der Tabelle ein, deren Dateien aufgelistet werden sollen.
Datei Geben Sie die hochzuladende Datei ein. Wird ignoriert, wenn Download URL eingegeben wird.
Hinweis: Die Datei muss die Erweiterung .CSV oder .JSON haben oder eine ZIP-Datei sein, die eine Datei mit der Erweiterung .CSV oder .JSON enthält.
Name Wenn Download URL eingegeben wird, geben Sie den Namen der hochzuladenden Datei ein; standardmäßig ist der Basisname Download URL.
URL herunterladen Geben Sie die URL ein, die auf die herunterzuladende Datei verweist, z. B. eine von Amazon S3 signierte URL. Optional, wenn Datei eingegeben wird.
Hinweis: Der Befehl stellt eine einfache GET Anfrage an die URL, ohne Authentifizierung.

Ausgaben

Ausgabe Ausgangstyp
Ergebnisse JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Neue Datensatzbearbeitungen erstellen

Um neue Datensatzbearbeitungen unter Berücksichtigung der angegebenen Eigenschaften zu erstellen, verwenden Sie den Befehl Neue Datensatzbearbeitungen erstellen . Jede Bearbeitung erfordert mindestens eine Operation und eine targetId.

Grenzwerte:

  • Pro Antrag können bis zu 1000 Bearbeitungen vorgenommen werden.

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-createedits/

Eigenschaften

Eigentum Einzelheiten
Operation

Wählen Sie den auszuführenden Vorgang.

Optionen:

  • Datensatz erstellen
  • Datensatz löschen
  • Beziehung erstellen
  • Beziehung löschen
  • Eigenschaft einstellen
Beschriftung Geben Sie eine Bezeichnung ein, die die Beziehung zwischen den beiden Datensätzen beschreibt. Dient zum Erstellen oder Löschen einer Beziehung.
Eigenschaften Geben Sie die Eigenschaften für die Datensatzart ein. Wird verwendet, um einen Datensatz zu erstellen oder seine Eigenschaften festzulegen.
Datensatz-ID Geben Sie die ID oder temporäre Datensatz-ID der Quelle ein. Dient zum Erstellen oder Löschen einer Beziehung.
Ziel-ID Geben Sie die ID des Zieldatensatzes ein. Beim Anlegen eines Datensatzes können Sie entweder die Datensatz-ID oder die temporäre Datensatz-ID verwenden; beim Löschen eines Datensatzes müssen Sie die tatsächliche Datensatz-ID verwenden.
Vorläufige Datensatz-ID Geben Sie die temporäre ID ein, die bei der Erstellung eines Datensatzes verwendet wird; diese temporäre ID wird zum Zeitpunkt der Verarbeitung ersetzt. Sie können diese ID innerhalb derselben Anfrage verwenden, um Beziehungen zwischen erstellten Datensätzen herzustellen.
Typ Geben Sie die Art des zu erstellenden Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Pivot-Ansicht JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Pivot-Ansicht erstellen

Um eine neue Wdata-Ansicht mit einer Abfrage und einem Abfrageergebnis zu erstellen, verwenden Sie den Befehl Create pivot view .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-createpivotview/

Eigenschaften

Eigentum Einzelheiten
Name Geben Sie einen eindeutigen Namen ein, um die Ansicht zu identifizieren.
Abfrage-ID Geben Sie die ID der Abfrage ein, aus der die Ansicht erstellt werden soll.
Abfrageergebnis ID Geben Sie die ID des Abfrageergebnisses ein, aus dem die Ansicht erstellt werden soll.
Zusätzliche Metadaten Geben Sie die benutzerdefinierten Metadaten ein, die der Ansicht als JSON-Objekt hinzugefügt werden sollen (optional).

Ausgaben

Ausgabe Ausgangstyp
Pivot-Ansicht JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Vorschauabfrage erstellen

Um eine temporäre Vorschauabfrage für eine Tabelle zu erstellen, die dann ausgeführt werden kann, verwenden Sie den Befehl Vorschauabfrage erstellen .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-previewqueryusingpost/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie die ID der abzufragenden Tabelle ein.
Grenzwert Geben Sie die maximale Anzahl der Ergebnisse an, die zurückgegeben werden sollen.
Datei Falls angegeben, geben Sie den Namen der Datei in der abzufragenden Tabelle ein.

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrage erstellen

Um eine neue Wdata-Abfrage zu erstellen, verwenden Sie den Befehl Abfrage erstellen .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-createquery/

Eigenschaften

Eigentum Einzelheiten
Name Geben Sie einen eindeutigen Namen ein, um die Abfrage zu identifizieren.
Beschreibung Geben Sie eine Beschreibung der Abfrage ein.
Primäre Ergebnis-ID Falls angegeben, geben Sie die ID des Standardergebnisses ein, das mit den Abfrageergebnissen gefüllt werden soll.
Abfragetext Geben Sie die Abfragedefinition als Presto SQL-Syntax ein, wie im SQL-Editor der Abfrage.
Vorübergehend Aktivieren Sie dieses Kontrollkästchen, um die Abfrage vorübergehend zu erstellen, damit sie nicht in Ihrem Arbeitsbereich erscheint.
Parameter Geben Sie die für die Ausführung der Abfrage erforderlichen Parameter ein.

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datensatz erstellen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen neuen Datensatz zu erstellen, verwenden Sie den Endpunkt Create new record edits .

Auswahlliste erstellen

Um eine Liste von Werten für einen Multiselect-Abfrageparameter zu erstellen, verwenden Sie den Befehl Create select list .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-createselectlist/

Eigenschaften

Eigentum Einzelheiten
Name Geben Sie einen eindeutigen Namen ein, um die Auswahlliste zu identifizieren.
Beschreibung Geben Sie zur weiteren Identifizierung der Auswahlliste eine Beschreibung ihrer Werte oder Parameter ein.
Werttyp Wählen Sie den Datentyp für die Werte der Liste aus, z. B. String oder Integer.
Werte Geben Sie die Werte der Liste ein. 

Ausgaben

Ausgabe Ausgangstyp
Metadaten der Auswahlliste erstellen JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler

Fehler

Blatt erstellen

Um ein neues Blatt zu einem Arbeitsblatt hinzuzufügen, verwenden Sie den Befehl Blatt erstellen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, dem das Blatt hinzugefügt werden soll.
Name Geben Sie einen eindeutigen Namen ein, um das Blatt zu identifizieren.
Blattindex Geben Sie den Index des neuen Blattes innerhalb des Arbeitsblatts ein.
Hinweis: Standardmäßig fügt der Befehl das Blatt als oberstes Blatt hinzu.
ID des übergeordneten Blattes Geben Sie die ID des übergeordneten Blattes ein, unter dem das Blatt erstellt werden soll. Zum Hinzufügen zur Stammtabelle lassen Sie das Feld leer.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulation erstellen

Um ein neues Arbeitsblatt zu erstellen, verwenden Sie den Befehl Arbeitsblatt erstellen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createspreadsheet/

Eigenschaften

Eigentum Einzelheiten
Name Geben Sie den eindeutigen Namen ein, um das Arbeitsblatt zu identifizieren.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabelle erstellen

Um eine neue Wdata-Tabelle in Ihrem Arbeitsbereich zu erstellen, verwenden Sie den Befehl Tabelle erstellen .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-createtable/

Eigenschaften

Eigentum Einzelheiten
Name Geben Sie einen eindeutigen Namen ein, um die Tabelle zu identifizieren.
Beschreibung Geben Sie eine Beschreibung der neuen Tabelle ein.
Typ Wählen Sie, ob Sie eine Daten- (oder Fakt) oder eine Lookup-Tabelle (oder Dimension) erstellen möchten.
Spalten Fügen Sie die Spalten hinzu, die in die Tabelle aufgenommen werden sollen:
  • Um Spalten manuell hinzuzufügen, klicken Sie auf Add für jede Spalte und geben Sie den Namen, den Datentyp, den Alias und die Beschreibung ein. Für Modelassen Sie den Standardwert "Nullable" stehen.
  • Um die Spaltenangaben als JavaScript Object Notation (JSON) hinzuzufügen, aktivieren Sie Variable, und geben Sie das JSON-Objekt oder die Variable ein.

Ausgaben

Ausgabe Ausgangstyp
Tabelle JSON

Codes für die Beendigung

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datei löschen

Um eine Datei aus Ihrem Wdata-Arbeitsbereich zu löschen, verwenden Sie den Befehl Datei löschen .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-deletefile/

Eigenschaften

Eigentum Einzelheiten
Datei-ID Geben Sie die ID der zu löschenden Datei ein.

Ausgaben

Keine

Codes für die Beendigung

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Pivot-Ansicht löschen

Um eine Wdata-Ansicht aus Ihrem Arbeitsbereich zu löschen, verwenden Sie den Befehl Delete pivot view .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/

Eigenschaften

Eigentum Einzelheiten
ID Geben Sie die ID der zu löschenden Ansicht ein.

Ausgaben

Keine

Codes für die Beendigung

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrage löschen

Um eine Wdata-Abfrage aus Ihrem Arbeitsbereich zu löschen, verwenden Sie den Befehl Abfrage löschen .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-deletequery/

Eigenschaften

Eigentum Einzelheiten
Abfrage-ID Geben Sie die ID der zu löschenden Abfrage ein.

Ausgaben

Keine

Codes für die Beendigung

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datensatz löschen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz zu löschen, besuchen Sie den Endpunkt Neuer Datensatz erstellt Bearbeitungen .

Blatt löschen

Um ein Blatt und seine untergeordneten Blätter (rekursiv) aus einem Arbeitsblatt zu löschen, verwenden Sie den Befehl Blatt löschen.
Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletesheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, in dem sich das zu löschende Blatt befindet.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des zu löschenden Blattes ein.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulation löschen

Um ein Arbeitsblatt aus Ihrem Arbeitsbereich zu löschen, verwenden Sie den Befehl Arbeitsblatt löschen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des zu löschenden Arbeitsblatts ein.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabelle löschen

Um eine Wdata-Tabelle aus Ihrem Arbeitsbereich zu löschen, verwenden Sie den Befehl Delete table .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-deletetable/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie den eindeutigen Bezeichner der zu löschenden Tabelle ein

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datei herunterladen

Um einen Datensatz aus Ihrem Wdata-Arbeitsbereich herunterzuladen, verwenden Sie den Befehl Download file .

Hinweis: Dieser Befehl ist nicht mit anderen Objekttypen wie Tabellenkalkulationen, Tabellen oder Abfragen kompatibel.

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/

Eigenschaften

Eigentum Einzelheiten
Datei-ID Geben Sie die ID der Datei ein, die Sie herunterladen möchten.

Ausgaben

Ausgabe Ausgangstyp
Datei Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

<!--

Download Pivot View

Downloads the content from a pivot view

Inputs

<colgroup> <col class="col-xs-6"> <col class="col-xs-6"> </colgroup>
Input Detail
ID Enter the ID of the pivot view to download

Outputs

<colgroup> <col class="col-xs-6"> <col class="col-xs-6"> </colgroup>
Output Output Type
Pivot View Content File

Exit Codes

<colgroup> <col class="col-xs-4"> <col class="col-xs-4"> <col class="col-xs-4"> </colgroup>
Code Type Detail
0 Success Success
1 Error Error
--> <!--

Download pivot view

To download the contents of a view, use a Download pivot view command.

Properties

Property Detail
ID Enter the ID of the view to download.

Outputs

Output Output Type
Pivot view content File

Exit codes

Code Type Detail
0 Success Success
1 Error Error
-->

Abfrageergebnis herunterladen

Um die Ergebnisse einer Wdata-Abfrage in eine Datei herunterzuladen, verwenden Sie den Befehl Download query result .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/

Eigenschaften

Eigentum Einzelheiten
Abfrageergebnis ID Geben Sie die ID des Abfrageergebnisses ein, das Sie herunterladen möchten.

Ausgaben

Ausgabe Ausgangstyp
Ergebnis der Abfrage Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Bearbeiten

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz zu bearbeiten, verwenden Sie den Endpunkt Neuen Datensatz erstellen bearbeitet .

Datei in Tabellenkalkulation exportieren

Um einen Datensatz aus einer Wdata-Tabelle in ein neues oder bestehendes Tabellenblatt zu exportieren, verwenden Sie den Befehl Export file to spreadsheet .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/

Eigenschaften

Eigentum Einzelheiten
Datei-ID Geben Sie die ID des zu exportierenden Tabellendatensatzes ein.
Tabellenkalkulations-URL Geben Sie die URL des Arbeitsblatts ein, in das exportiert werden soll. Um ein neues Arbeitsblatt zu erstellen, lassen Sie es leer.

Ausgaben

Ausgabe Ausgangstyp
Blatt Info Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrageergebnis exportieren

Um ein Wdata-Abfrageergebnis in ein neues oder bestehendes Tabellenblatt zu exportieren, verwenden Sie den Befehl Abfrageergebnis exportieren .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/

Eigenschaften

Eigentum Einzelheiten
Abfrageergebnis ID Geben Sie die ID des zu exportierenden Abfrageergebnisses ein.
Tabellenkalkulations-URL

Geben Sie die URL des Arbeitsblatts ein, in das exportiert werden soll. Um ein neues Arbeitsblatt zu erstellen, lassen Sie es leer.
Als Datensatz exportieren

Wenn dieses Kontrollkästchen aktiviert ist, werden die Daten als zusammenhängender Datensatz exportiert und die Zellen können nur durch Aktualisierung des Datensatzes in der Kalkulationstabelle bearbeitet werden.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Dateieigenschaften abrufen

Um die Eigenschaften einer Datei in Ihrem Wdata-Arbeitsbereich abzurufen, verwenden Sie den Befehl Get file properties .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-getfile/

Eigenschaften

Eigentum Einzelheiten
Datei-ID Geben Sie die ID der Datei ein, deren Eigenschaften Sie abrufen möchten.

Ausgaben

Ausgabe Ausgangstyp
Eigenschaften der Datei JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Pivot-Ansicht abrufen

Um die Metadaten einer Wdata-Ansicht abzurufen, verwenden Sie den Befehl Get pivot view .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-getpivotview/

Eigenschaften

Eigentum Einzelheiten
ID Geben Sie die ID der Pivot-Ansicht ein, von der Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Pivot-Ansicht JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrage-Metadaten abrufen

Um die Metadaten einer Wdata-Abfrage abzurufen, verwenden Sie den Befehl Get query metadata .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-getquery/

Eigenschaften

Eigentum Einzelheiten
Abfrage-ID Geben Sie die ID der Abfrage ein, von der Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Exit Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datensatz holen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz abzurufen, verwenden Sie den Endpunkt Retrieve a single record .

Datensätze abrufen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um mehrere Datensätze abzurufen, verwenden Sie den Endpunkt Retrieve a list of records .

Berichte abrufen

Um alle Berichte aus dem SOX- und Innenrevisionsdatenbankkonto Ihres Unternehmens abzurufen, verwenden Sie den Befehl Get reports .

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-graphreportexport/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Berichte Datei
Zählung melden Ganzzahl

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Auswahlliste erhalten

Um eine Liste von Werten für einen Multi-Select-Abfrageparameter basierend auf der ID der Liste abzurufen, verwenden Sie einen Get select list Befehl.

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-getselectlist/

Eigenschaften

Eigentum Einzelheiten
Listen-ID auswählen Geben Sie den eindeutigen Bezeichner der abzurufenden Auswahlliste ein.

Ausgaben

Ausgabe Ausgangstyp
Nutzdaten der Auswahlliste abrufen JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Blattdaten abrufen

Um alle Daten in einem bestimmten Bereich eines Blattes abzurufen, verwenden Sie den Befehl Blattdaten abrufen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, aus dem Sie Daten abrufen möchten.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des Blatts ein, von dem Sie Daten abrufen möchten.
Region Geben Sie die A1-Darstellung einer Zelle oder eines Bereichs ein, z. B. [Startspalte][Startzeile]:[Stoppspalte][Stoppzeile]. Wenn der Bereich in einer oder allen Richtungen unbegrenzt sein soll, lassen Sie die entsprechende Spalte oder Zeile weg.
Wertiger Stil Wählen Sie aus, ob der rohe oder der berechnete Zellwert zurückgegeben werden soll. Wenn der Wert einer Zelle beispielsweise =1+:1lautet, wählen Sie Roh für =1+1 oder Berechnet für den berechneten Wert von 2.
Überarbeitung Geben Sie die Version des Blattes ein, aus dem Sie Daten abrufen möchten. Für die aktuelle Version geben Sie -1 ein.

Ausgaben

Ausgabe Ausgangstyp
Anzahl der Zeilen Ganzzahl
Daten Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Blatt-Metadaten abrufen

Um die Metadaten eines Blattes in einer Kalkulationstabelle abzurufen, verwenden Sie den Befehl Get sheet metadata .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, von dem Sie Metadaten abrufen möchten.
Blatt-ID/Name Geben Sie den Namen oder den eindeutigen Bezeichner des Blattes ein, von dem Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulations-Metadaten abrufen

Um die Metadaten einer Kalkulationstabelle abzurufen, verwenden Sie den Befehl Get spreadsheet metadata .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, aus dem Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Tabellenkalkulations-Metadaten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abrufen von Tabellen-Metadaten

Um die Metadaten einer Wdata-Tabelle abzurufen, verwenden Sie den Befehl Get table metadata .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-gettable/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie den eindeutigen Bezeichner der Tabelle ein, aus der Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Tabelle JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Typ erhalten

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz abzurufen, verwenden Sie den Endpunkt Retrieve a single record .

Typen erhalten

Dieser Befehl ist nur über die Plattform-API verfügbar. Um mehrere Datensatztypen abzurufen, verwenden Sie den Endpunkt Retrieve a list of types .
<!-- display page content -->

Gesundheitscheck

Um den Zustand der Wdata-API zu überprüfen, verwenden Sie den Befehl Health check .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-healthcheck/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Antwort JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Datei in Tabelle importieren

Um eine Datei in eine Wdata-Tabelle zu importieren, verwenden Sie den Befehl Import file into table .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-importfile/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie die ID der Tabelle ein, in die die Datei importiert werden soll.
Datei-ID Geben Sie die ID der Datei ein, die in die Tabelle importiert werden soll.
Spaltenzuordnungen Ordnen Sie jede Spalte der Datei den Spalten der Tabelle zu.
Asynchroner Betrieb Wenn Sie möchten, dass der Befehl asynchron ausgeführt wird und nicht warten, bis der Import abgeschlossen ist, bevor Sie mit der Kette fortfahren, markieren Sie dieses Feld.
Tags Um Metadaten einzubeziehen, die Ihr Unternehmen über die Daten verfolgt, fügen Sie Tags hinzu und wählen deren Namen und Werte aus.

Ausgaben

Ausgabe Ausgangstyp
Datei-Import JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulation in Tabelle importieren

Um eine Kalkulationstabelle in eine Tabelle zu importieren und ein Datei-Meta-Ergebnis zurückzugeben, verwenden Sie den Befehl Kalkulationstabelle in Tabelle importieren .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie den eindeutigen Bezeichner der Tabelle ein, in die die Datei importiert werden soll.
Datei-ID Geben Sie den eindeutigen Bezeichner der Datei ein, in die die Kalkulationstabelle importiert werden soll (optional).
Dateiname Geben Sie den eindeutigen Namen ein, den die Datei beim Import in die Tabelle erhalten soll.
Tabellenkalkulations-URL Geben Sie die vollständige URL des Arbeitsblatts ein, aus dem Sie Daten importieren möchten.
Asynchroner Betrieb Wenn Sie möchten, dass der Befehl asynchron ausgeführt wird und nicht warten, bis der Import abgeschlossen ist, bevor Sie mit der Kette fortfahren, markieren Sie dieses Feld.
Tags Um Metadaten einzubeziehen, die Ihr Unternehmen über die Daten verfolgt, fügen Sie Tags hinzu und wählen deren Namen und Werte aus.

Ausgaben

Ausgabe Ausgangstyp
Datei-Import JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Verbindungen auflisten

Um Daten zwischen Funktionen der Workiva-Plattform aufzulisten, verwenden Sie den Befehl Verbindungen auflisten .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-listconnections/

Eigenschaften
Eigentum Einzelheiten
Quelle Typ Wählen Sie über das Dropdown-Menü die Art der Datei oder des Objekts aus, aus der/dem Sie Daten abrufen möchten.
Ziel Typ Wählen Sie über das Dropdown-Menü die Art der Datei oder des Objekts aus, an das Daten gesendet werden sollen.
Quelle: ID Geben Sie die eindeutige Kennung der Datei oder des Objekts ein, aus der/dem die Daten gezogen werden sollen.
Ziel-ID Geben Sie den eindeutigen Bezeichner der Datei oder des Objekts ein, an das Daten gesendet werden sollen.
Hinweis: Ihre Anfrage muss entweder Source Type + Source ID oder Destination Type + Destination IDenthalten; die Anfrage schlägt fehl, wenn eines dieser Paare nicht vorhanden ist.

Ausgaben

Ausgabe Ausgangstyp
Verbindungen JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Dateifehler auflisten

Um die mit einer Datei verbundenen Fehler aufzulisten, z. B. aufgrund eines Imports, verwenden Sie den Befehl List file errors .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-geterrors/

Eigenschaften

Eigentum Einzelheiten
Datei-ID Geben Sie die ID der Datei ein, für die Fehler angezeigt werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Fehlerliste JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Dateien auflisten

Um eine Liste der Dateien in einer Wdata-Tabelle und ihrer Metadaten abzurufen, verwenden Sie den Befehl List files .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-getfiles/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie die ID der Tabelle ein, aus der Sie Dateien abrufen möchten.

Ausgaben

Ausgabe Ausgangstyp
Liste der Dateien Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Pivot-Ansichten auflisten

Um die Wdata-Ansichten in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl List pivot views .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Pivot-Ansichten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfragen auflisten

Um die Wdata-Abfragen in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl List queries .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-listqueries/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Abfragen JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrageergebnisse auflisten

Um die verfügbaren Ergebnisse für eine Wdata-Abfrage aufzulisten, verwenden Sie den Befehl List query results .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/

Eigenschaften

Eigentum Einzelheiten
Abfrage-ID Geben Sie die ID der Abfrage ein, von der Sie Ergebnisse erhalten möchten.

Ausgaben

Ausgabe Ausgangstyp
Abfrageergebnisse JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Liste Auswahllisten

Um alle Wertelisten für Multi-Select-Abfrageparameter in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl List select lists .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-listselectlists/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Liste Auswahllisten JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Listenblätter

Um alle Blätter in einem Arbeitsblatt aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl Blätter auflisten .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getspreadsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, dessen Blätter aufgelistet werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Blätter JSON
Anzahl der Blätter Ganzzahl

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellen auflisten

Um alle Wdata-Tabellen in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl List tables .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-gettables/

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Tabelle Liste JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Benutzer auflisten

Um eine Liste mit Details über die Benutzer einer Organisation abzurufen, verwenden Sie den Befehl List users . Der Ihnen zugewiesene Integrationsbenutzer muss die Rolle Org Admin haben, um diesen Befehl auszuführen.

Ähnlich wie beim "Personenansicht"-Export eines Organisationsadministrators sind die Details nach Anzeigenamen sortiert und enthalten die Namen der Benutzer:

  • Nutzernamen
  • E-Mail-Adressen
  • SAML-IDs
  • Letzte Anmeldungen
  • Mitgliedschaften im Arbeitsbereich
  • Lizenzen und Rollen

Äquivalenter API-Aufruf: https://developers.workiva.com/admin-v1/admin-getorgreportusers/

Eigenschaften

Eigentum Einzelheiten
Organisations-ID Geben Sie die eindeutige Kennung der Organisation ein, für die Benutzer aufgelistet werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Benutzer berichten Datei
Anzahl der Datensätze Ganzzahl

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Blattdaten überschreiben

Um alle Zellen in einem Blatt zu löschen und sie durch die in der Datei angegebenen Werte zu ersetzen, verwenden Sie den Befehl Blattdaten überschreiben .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, in dem die Blattdaten überschrieben werden sollen.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des Blattes ein, in dem Daten überschrieben werden sollen.
Die Datei Geben Sie die CSV-Datei mit den Daten ein, mit denen das Blatt aufgefüllt werden soll.
Trennzeichen Geben Sie das in Data Fileverwendete Trennzeichen ein.
Plattform-API verwenden Aktivieren Sie dieses Kontrollkästchen, wenn Sie das Format Eingegeben in für die Zellwerte der Kalkulationstabelle verwenden möchten.

Ausgaben

Ausgabe Ausgangstyp
Zeile geschrieben Ganzzahl
Zellen geschrieben Ganzzahl

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulation veröffentlichen

Um die Links in einem Arbeitsblatt zu veröffentlichen, verwenden Sie den Befehl Arbeitsblatt veröffentlichen .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des zu veröffentlichenden Arbeitsblatts ein.
Alle Links aktualisieren Wählen Sie aus, welche Links der Kalkulationstabelle veröffentlicht werden sollen:
  • Um alle Links zu veröffentlichen, markieren Sie dieses Feld.
  • Wenn Sie nur Links veröffentlichen möchten, die Sie selbst besitzen, deaktivieren Sie dieses Feld.

Ausgaben

Ausgabe Ausgangstyp
Meldung Zeichenfolge

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Verbindung aktualisieren

Um eine bestimmte Verbindung auf der Grundlage ihrer ID zu aktualisieren, verwenden Sie den Befehl Refresh connection .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/

Eigenschaften

Eigentum Einzelheiten
Verbindungs-ID Geben Sie den eindeutigen Bezeichner der zu aktualisierenden Verbindung ein.
Vorherige Quellparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Quellparameter des vorangegangenen Laufs zu verwenden; dies hat Vorrang vor allen anderen Quellparametern, die Sie angegeben haben.

Diese Eingabe wird von dem Endpunkt "Stapel von Verbindungen aktualisieren" ignoriert.
Quellparameter*

Geben Sie die Parameter ein, die bei einer erfolgreichen Aktualisierung an die Quelle gesendet werden sollen.

(Diese Parameter werden ignoriert, wenn "Use previous source parameters" aktiviert ist)
Vorherige Zielparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Zielparameter des vorherigen Laufs zu verwenden; dies hat Vorrang vor allen anderen Zielparametern, die Sie angegeben haben.

Diese Eingabe wird von dem Endpunkt "Stapel von Verbindungen aktualisieren" ignoriert.
Zielparameter*

Geben Sie die Parameter ein, die bei einer erfolgreichen Aktualisierung an das Ziel gesendet werden sollen.

(Diese Parameter werden ignoriert, wenn "Vorherige Zielparameter verwenden" aktiviert ist)
Hinweis: Multi-Select-Parameter werden derzeit nicht unterstützt.

Ausgaben

Ausgabe Ausgangstyp
Status aktualisieren JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Stapel von Verbindungen aktualisieren

Um mehrere Verbindungen auf einmal zu aktualisieren, verwenden Sie den Befehl Refresh batch of connections .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/

Eigenschaften

Eigentum Einzelheiten
Verbindungen

Umschalten, um die Verwendung von Variablen zu aktivieren oder zu deaktivieren.

Wenn aktiviert:

  • Die verfügbaren Variablen können aus dem Menü auf der linken Seite ausgewählt werden.
  • Neue Verbindungen können nicht hinzugefügt werden.
Verbindungs-ID Geben Sie den eindeutigen Bezeichner der zu aktualisierenden Verbindung ein.
Vorherige Quellparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Quellparameter des vorangegangenen Laufs zu verwenden; dies hat Vorrang vor allen anderen Quellparametern, die Sie angegeben haben.

Diese Eingabe wird von dem Endpunkt "Stapel von Verbindungen aktualisieren" ignoriert.
Quellparameter

Geben Sie die Parameter ein, die bei einer erfolgreichen Aktualisierung an die Quelle gesendet werden sollen.

(Diese Parameter werden ignoriert, wenn "Use previous source parameters" aktiviert ist)
Vorherige Zielparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Zielparameter des vorherigen Laufs zu verwenden; dies hat Vorrang vor allen anderen Zielparametern, die Sie angegeben haben.

Diese Eingabe wird von dem Endpunkt "Stapel von Verbindungen aktualisieren" ignoriert.
Zielparameter

Geben Sie die Parameter ein, die bei einer erfolgreichen Aktualisierung an das Ziel gesendet werden sollen.

(Diese Parameter werden ignoriert, wenn "Vorherige Zielparameter verwenden" aktiviert ist)

Ausgaben

Ausgabe Ausgangstyp
Status der Chargenauffrischung JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Kante entfernen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um eine Kante zu entfernen, verwenden Sie den Endpunkt Neuen Datensatz erstellen bearbeitet .

Abrufen einer Liste von Datensätzen

Um eine Liste der Datensätze zurückzugeben, die den angegebenen Filtern entsprechen, verwenden Sie den Befehl Retrieve a list of records . Mindestens ein Filter ist immer erforderlich.

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-getrecords/

Eigenschaften

Eigentum Einzelheiten
Erweitern

Gibt verwandte Ressourcen inline mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen
Filtern Die Eigenschaften, nach denen die Ergebnisse gefiltert werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Status der Chargenaktualisierung JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abrufen einer Liste von Typen

Um eine Liste der Datensatztypen und ihrer Attribute zu erhalten, verwenden Sie den Befehl Retrieve a list of types . Mit diesem Befehl erfahren Sie, was Sie beim Abrufen von Datensätzen zu erwarten haben.

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-gettypes/

Eigenschaften

Eigentum Einzelheiten
Erweitern

Gibt verwandte Ressourcen inline mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen

Ausgaben

Ausgabe Ausgangstyp
Status der Chargenaktualisierung JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Einen einzelnen Datensatz abrufen

Um einen einzelnen Datensatz abzurufen, verwenden Sie den Befehl Retrieve a list of records . Der eindeutige Bezeichner ist in der Regel eine UUID, die jedoch variieren kann.

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-getrecordbyid/

Eigenschaften

Eigentum Einzelheiten
Erweitern

Gibt verwandte Ressourcen inline mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen
Datensatz-ID Geben Sie den eindeutigen Bezeichner des Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Status der Chargenaktualisierung JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Einen einzelnen Typ abrufen

Um einen einzelnen Datensatz abzurufen, verwenden Sie den Befehl Retrieve a list of records . Der eindeutige Bezeichner ist in der Regel eine UUID, die jedoch variieren kann.

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-gettypebyid/

Eigenschaften

Eigentum Einzelheiten
Erweitern

Gibt verwandte Ressourcen inline mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen
Datensatz-ID Geben Sie den eindeutigen Bezeichner des Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Status der Chargenaktualisierung JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfrage ausführen

Um eine Wdata-Abfrage auszuführen und ihre Ergebnisse abzurufen, verwenden Sie den Befehl Run query .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-runquery/

Eigenschaften

Eigentum Einzelheiten
Abfrage-ID Geben Sie die ID der Abfrage ein, die ausgeführt werden soll.
Parameter Wenn für die Abfrage Parameter definiert sind, fügen Sie eine Übersicht über deren Namen und Werte hinzu.
Hinweis: Geben Sie die Werte aller Multiselect-Parameter unter Multiselect-Parameterein.
Asynchroner Betrieb Um die Abfrage asynchron auszuführen und nicht zu warten, bis die Abfrage beendet ist, um den Befehl abzuschließen, markieren Sie dieses Feld.
Mehrfache Auswahl von Parametern Wenn die Abfrage mehrere Auswahlparameter definiert hat, fügen Sie den Namen und die Werte der einzelnen Parameter hinzu.

Ausgaben

Ausgabe Ausgangstyp
Ergebnis der Abfrage JSON
Hinweis: Die Ausgabe Query Result enthält eine ID, die zum Herunterladen und Exportieren der Ergebnisse verwendet werden kann.

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Bericht ausführen

Um einen gespeicherten Bericht im SOX- und Innenrevisionsdatenbankkonto Ihrer Organisation auszuführen und die Ergebnisse als CSV-Datei zurückzugeben, verwenden Sie den Befehl Bericht ausführen .

Äquivalenter API-Aufruf: https://developers.workiva.com/platform-v1/platform-getreportascsv/

Eigenschaften

Eigentum Einzelheiten
Bericht-ID Geben Sie den eindeutigen Bezeichner des Berichts ein, der den gespeicherten Bericht enthält.
Vorschau des Inhalts Aktivieren Sie dieses Kontrollkästchen, um eine Vorschau der Berichtsergebnisse in das Protokoll des Befehls aufzunehmen.

Ausgaben

Ausgabe Ausgangstyp
Bericht Datei

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Kante setzen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um eine Kante zu setzen, verwenden Sie den Endpunkt Neuen Datensatz erstellen bearbeitet .

Datensatzeigenschaften festlegen

Dieser Befehl ist nur über die Plattform-API verfügbar. Verwenden Sie zum Festlegen von Datensatzeigenschaften den Endpunkt Neue Datensatzbearbeitungen erstellen .

Un-import Datei aus Tabelle

Um den Import einer Datei aufzuheben und sie aus einer Wdata-Tabelle zu entfernen, verwenden Sie den Befehl Un-import file From table .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-unimportfile/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie den eindeutigen Bezeichner der Tabelle ein, aus der die Datei entfernt werden soll.
Datei-ID Geben Sie den eindeutigen Bezeichner der Datei ein, die aus der Tabelle entfernt werden soll.

Ausgaben

Ausgabe Ausgangstyp
Dateiimport JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Pivot-Ansicht aktualisieren

Um die Metadaten einer Wdata-Ansicht zu aktualisieren, verwenden Sie den Befehl Update pivot view .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/

Eigenschaften

Eigentum Einzelheiten
ID Geben Sie die ID der zu aktualisierenden Ansicht ein.
Name Geben Sie den neuen Namen der Ansicht ein.
Abfrage-ID Geben Sie die ID der Abfrage ein, aus der die Ansicht erstellt werden soll.
Abfrageergebnis ID Geben Sie die ID des Abfrageergebnisses ein, aus dem die Ansicht erstellt werden soll.
Zusätzliche Metadaten Geben Sie die benutzerdefinierten Metadaten ein, die an die Ansicht angehängt werden sollen, als JSON-Objekt (optional).

Ausgaben

Ausgabe Ausgangstyp
Pivot-Ansicht JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Abfragedefinition aktualisieren

Um die Eigenschaften einer Wdata-Abfrage zu aktualisieren, verwenden Sie den Befehl Update query definition .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-updatequery/          

Eigenschaften

Eigentum Einzelheiten
Abfrage-ID Geben Sie die ID der zu aktualisierenden Abfrage ein.
Name Geben Sie den neuen Namen der Abfrage ein.
Beschreibung Geben Sie die neue Beschreibung der Abfrage ein.
Primäre Ergebnis-ID Falls angegeben, geben Sie die ID des Standardergebnisses ein, das mit den Abfrageergebnissen gefüllt werden soll.
Abfragetext Geben Sie die Abfragedefinition als Presto-SQL-Syntax ein, wie Sie es unter im SQL-Editor der Abfrage tun würden.
Vorübergehend Um die Abfrage nur vorübergehend zu erstellen, damit sie nicht in Ihrem Arbeitsbereich erscheint, aktivieren Sie dieses Kontrollkästchen.
Parameter Geben Sie die für die Ausführung der Abfrage erforderlichen Parameter ein.

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Auswahlliste aktualisieren

Um die Eigenschaften oder Elemente einer Werteliste für einen Multi-Select-Abfrageparameter zu aktualisieren, verwenden Sie den Befehl Update select list .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/

Eigenschaften

Eigentum Einzelheiten
ID Geben Sie die ID der zu aktualisierenden Auswahlliste ein.
Name Geben Sie den neuen Namen der Auswahlliste ein.
Beschreibung Geben Sie die neue Beschreibung der Auswahlliste ein.
Werttyp Wählen Sie den Datentyp für die Werte der Liste aus, z. B. String oder Integer.
Werte Geben Sie die Werte der Liste ein, einschließlich eventueller Aktualisierungen.

Ausgaben

Ausgabe Ausgangstyp
Auswahlliste aktualisieren JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Blatt-Metadaten aktualisieren

Um die Metadaten eines Blattes in einer Kalkulationstabelle zu aktualisieren, verwenden Sie den Befehl Blattmetadaten aktualisieren .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, in dem die Metadaten aktualisiert werden sollen.
Blatt-ID/Name Geben Sie den Namen oder den eindeutigen Bezeichner des Blattes ein, in dem die Metadaten aktualisiert werden sollen.
Name Geben Sie den neuen Namen des Blattes ein.
Blattindex Geben Sie den neuen Index des Blattes in das Arbeitsblatt ein. Standardmäßig aktualisieren die Befehle das Blatt als oberstes Blatt.
ID des übergeordneten Blattes Geben Sie die ID des übergeordneten Blattes ein, unter dem das Blatt erstellt werden soll. Zum Hinzufügen zur Stammtabelle lassen Sie das Feld leer.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabellenkalkulations-Metadaten aktualisieren

Um die Metadaten einer Kalkulationstabelle zu aktualisieren, verwenden Sie den Befehl Update spreadsheet metadata .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatespreadsheet/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, in dem die Metadaten aktualisiert werden sollen.
Name Geben Sie den neuen Namen des Arbeitsblatts ein.

Ausgaben

Keine

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Tabelle aktualisieren

Um die Spalten einer Wdata-Tabelle zu aktualisieren, verwenden Sie den Befehl Update table .

Äquivalenter API-Aufruf: https://developers.workiva.com/wdata-v1/wdata-updatetable/

Eigenschaften

Eigentum Einzelheiten
Tabellen-ID: Geben Sie den eindeutigen Bezeichner der zu aktualisierenden Tabelle ein.
Name Geben Sie den Namen der zu aktualisierenden Tabelle ein.
Beschreibung Geben Sie eine Beschreibung der zu aktualisierenden Tabelle ein.
Typ Wählen Sie aus, ob Sie eine Daten- oder Faktentabelle-oder eine Lookup- oder Dimension-Tabelle aktualisieren möchten
Spalten Fügen Sie die Spalten hinzu, mit denen die Tabelle aktualisiert werden soll. Geben Sie für jede Spalte den Namen, den Datentyp, den Alias und die Beschreibung ein. Für Modelassen Sie den Standardwert "Nullable" stehen.

Ausgaben

Ausgabe Ausgangstyp
Tabelle JSON

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler

Blattdaten schreiben

Um Daten in einem CSV-Datensatz in einen bestimmten Bereich eines Blattes zu schreiben, verwenden Sie den Befehl Blattdaten schreiben .

Äquivalenter API-Aufruf: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatedata/

Eigenschaften

Eigentum Einzelheiten
Arbeitsblatt-ID Geben Sie den eindeutigen Bezeichner des Arbeitsblatts ein, in das die Daten geschrieben werden sollen.
Blatt-ID/Name Geben Sie den eindeutigen Bezeichner des Blatts ein, in das Daten geschrieben werden sollen.
Die Datei Geben Sie die CSV-Datei mit den Daten ein, die in das Blatt geschrieben werden sollen. Der Bereich der Daten darf die Regionnicht überschreiten.
Trennzeichen Geben Sie das in Data Fileverwendete Trennzeichen ein. 
Region Geben Sie eine A1-Darstellung der Zelle oder des Zellbereichs auf dem Blatt ein, in die die Daten geschrieben werden sollen. Wenn der Bereich in einer oder allen Richtungen unbegrenzt sein soll, lassen Sie die entsprechende Spalte oder Zeile leer.
Asynchron verwenden

Um die Daten asynchron zu laden, z. B. bei einem großen Datensatz, markieren Sie dieses Feld.

Hinweis: Wenn Sie async verwenden, müssen Sie eine eigene Abfrage hinzufügen, um den Status des Auftrags zu ermitteln.
Plattform-API verwenden

Aktivieren Sie dieses Kontrollkästchen, um das Formatntered-in für die Zellwerte der Region  zu verwenden.

Dadurch wird der Befehl gezwungen, die Aktualisierungswerte in einem Bereichsendpunkt zu verwenden und nicht die Schreibdaten der Tabellenkalkulations-API in einen Bereichsendpunkt. 

Hinweis: Dieser Befehl wird bei Verwendung der Plattform-API immer asynchron ausgeführt. Sie müssen Ihre eigene Abfrage hinzufügen, um den Status des Auftrags zu ermitteln.

Ausgaben

Ausgabe Ausgangstyp
Geschriebene Zeilen Ganzzahl
Zellen geschrieben Ganzzahl

Exit-Codes

Code Typ Einzelheiten
0 Erfolg Erfolg
1 Fehler Fehler
War dieser Beitrag hilfreich?
5 von 8 fanden dies hilfreich
Um Aufgaben innerhalb der Workiva-Plattform als Teil einer Kette zu automatisieren, z.B. um den Austausch von Date...