|
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

Befehle für Workiva-Konnektoren

Befehle für Workiva-Konnektoren

  • Zuletzt aktualisiert am

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

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

Blattdaten löschen

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

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html

Eigenschaften

Eigenschaft 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 Blatts ein.

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Datei erstellen

Um eine durch Kommata getrennte Werte Datei (CSV-Datei), Javascript Object Notation-Datei (JSON-Datei) 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

Eigenschaft 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 Endung .CSV oder .JSON haben oder eine ZIP-Datei sein, die eine Datei mit der Endung .CSV oder .JSON enthält.
Name Wenn die Download-URL eingegeben wurde, geben Sie den Namen der hochzuladenden Datei ein. Standardmäßig ist dies der Basisname der Download-URL.
Download-URL Geben Sie die URL ein, die auf die herunterzuladende Datei verweist, z. B. eine von Amazon S3 signierte URL. Optional, wenn die Datei eingegeben wird.
Hinweis: Der Befehl stellt eine einfache GET-Anfrage ohne Authentifizierung an die URL.

Ausgaben

Ausgabe Ausgangstyp
Ergebnisse JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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 einen Vorgang und eine Ziel-ID.

Limit: Pro Anfrage können bis zu 1000 Bearbeitungen vorgenommen werden.

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

Eigenschaften

Eigenschaft Einzelheiten
Vorgang

Wählen Sie den auszuführenden Vorgang.

Optionen:

  • Datensatz erstellen
  • Datensatz löschen
  • Beziehung erstellen
  • Beziehung löschen
  • Eigenschaft festlegen
Beschriftung Geben Sie eine Bezeichnung ein, die die Beziehung zwischen den beiden Datensätzen beschreibt. Wird verwendet, um eine Beziehung zu erstellen oder zu löschen.
Eigenschaften Geben Sie die Eigenschaften für den Datensatztyp 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. Wird verwendet, um eine Beziehung zu erstellen oder zu löschen.
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.
Temporäre 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 den Typ des zu erstellenden Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Pivottabellenansicht JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Pivottabellenansicht erstellen

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

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

Eigenschaften

Eigenschaft 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
Pivottabellenansicht JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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: N/A

Eigenschaften

Eigenschaft 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 die abzufragende Tabelle ein.

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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

Eigenschaft 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 wie im SQL-Editor der Abfrage als Presto-SQL-Syntax ein.
Temporär 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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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 Neue Datensatzbearbeitungen erstellen.

Auswahlliste erstellen

Um eine Liste von Werten für einen Abfrageparameter mit Mehrfachauswahl zu erstellen, verwenden Sie den Befehl Auswahlliste erstellen.

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

Eigenschaften

Eigenschaft 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 Ganzzahl.
Werte Geben Sie die Werte der Liste ein. 

Ausgaben

Ausgabe Ausgangstyp
Metadaten der Auswahlliste erstellen JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung 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 Blatts innerhalb des Arbeitsblatts ein.
Hinweis: Standardmäßig fügt der Befehl das Blatt als oberstes Blatt hinzu.
ID des übergeordneten Blatts Geben Sie die ID des übergeordneten Blatts ein, unter dem das Blatt erstellt werden soll. Zum Hinzufügen zur Stammarbeitsblatt lassen Sie das Feld leer.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt erstellen

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

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html 

Eigenschaften

Eigenschaft Einzelheiten
Name Geben Sie einen eindeutigen Namen ein, um das Arbeitsblatt zu identifizieren.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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

Eigenschaft 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 aus, ob Sie eine Daten- (oder Fakttabelle) oder eine Lookup-Tabelle (oder Dimensionstabelle) 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 Hinzufügen für jede Spalte und geben Sie den Namen, den Datentyp, den Alias und die Beschreibung ein. Für den Modus lassen 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 beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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

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

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Pivottabellenansicht löschen

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

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

Eigenschaften

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

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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

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

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Datensatz löschen

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

Blatt löschen

Um ein Blatt und seine untergeordneten Blätter (rekursiv) aus einer Kalkulationstabelle zu löschen, verwenden Sie den Befehl Blatt löschen.

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/deletelegacysheet.html

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, das das zu löschende Blatt enthält.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des zu löschenden Blatts ein.

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt 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

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des zu löschenden Arbeitsblatts ein.

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Tabelle löschen

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

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

Eigenschaften

Eigenschaft Einzelheiten
Tabellen-ID: Geben Sie die eindeutige Bezeichnung der zu löschenden Tabelle ein.

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Datei herunterladen

Um einen Datensatz aus Ihrem Wdata-Arbeitsbereich herunterzuladen, verwenden Sie den Befehl Datei herunterladen.

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

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Datei Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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 Abfrageergebnis herunterladen.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Abfrageergebnis Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Bearbeiten

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

Datei in Arbeitsblatt exportieren

Um einen Datensatz aus einem Wdata-Arbeitsblatt in ein neues oder bestehendes Arbeitsblatt zu exportieren, verwenden Sie den Befehl Datei in Arbeitsblatt exportieren.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Blattinformationen Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfrageergebnis exportieren

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

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

Eigenschaften

Eigenschaft Einzelheiten
Abfrageergebnis-ID Geben Sie die ID des zu exportierenden Abfrageergebnisses ein.
Arbeitsblatt-URL

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

Wenn diese Option 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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Dateieigenschaften abrufen

Um die Eigenschaften einer Datei in Ihrem Wdata-Arbeitsbereich abzurufen, verwenden Sie den Befehl Dateieigenschaften abrufen.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Dateieigenschaften JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Pivottabellenansicht abrufen

Um die Metadaten einer Wdata-Ansicht abzurufen, verwenden Sie den Befehl Pivottabellenansicht abrufen.

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

Eigenschaften

Eigenschaft Einzelheiten
ID Geben Sie die ID der Pivottabellenansicht ein, von der Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Pivottabellenansicht JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfrage-Metadaten abrufen

Um die Metadaten einer Wdata-Abfrage abzurufen, verwenden Sie den Befehl Abfrage-Metadaten abrufen.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Abfrage JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Datensatz abrufen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz abzurufen, verwenden Sie den Endpunkt Einzelnen Datensatz abrufen.

Datensätze abrufen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um mehrere Datensätze abzurufen, verwenden Sie den Endpunkt Mehrere Datensätze abrufen.

Berichte abrufen

Um alle Berichte aus dem Datenbankkkonto für SOX und interne Audits Ihrer Organisation abzurufen, verwenden Sie den Befehl Berichte abrufen.

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Berichte Datei
Berichtsanzahl Ganzzahl

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Auswahlliste abrufen

Um eine Liste von Werten für einen Abfrageparameter mit Mehrfachauswahl basierend auf der ID der Liste abzurufen, verwenden Sie den Befehl Auswahlliste abrufen.

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

Eigenschaften

Eigenschaft Einzelheiten
Listen-ID auswählen Geben Sie die eindeutige Bezeichnung der abzurufenden Auswahlliste ein.

Ausgaben

Ausgabe Ausgangstyp
Payload der Auswahlliste abrufen JSON 

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Blattdaten abrufen

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

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

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, aus dessen Blatt 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]:[Endspalte][Endzeile]. Wenn der Bereich in einer oder allen Richtungen unbegrenzt sein soll, lassen Sie die entsprechende Spalte oder Zeile weg.
Wertstil Wählen Sie aus, ob der rohe oder der berechnete Zellenwert zurückgegeben werden soll. Wenn der Wert einer Zelle beispielsweise =1+:1 lautet, wählen Sie „Roh“ für „=1+1“ oder „Berechnet“ für den berechneten Wert von 2 aus.
Überarbeitung Geben Sie die Version des Blatts ein, aus dem Sie Daten abrufen möchten. Für die aktuelle Version geben Sie „-1“ ein.
Plattform-API verwenden Wenn dieses Kästchen markiert ist, gibt dieser Befehl die Blattdaten in standardmäßiger Dezimalschreibweise zurück.  Wenn es leer ist, werden die Blattdaten in wissenschaftlicher Notation zurückgegeben. Dadurch wird der Befehl gezwungen, den Daten von einem Blatt-Endpunkt abzurufen und nicht den Daten von einem Regions-Endpunkt zurückgeben der Tabellenkalkulations-API.

Ausgaben

Ausgabe Ausgangstyp
Zeilenanzahl Ganzzahl
Daten Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Blatt-Metadaten abrufen

Um die Metadaten eines Blatts in einem Arbeitsblatt abzurufen, verwenden Sie den Befehl Blatt-Metadaten abrufen.

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/getsheetdata.html

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, von dem Sie Metadaten abrufen möchten.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des Blatts ein, von dem Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Blatt-Metadaten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt-Metadaten abrufen

Um die Metadaten eines Arbeitsblatts abzurufen, verwenden Sie den Befehl Arbeitsblatt-Metadaten abrufen.

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, aus dem Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Arbeitsblatt-Metadaten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Tabellen-Metadaten abrufen

Um die Metadaten einer Wdata-Tabelle abzurufen, verwenden Sie den Befehl Tabellen-Metadaten abrufen.

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

Eigenschaften

Eigenschaft Einzelheiten
Tabellen-ID: Geben Sie die eindeutige Bezeichnung der Tabelle ein, aus der Metadaten abgerufen werden sollen.

Ausgaben

Ausgabe Ausgangstyp
Tabelle JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Typ abrufen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um einen Datensatz abzurufen, verwenden Sie den Endpunkt Einzelnen Datensatz abrufen.

Typen abrufen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um mehrere Datensatztypen abzurufen, verwenden Sie den Endpunkt Mehrere Typen abrufen.
<!-- display page content -->

Integritätsprüfung

Um die Integrität der Wdata-API zu prüfen, verwenden Sie den Befehl Integritätsprüfung.

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Antwort JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Datei in Tabelle importieren

Um eine Datei in eine Wdata-Tabelle zu importieren, verwenden Sie den Befehl Datei in Tabelle importieren.

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

Eigenschaften

Eigenschaft 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.
Asynchrone Ausführung 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, aktivieren Sie dieses Kontrollkästchen.
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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt in Tabelle importieren

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

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

Eigenschaften

Eigenschaft Einzelheiten
Tabellen-ID: Geben Sie die eindeutige Bezeichnung der Tabelle ein, in die die Datei importiert werden soll.
Datei-ID Geben Sie die eindeutige Bezeichnung der Datei ein, in die das Arbeitsblaatt importiert werden soll (optional).
Dateiname Geben Sie den eindeutigen Namen ein, den die Datei beim Import in die Tabelle erhalten soll.
Arbeitsblatt-URL Geben Sie die vollständige URL des Arbeitsblatts ein, aus dem Sie Daten importieren möchten.
Asynchrone Ausführung 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, aktivieren Sie dieses Kontrollkästchen.
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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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
Eigenschaft Einzelheiten
Quellentyp Wählen Sie über das Dropdown-Menü den Typ der Datei oder des Objekts aus, aus der bzw. dem Sie Daten abrufen möchten.
Zieltyp Wählen Sie über das Dropdown-Menü den Typ der Datei oder des Objekts aus, an die bzw. das Daten gesendet werden sollen.
Quellen-ID Geben Sie die eindeutige Bezeichnung der Datei oder des Objekts ein, aus der bzw. dem die Daten abgerufen werden sollen.
Ziel-ID Geben Sie die eindeutige Bezeichnung der Datei oder des Objekts ein, an die bzw. das Daten gesendet werden sollen.
Hinweis: Ihre Anfrage muss entweder Quellentyp + Quellen-ID oder Zieltyp + Ziel-ID enthalten. Die Anfrage schlägt fehl, wenn eines dieser Paare nicht vorhanden ist.

Ausgaben

Ausgabe Ausgangstyp
Verbindungen JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Dateifehler auflisten

Um die mit einer Datei verbundenen Fehler aufzulisten, z. B. aufgrund eines Imports, verwenden Sie den Befehl Dateifehler auflisten.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Fehlerliste JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Dateien auflisten

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

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Dateiliste Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Pivottabelleansichten auflisten

Um die Wdata-Ansichten in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl Pivottabelleansichten auflisten.

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Pivottabelleansichten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfragen auflisten

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

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Abfragen JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfrageergebnisse auflisten

Um die verfügbaren Ergebnisse für eine Wdata-Abfrage aufzulisten, verwenden Sie den Befehl Abfrageergebnisse auflisten.

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

Eigenschaften

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

Ausgaben

Ausgabe Ausgangstyp
Abfrageergebnisse JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Auswahllisten auflisten

Um alle Wertelisten für Abfrageparameter mit Mehrfachauswahl in Ihrem Arbeitsbereich aufzulisten und ihre Metadaten abzurufen, verwenden Sie den Befehl Auswahllisten auflisten.

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Auswahllisten auflisten JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Blätter auflisten

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/2022-01-01/getlegacysheets.html

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, dessen Blätter aufgelistet werden sollen.

Ausgaben

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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Tabellen auflisten

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

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

Eigenschaften

Keine

Ausgaben

Ausgabe Ausgangstyp
Tabellenliste JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Benutzer auflisten

Um eine Liste mit Details über die Benutzer einer Organisation abzurufen, verwenden Sie den Befehl Benutzer auflisten. Der Ihnen zugewiesene Integrationsbenutzer muss die Rolle „Organisationsadministrator“ haben, um diesen Befehl auszuführen.

Ähnlich wie beim Export „Personenansicht“ eines Organisationsadministrators sind die Details nach Anzeigenamen sortiert und enthalten folgende Informationen 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

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

Ausgaben

Ausgabe Ausgangstyp
Benutzerbericht Datei
Anzahl der Datensätze Ganzzahl

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
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/2022-01-01/updatesheet.html#

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Kennzeichnung des Arbeitsblatts ein, in dem die Blattdaten überschrieben werden sollen.
Blatt-ID/Name Geben Sie den Namen oder die eindeutige Kennung des Blatts ein, in dem Daten überschrieben werden sollen.
Datendatei Geben Sie die CSV-Datei mit den Daten ein, mit denen das Blatt aufgefüllt werden soll.
Trennzeichen Geben Sie das in Datendatei verwendete Trennzeichen ein.
Plattform-API verwenden Aktivieren Sie dieses Kontrollkästchen, wenn Sie das Format Eingegeben in für die Zellenwerte des Arbeitsblatts verwenden möchten.

Ausgaben

Ausgabe Ausgangstyp
Geschriebene Zeile Ganzzahl
Geschriebene Zellen Ganzzahl

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt 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

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des zu veröffentlichenden Arbeitsblatts ein.
Alle Links aktualisieren Wählen Sie aus, welche Links des Arbeitsblatts veröffentlicht werden sollen:
  • Um alle Links zu veröffentlichen, aktivieren Sie dieses Kontrollkästchen.
  • Wenn Sie nur Links veröffentlichen möchten, die Sie selbst besitzen, deaktivieren Sie dieses Kontrollkästchen.

Ausgaben

Ausgabe Ausgangstyp
Meldung Zeichenfolge

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Verbindung aktualisieren

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

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

Eigenschaften

Eigenschaft Einzelheiten
Verbindungs-ID Geben Sie die eindeutige Bezeichnung der zu aktualisierenden Verbindung ein.
Vorherige Quellparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Quellparameter der vorherigen Ausführung 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 „Vorherige Quellparameter verwenden“ aktiviert ist.)
Vorherige Zielparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Zielparameter der vorherigen Ausführung 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: Parameter mit Mehrfachauswahl werden derzeit nicht unterstützt.

Ausgaben

Ausgabe Ausgangstyp
Status aktualisieren JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Stapel von Verbindungen aktualisieren

Um mehrere Verbindungen auf einmal zu aktualisieren, verwenden Sie den Befehl Stapel von Verbindungen aktualisieren.

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

Eigenschaften

Eigenschaft Einzelheiten
Verbindungen

Aktivieren Sie diese Option, 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 die eindeutige Bezeichnung der zu aktualisierenden Verbindung ein.
Vorherige Quellparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Quellparameter der vorherigen Ausführung 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 „Vorherige Quellparameter verwenden“ aktiviert ist.)
Vorherige Zielparameter verwenden Aktivieren Sie dieses Kontrollkästchen, um die Zielparameter der vorherigen Ausführung 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 Stapelaktualisierung JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Kante entfernen

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

Liste von Datensätzen abrufen

Um eine Liste der Datensätze zurückzugeben, die den angegebenen Filtern entsprechen, verwenden Sie den Befehl Liste von Datensätzen abrufen. Mindestens ein Filter ist immer erforderlich.

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

Eigenschaften

Eigenschaft Einzelheiten
Erweitern

Gibt verwandte Ressourcen mit der Hauptressource zurück.

Optionen:

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

Ausgaben

Ausgabe Ausgangstyp
Status der Stapelaktualisierung JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Liste von Typen abrufen

Um eine Liste der Datensatztypen und ihrer Attribute abzurufen, verwenden Sie den Befehl Liste von Typen abrufen. 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

Eigenschaft Einzelheiten
Erweitern

Gibt verwandte Ressourcen mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen

Ausgaben

Ausgabe Ausgangstyp
Status der Stapelaktualisierung JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Einzelnen Datensatz abrufen

Um einen einzelnen Datensatz abzurufen, verwenden Sie den Befehl Einzelnen Datensatz abrufen. Die eindeutige Bezeichnung ist in der Regel eine UUID. Das kann jedoch variieren.

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

Eigenschaften

Eigenschaft Einzelheiten
Erweitern

Gibt verwandte Ressourcen mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen
Datensatz-ID Geben Sie die eindeutige Bezeichnung des Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Status der Stapelaktualisierung JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Einzelnen Typ abrufen

Um einen einzelnen Datensatz abzurufen, verwenden Sie den Befehl Einzelnen Datensatz abrufen. Die eindeutige Bezeichnung ist in der Regel eine UUID. Das kann jedoch variieren.

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

Eigenschaften

Eigenschaft Einzelheiten
Erweitern

Gibt verwandte Ressourcen mit der Hauptressource zurück.

Optionen:

  • Keine (Standard)
  • Beziehungen
Datensatz-ID Geben Sie die eindeutige Bezeichnung des Datensatzes ein.

Ausgaben

Ausgabe Ausgangstyp
Status der Stapelaktualisierung JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfrage ausführen

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

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

Eigenschaften

Eigenschaft 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 Parameter mit Mehrfachauswahl unter Mehrere Parameter auswählen ein.
Asynchrone Ausführung Um die Abfrage asynchron auszuführen und nicht zu warten, bis die Abfrage beendet ist, um den Befehl abzuschließen, aktivieren Sie dieses Kontrollkästchen.
Mehrere Parameter auswählen Wenn die Abfrage Parameter mit Mehrfachauswahl definiert hat, fügen Sie den Namen und die Werte der einzelnen Parameter hinzu.

Ausgaben

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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Bericht ausführen

Um einen gespeicherten Bericht im Datenbankkkonto für SOX und interne Audits 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

Eigenschaft Einzelheiten
Berichts-ID Geben Sie die eindeutige Bezeichnung des Berichts ein, der den gespeicherten Bericht enthält.
Inhaltsvorschau Aktivieren Sie dieses Kontrollkästchen, um eine Vorschau der Berichtsergebnisse in das Protokoll des Befehls aufzunehmen.

Ausgaben

Ausgabe Ausgangstyp
Bericht Datei

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Kante festlegen

Dieser Befehl ist nur über die Plattform-API verfügbar. Um eine Kante zu festzulegen, verwenden Sie den Endpunkt Neue Datensatzbearbeitungen erstellen.

Datensatzeigenschaften festlegen

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

Import von Datei aus Tabelle rückgängig machen

Um den Import einer Datei aufzuheben und sie aus einer Wdata-Tabelle zu entfernen, verwenden Sie den Befehl Import von Datei aus Tabelle rückgängig machen.

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

Eigenschaften

Eigenschaft Einzelheiten
Tabellen-ID: Geben Sie die eindeutige Bezeichnung der Tabelle ein, aus der die Datei entfernt werden soll.
Datei-ID Geben Sie die eindeutige Bezeichnung der Datei ein, die aus der Tabelle entfernt werden soll.

Ausgaben

Ausgabe Ausgangstyp
Dateiimport JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Pivottabellenansicht aktualisieren

Um die Metadaten einer Wdata-Ansicht zu aktualisieren, verwenden Sie den Befehl Pivottabellenansicht aktualisieren.

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

Eigenschaften

Eigenschaft 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 als JSON-Objekt an die Ansicht angehängt werden sollen (optional).

Ausgaben

Ausgabe Ausgangstyp
Pivottabellenansicht JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Abfragedefinition aktualisieren

Um die Eigenschaften einer Wdata-Abfrage zu aktualisieren, verwenden Sie den Befehl Abfragedefinition aktualisieren.

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

Eigenschaften

Eigenschaft 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 wie im SQL-Editor der Abfrage als Presto-SQL-Syntax ein.
Temporär Aktivieren Sie dieses Kontrollkästchen, um die Abfrage nur 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

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Auswahlliste aktualisieren

Um die Eigenschaften oder Elemente einer Werteliste für einen Abfrageparameter mit Mehrfachauswahl zu aktualisieren, verwenden Sie den Befehl Auswahlliste aktualisieren.

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

Eigenschaften

Eigenschaft 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 Ganzzahl.
Werte Geben Sie die Werte der Liste ein, einschließlich eventueller Aktualisierungen.

Ausgaben

Ausgabe Ausgangstyp
Auswahlliste aktualisieren JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Blatt-Metadaten aktualisieren

Um die Metadaten eines Blatts in einem Arbeitsblatt zu aktualisieren, verwenden Sie den Befehl Blatt-Metadaten aktualisieren.

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

Eigenschaften

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

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Arbeitsblatt-Metadaten aktualisieren

Um die Metadaten eines Arbeitsblatts zu aktualisieren, verwenden Sie den Befehl Arbeitsblatt-Metadaten aktualisieren.

Äquivalenter API-Aufruf: https://developers.workiva.com/2022-01-01/updatesheet.html

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, in dem die Metadaten aktualisiert werden sollen.
Name Geben Sie den neuen Namen des Arbeitsblatts ein.

Ausgaben

Keine

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Tabelle aktualisieren

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

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

Eigenschaften

Eigenschaft Einzelheiten
Tabellen-ID: Geben Sie die eindeutige Bezeichnung 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 Dimensionstabelle 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 den Modus lassen Sie den Standardwert „Nullable“ stehen.

Ausgaben

Ausgabe Ausgangstyp
Tabelle JSON

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler

Blattdaten einfügen

Um Daten in einem CSV-Datensatz in einen bestimmten Bereich eines Blattes einzufügen, verwenden Sie den Befehl Blattdaten einfügen.

Eigenschaften

Eigenschaft Einzelheiten
Arbeitsblatt-ID Geben Sie die eindeutige Bezeichnung des Arbeitsblatts ein, in das die Daten eingefügt werden sollen.
Blatt-ID/Name Geben Sie die eindeutige Bezeichnung des Blatts ein, in das Daten eingefügt werden sollen.
Datendatei Geben Sie die CSV-Datei mit den Daten ein, die in das Blatt eingefügt werden sollen. Der Bereich der Daten darf die Region nicht überschreiten.
Trennzeichen Geben Sie das in Datendatei verwendete Trennzeichen ein. 
Region Geben Sie eine A1-Darstellung der Zelle oder des Zellenbereichs auf dem Blatt ein, in die die Daten eingefügt 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, aktivieren Sie dieses Kontrollkästchen.

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 Format Eingegeben in für die Zellenwerte 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
Geschriebene Zellen Ganzzahl

Codes beenden

Code Typ Einzelheiten
0 Erfolgreich Erfolgreich
1 Fehler Fehler
War dieser Beitrag hilfreich?
6 von 9 fanden dies hilfreich
Um Aufgaben innerhalb der Workiva-Plattform als Teil einer Kette zu automatisieren, beispielsweise um den Austausc...