|
Klassieke bestandstypen zijn vanaf januari 2021 niet meer beschikbaar voor gebruik. U kunt uw klassieke bestanden omzetten of een PDF downloaden. Meer informatie

Workiva-ondersteuningscentrum

Workiva connector commando's

Workiva connector commando's

  • Laatst bijgewerkt op

Om taken binnen het Workiva-platform te automatiseren als onderdeel van een keten, bijvoorbeeld om de uitwisseling van gegevens met andere gegevensbronnen mogelijk te maken, voegt u een stap toe met een Workiva-verbindingsopdracht.

Om deze commando's in te schakelen, configureert een IT-beheerder eerst een Workiva- connector.

Wis de gegevens op het blad

Om alle gegevens in een werkblad te wissen, gebruikt u de opdracht Gegevens werkblad wissen.

Gelijkwaardige API-aanroep:https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in voor het spreadsheet dat u wilt wissen.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het blad dat u wilt wissen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een bestand aan

Om een ​​CSV-bestand (comma-separated values), een JSON-bestand (JavaScript Object Notation) of een gecomprimeerd ZIP-bestand te uploaden en de records ervan weer te geven, gebruikt u de opdracht Create file. Je kunt ook de URL naar het bestand uploaden, bijvoorbeeld een door Amazon S3® ondertekende URL naar een bestand in een S3-bucket.

  • Als het een JSON-bestand is, moet elke regel één JSON-record bevatten; een JSON-bestand is een reeks JSON-objecten die gescheiden worden door een regelovergangsteken.
  • Als het een ZIP-bestand is, moet het één CSV- of JSON-bestand bevatten, waarvan de naam wordt gebruikt om het geïmporteerde bestand te benoemen. Als je het bestand opnieuw downloadt, wordt de broncode gedownload.
  • Als het een URL betreft, doet het eindpunt een verzoek om een ​​bestand op te halen met behulp van een eenvoudig, niet-geauthenticeerd GET verzoek.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-uploadfile/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de ID in van de tabel waarvan u de bestanden wilt weergeven.
Bestand

Voer het bestand in dat u wilt uploaden. Wordt genegeerd als Download-URL is ingevoerd.

Opmerking: Het bestand moet een .CSV- of .JSON-extensie hebben, of een ZIP-bestand zijn dat een bestand met een .CSV- of .JSON-extensie bevat.
Naam Als Download-URL is ingevoerd, voer dan de naam in van het bestand dat u wilt uploaden; standaard is dit de basisnaam van Download-URL.
Download-URL

Voer de URL in die verwijst naar het te downloaden bestand, bijvoorbeeld een door Amazon S3 ondertekende URL. Optioneel indien Bestand is ingevoerd.

Opmerking: De opdracht voert een eenvoudige GET aanvraag uit naar de URL, zonder authenticatie.

Uitgangen

Uitvoer Uitvoertype
Resultaten JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Nieuwe recordbewerkingen maken

Om nieuwe recordbewerkingen te maken op basis van de opgegeven eigenschappen, gebruikt u de opdracht Nieuwe recordbewerkingen maken. Elke bewerking vereist minimaal een bewerking en een doel-ID.

Limiet: Er kunnen maximaal 1000 bewerkingen per aanvraag worden verwerkt.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-createedits/

Eigenschappen

Eigendom Detail
Operatie

Selecteer de uit te voeren handeling.

Opties:

  • Maak een record aan
  • Record verwijderen
  • Een relatie opbouwen
  • Relatie verwijderen
  • Eigenschap instellen
Etiket Voer een label in dat de relatie tussen de twee records beschrijft. Wordt gebruikt om een ​​relatie te creëren of te verwijderen.
Eigenschappen Voer de eigenschappen in die betrekking hebben op het recordtype. Wordt gebruikt om een ​​record aan te maken of de eigenschappen ervan in te stellen.
Record-ID Voer de ID of tijdelijke record-ID van de bron in. Wordt gebruikt om een ​​relatie te creëren of te verwijderen.
Doel-ID Voer de ID van het betreffende record in. Bij het aanmaken van een record kunt u de record-ID of de tijdelijke record-ID gebruiken; bij het verwijderen van een record moet u de daadwerkelijke record-ID gebruiken.
Tijdelijk record-ID Voer de tijdelijke ID in die gebruikt wordt bij het aanmaken van een record; deze tijdelijke ID wordt vervangen tijdens de verwerking. Je kunt deze ID binnen hetzelfde verzoek gebruiken om relaties tussen aangemaakte records te leggen.
type Voer het type record in dat u wilt aanmaken.

Uitgangen

Uitvoer Uitvoertype
Draaiweergave JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een draaiweergave aan

Om een ​​nieuwe Wdata-weergave te maken op basis van de query en het queryresultaat, gebruikt u de opdracht Create pivot view.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-createpivotview/

Eigenschappen

Eigendom Detail
Naam Voer een unieke naam in om de weergave te identificeren.
Zoek-ID Voer de ID in van de query waarvan u de weergave wilt maken.
Zoekresultaat-ID Voer de ID van het queryresultaat in om de weergave te creëren.
Aanvullende metadata Voer de door de gebruiker gedefinieerde metadata in die u als JSON-object aan de weergave wilt koppelen (optioneel).

Uitgangen

Uitvoer Uitvoertype
Draaiweergave JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Voorbeeldquery maken (verouderd)

Deze opdracht is verouderd omdat het eindpunt niet langer wordt ondersteund.

Maak een query aan

Om een ​​nieuwe Wdata-query te maken, gebruikt u de opdracht Create query.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-createquery/

Eigenschappen

Eigendom Detail
Naam Voer een unieke naam in om de zoekopdracht te identificeren.
Beschrijving Voer een beschrijving van de zoekopdracht in.
Primaire resultaat-ID Voer, indien gespecificeerd, de ID in van het standaardresultaat waarmee de zoekresultaten moeten worden ingevuld.
Zoektekst Voer de querydefinitie in als Presto SQL-syntaxis, zoals u dat in de SQL-editor van de query zou doen.
Tijdelijk Om de query tijdelijk te genereren zodat deze niet in uw werkruimte verschijnt, vinkt u dit vakje aan.
Parameters Voer de parameters in die nodig zijn om de query uit te voeren.

Uitgangen

Uitvoer Uitvoertype
Vraag JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een record aan

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​nieuw record aan te maken, gebruikt u het eindpunt Create new record edits.

Maak een selectielijst

Om een ​​lijst met waarden te maken voor een queryparameter met meerdere selecties, gebruikt u de opdracht Create select list.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-createselectlist/

Eigenschappen

Eigendom Detail
Naam Voer een unieke naam in om de selectielijst te identificeren.
Beschrijving Om de selectielijst beter te kunnen identificeren, kunt u een beschrijving van de waarden of parameters invoeren.
Waardetype Selecteer het gegevenstype van de waarden in de lijst, zoals tekenreeks of geheel getal.
Waarden Voer de waarden van de lijst in. 

Uitgangen

Uitvoer Uitvoertype
Metagegevens voor selectielijsten maken JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een werkblad aan

Om een ​​nieuw blad aan een spreadsheet toe te voegen, gebruikt u de opdracht Maak blad.

Gelijkwaardige API-aanroep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet waaraan u het blad wilt toevoegen.
Naam Voer een unieke naam in om het blad te kunnen identificeren.
Bladindex

Voer de index van het nieuwe werkblad in binnen het spreadsheet.

Opmerking: Standaard voegt de opdracht het blad toe als het bovenste blad.
Ouderblad-ID Voer de ID in van het bovenliggende werkblad waaronder u het werkblad wilt aanmaken. Om iets aan het hoofdbestand toe te voegen, laat u dit veld leeg.

Uitgangen

Uitvoer Uitvoertype
Bladmetadata JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een spreadsheet

Om een ​​nieuwe spreadsheet te maken, gebruikt u de opdracht Spreadsheet maken.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html

Eigenschappen

Eigendom Detail
Naam Voer een unieke naam in om het spreadsheet te kunnen identificeren.

Uitgangen

Uitvoer Uitvoertype
Bladmetadata JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Maak een tabel aan

Om een ​​nieuwe Wdata-tabel in uw werkruimte te maken, gebruikt u de opdracht Create table.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-createtable/

Eigenschappen

Eigendom Detail
Naam Voer een unieke naam in om de tafel te kunnen identificeren.
Beschrijving Voer een beschrijving van de nieuwe tabel in.
type Selecteer of u een gegevenstabel (of feit) of een opzoektabel (of dimensie) wilt maken.
Kolommen

Voeg de kolommen toe die u in de tabel wilt opnemen:

  • Om handmatig kolommen toe te voegen, klikt u op Toevoegen voor elke kolom en voert u de naam, het gegevenstype, de alias en de beschrijving in. Voor Mode, laat de standaardwaarde Nullable staan.
  • Om de details van de kolommen toe te voegen als JavaScript Object Notation (JSON), schakelt u Variabelein en voert u het JSON-object of de variabele in.

Uitgangen

Uitvoer Uitvoertype
Tabel JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Verwijder bestand

Om een ​​bestand uit je Wdata-werkruimte te verwijderen, gebruik je de opdracht Bestand verwijderen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-deletefile/

Eigenschappen

Eigendom Detail
Bestands-ID Voer de ID in van het bestand dat u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Draaiweergave verwijderen

Om een ​​Wdata-weergave uit uw werkruimte te verwijderen, gebruikt u de opdracht Draaipuntweergave verwijderen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/

Eigenschappen

Eigendom Detail
id Voer de ID in van de weergave die u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Verwijder query

Om een ​​Wdata-query uit uw werkruimte te verwijderen, gebruikt u de opdracht Delete query.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-deletequery/

Eigenschappen

Eigendom Detail
Zoek-ID Voer de ID in van de query die u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Verwijder record

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​record te verwijderen, gebruikt u de opdracht Create new record edits.

Verwijder het blad

Om een ​​werkblad en de bijbehorende subwerkbladen (recursief) uit een spreadsheet te verwijderen, gebruikt u de opdracht Werkblad verwijderen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/deletelegacysheet.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet dat u wilt verwijderen.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het blad dat u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Spreadsheet verwijderen

Om een ​​spreadsheet uit je werkruimte te verwijderen, gebruik je de opdracht Spreadsheet verwijderen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet dat u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Tabel verwijderen

Om een ​​Wdata-tabel uit je werkruimte te verwijderen, gebruik je de opdracht Delete table.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-deletetable/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de unieke identificatiecode in van de tabel die u wilt verwijderen.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Bestand downloaden

Om een ​​dataset uit uw Wdata-werkruimte te downloaden, gebruikt u de opdracht Download file.

Opmerking: Deze opdracht is niet compatibel met andere objecttypen zoals spreadsheets, tabellen of query's.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/

Eigenschappen

Eigendom Detail
Bestands-ID Voer de ID in van het bestand dat u wilt downloaden.

Uitgangen

Uitvoer Uitvoertype
Bestand Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Download Pivot View (verouderd)

Deze opdracht is verouderd omdat het eindpunt niet langer wordt ondersteund.

Zoekresultaat downloaden

Om de resultaten van een Wdata-query naar een bestand te downloaden, gebruikt u de opdracht Download query result.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/

Eigenschappen

Eigendom Detail
Zoekresultaat-ID Voer de ID van het zoekresultaat in dat u wilt downloaden.

Uitgangen

Uitvoer Uitvoertype
Zoekresultaat Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Bewerken

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​record te bewerken, gebruikt u het eindpunt Create new record edits.

Exporteer het bestand naar een spreadsheet.

Om een ​​dataset vanuit een Wdata-tabel naar een nieuwe of bestaande spreadsheet te exporteren, gebruikt u de opdracht Bestand exporteren naar spreadsheet.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/

Eigenschappen

Eigendom Detail
Bestands-ID Voer de ID in van de tabeldataset die u wilt exporteren.
Spreadsheet-URL Voer de URL in van het spreadsheet waarnaar u wilt exporteren. Om een ​​nieuwe spreadsheet te maken, laat u dit veld leeg.

Uitgangen

Uitvoer Uitvoertype
Bladinformatie Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Exporteer queryresultaat

Om het resultaat van een Wdata-query naar een nieuw of bestaand spreadsheet te exporteren, gebruikt u de opdracht Export query result.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/

Eigenschappen

Eigendom Detail
Zoekresultaat-ID Voer de ID in van het zoekresultaat dat u wilt exporteren.
Spreadsheet-URL Voer de URL in van het spreadsheet waarnaar u wilt exporteren. Om een ​​nieuwe spreadsheet te maken, laat u dit veld leeg.
Exporteren als dataset Indien aangevinkt, worden de gegevens geëxporteerd als een gekoppelde dataset en kunnen de cellen alleen worden bewerkt door de dataset in het spreadsheet bij te werken.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Bestandseigenschappen ophalen

Om de eigenschappen van een bestand in uw Wdata-werkruimte op te halen, gebruikt u de opdracht Get file properties.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-getfile/

Eigenschappen

Eigendom Detail
Bestands-ID Voer de ID in van het bestand waarvan u de eigenschappen wilt opvragen.

Uitgangen

Uitvoer Uitvoertype
Bestandseigenschappen JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Draaiweergave ophalen

Om de metadata van een Wdata-weergave op te halen, gebruikt u de opdracht Get pivot view.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-getpivotview/

Eigenschappen

Eigendom Detail
id Voer de ID van de draaitabelweergave in waarvan u metadata wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Draaiweergave JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Querymetadata ophalen

Om de metadata van een Wdata-query op te halen, gebruikt u een Get query metadata -opdracht.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-getquery/

Eigenschappen

Eigendom Detail
Zoek-ID Voer de ID van de query in waarvan u metadata wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Vraag JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Record verkrijgen

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​record op te halen, gebruikt u het eindpunt Een enkel record ophalen.

Records opvragen

Deze opdracht is alleen beschikbaar via de Platform API. Om meerdere records op te halen, gebruikt u het eindpunt Een lijst met records ophalen.

Ontvang rapporten

Om alle rapporten uit het SOX- en interne auditdatabaseaccount van uw organisatie op te halen, gebruikt u de opdracht Get reports.

Gelijkwaardige API-aanroep:https://developers.workiva.com/platform-v1/platform-graphreportexport/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Rapporten Bestand
Rapportage aantal Geheel getal

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Selecteer de lijst

Om een ​​lijst met waarden voor een queryparameter met meerdere selecties op te halen op basis van de ID van de lijst, gebruikt u de opdracht Get select list.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-getselectlist/

Eigenschappen

Eigendom Detail
Selecteer lijst-ID Voer de unieke identificatiecode in van de selectielijst die u wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Selecteer de payload van de lijst. JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Haal de gegevens op uit het spreadsheet.

Om alle gegevens in een specifiek gedeelte van een werkblad op te halen, gebruikt u de opdracht Gegevens van werkblad ophalen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in, samen met het blad waarvan u de gegevens wilt ophalen.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het werkblad waarvan u de gegevens wilt ophalen.
Regio Voer de A1-stijlweergave van een cel of bereik in, bijvoorbeeld [Startkolom][Startrij]:[Eindkolom][Eindrij]. Om het bereik in één of alle richtingen onbegrensd te maken, laat u de corresponderende kolom of rij weg.
Waardestijl Selecteer of u de ruwe of de berekende celwaarde wilt weergeven. Als de waarde van een cel bijvoorbeeld =1+:1is, selecteer dan 'Ruwe waarde' voor =1+1, of 'Berekend' voor de berekende waarde van 2.
Herziening Voer de versie van het spreadsheet in waarvan u de gegevens wilt ophalen. Voer voor de huidige versie -1 in.
Gebruik de platform-API Als dit vakje is aangevinkt, geeft deze opdracht de gegevens van het werkblad weer in de standaard decimale notatie.Als het veld leeg is, worden de gegevens in wetenschappelijke notatie weergegeven. Hierdoor wordt de opdracht gedwongen om de functie Gegevens ophalen van een spreadsheet-eindpunt te gebruiken, in plaats van de functie Gegevens retourneren van een regio-eindpunt van de spreadsheet-API.

Uitgangen

Uitvoer Uitvoertype
Aantal rijen Geheel getal
Gegevens Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Metagegevens van het werkblad ophalen

Om de metadata van een werkblad in een spreadsheet op te halen, gebruikt u de opdracht Get sheet metadata.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/getsheetdata.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in, samen met het blad waarvan u de metadata wilt ophalen.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het werkblad waarvan u de metagegevens wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Bladmetadata JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Metagegevens van spreadsheets ophalen

Om de metadata van een spreadsheet op te halen, gebruikt u de opdracht Get spreadsheet metadata.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in waarvan u de metadata wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Spreadsheet-metadata JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Tabelmetadata ophalen

Om de metadata van een Wdata-tabel op te halen, gebruikt u een Get table metadata commando.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-gettable/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de unieke identificatiecode in van de tabel waarvan u metadata wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Tabel JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Type verkrijgen

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​record op te halen, gebruikt u het eindpunt Een enkel record ophalen.

Krijg typen

Deze opdracht is alleen beschikbaar via de Platform API. Om meerdere recordtypen op te halen, gebruikt u het eindpunt Een lijst met typen ophalen.
 

Gezondheidscontrole

Om de status van de Wdata API te controleren, gebruikt u een Health check commando.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-healthcheck/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Antwoord JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Importeer het bestand in de tabel.

Om een ​​bestand in een Wdata-tabel te importeren, gebruikt u de opdracht Import file into table.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-importfile/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de ID in van de tabel waarin u het bestand wilt importeren.
Bestands-ID Voer de ID in van het bestand dat u in de tabel wilt importeren.
Kolomtoewijzingen Koppel elke kolom in het bestand aan de kolommen van de tabel.
Asynchroon uitvoeren Om de opdracht asynchroon uit te voeren en niet te wachten tot de import is voltooid voordat de keten verdergaat, vinkt u dit vakje aan.
Labels Om metadata toe te voegen die uw organisatie over de gegevens bijhoudt, voegt u tags toe en selecteert u de namen en waarden ervan.

Uitgangen

Uitvoer Uitvoertype
Bestand importeren JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Importeer spreadsheet in tabel

Om een ​​spreadsheet in een tabel te importeren en een resultaat met bestandsmetadata te verkrijgen, gebruikt u de opdracht Import spreadsheet into table.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de unieke identificatiecode in van de tabel waarin u het bestand wilt importeren.
Bestands-ID Voer de unieke identificatiecode in van het bestand waarin u de spreadsheet wilt importeren (optioneel).
Bestandsnaam Voer de unieke naam in die aan het bestand moet worden gegeven bij het importeren in de tabel.
Spreadsheet-URL Voer de volledige URL in van het spreadsheet waarvan u gegevens wilt importeren.
Asynchroon uitvoeren Om de opdracht asynchroon uit te voeren en niet te wachten tot de import is voltooid voordat de keten verdergaat, vinkt u dit vakje aan.
Labels Om metadata toe te voegen die uw organisatie over de gegevens bijhoudt, voegt u tags toe en selecteert u de namen en waarden ervan.

Uitgangen

Uitvoer Uitvoertype
Bestand importeren JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijstverbindingen

Om gegevens tussen functies van het Workiva-platform weer te geven, gebruikt u de opdracht List connections.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-listconnections/

Eigenschappen
Eigendom Detail
Brontype Gebruik het keuzemenu om het type bestand of item te selecteren waaruit u gegevens wilt ophalen.
Bestemmingstype Gebruik het keuzemenu om het type bestand of item te selecteren waarnaar u gegevens wilt verzenden.
Bron-ID Voer de unieke identificatiecode in van het bestand of item waarvan u gegevens wilt ophalen.
Bestemmings-ID Voer de unieke identificatiecode in van het bestand of item waarnaar u gegevens wilt verzenden.
Opmerking: Uw verzoek moet een Brontype + Bron-ID of een Bestemmingstype + Bestemmings-IDbevatten; het verzoek zal mislukken als een van deze paren ontbreekt.

Uitgangen

Uitvoer Uitvoertype
Verbindingen JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijst met bestandsfouten

Om de fouten weer te geven die aan een bestand zijn gekoppeld, bijvoorbeeld als gevolg van een import, gebruikt u de opdracht List file errors.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-geterrors/

Eigenschappen

Eigendom Detail
Bestands-ID Voer de ID in van het bestand waarvoor u foutmeldingen wilt ontvangen.

Uitgangen

Uitvoer Uitvoertype
Foutenlijst JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijst bestanden

Om een ​​lijst met bestanden in een Wdata-tabel en hun metadata op te halen, gebruikt u het commando List files.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-getfiles/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de ID in van de tabel waarvan u bestanden wilt ophalen.

Uitgangen

Uitvoer Uitvoertype
Bestandenlijst Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijst-draaiweergaven

Om de Wdata-weergaven in uw werkruimte weer te geven en hun metadata op te halen, gebruikt u de opdracht Lijst pivotweergaven.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Draaiweergaven JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijstquery's

Om de Wdata-query's in uw werkruimte weer te geven en hun metadata op te halen, gebruikt u de opdracht List queries.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-listqueries/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Query's JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijst met zoekresultaten

Om de beschikbare resultaten voor een Wdata-query weer te geven, gebruikt u de opdracht List query results.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/

Eigenschappen

Eigendom Detail
Zoek-ID Voer de ID van de zoekopdracht in waarvan u resultaten wilt ontvangen.

Uitgangen

Uitvoer Uitvoertype
Zoekresultaten JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijsten selecteren lijsten

Om alle lijsten met waarden voor meerkeuzequeryparameters in uw werkruimte weer te geven en de bijbehorende metadata op te halen, gebruikt u de opdracht List select lists.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-listselectlists/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Lijsten selecteren lijsten JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijstbladen

Om alle werkbladen in een spreadsheet weer te geven en hun metadata op te halen, gebruikt u de opdracht List sheets.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/getlegacysheets.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet waarvan u de werkbladen wilt weergeven.

Uitgangen

Uitvoer Uitvoertype
Lakens JSON
Aantal vellen Geheel getal

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijsttabellen

Om alle Wdata-tabellen in uw werkruimte weer te geven en hun metadata op te halen, gebruikt u de opdracht List tables.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-gettables/

Eigenschappen

Geen

Uitgangen

Uitvoer Uitvoertype
Tabellijst JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Lijst gebruikers

Om een ​​lijst met details over de gebruikers van een organisatie op te vragen, gebruikt u het commando List users. De door u toegewezen integratiegebruiker moet de rol Organisatiebeheerder hebben om deze opdracht uit te voeren.

Net als bij de exportfunctie "Personenoverzicht" van een organisatiebeheerder, worden de gegevens gesorteerd op weergavenaam en bevatten ze de volgende informatie over de gebruikers:

  • Gebruikersnamen
  • E-mailadressen
  • SAML-ID's
  • Laatste aanmeldingen
  • Werkpleklidmaatschappen
  • Licenties en rollen

Gelijkwaardige API-aanroep: https://developers.workiva.com/admin-v1/admin-getorgreportusers/

Eigenschappen

Eigendom Detail
Organisatie-ID Voer de unieke identificatiecode in van de organisatie waarvoor u een lijst met gebruikers wilt genereren.

Uitgangen

Uitvoer Uitvoertype
Gebruikers melden Bestand
Aantal records Geheel getal

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Gegevens in het werkblad overschrijven

Om alle cellen in een werkblad te wissen en te vervangen door de waarden uit het bestand, gebruikt u de opdracht Overwrite sheet data.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/updatesheet.html#

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet waarvan u de gegevens wilt overschrijven.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het werkblad waarin u de gegevens wilt overschrijven.
Gegevensbestand Voer het CSV-bestand in met de gegevens waarmee u het werkblad wilt vullen.
Scheidingsteken Voer het scheidingsteken in dat wordt gebruikt in Gegevensbestand.
Gebruik de platform-API Om de celwaarden in het spreadsheet in de opmaak [ Ingevoerd in te gebruiken, vinkt u dit vakje aan.

Uitgangen

Uitvoer Uitvoertype
Rij geschreven Geheel getal
Geschreven cellen Geheel getal

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Spreadsheet publiceren

Om de links in een spreadsheet te publiceren, gebruikt u de opdracht Spreadsheet publiceren.

Gelijkwaardige API-aanroep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode in van het spreadsheet dat u wilt publiceren.
Alle links publiceren

Selecteer welke links in het spreadsheet u wilt publiceren:

  • Om alle links te publiceren, vinkt u dit vakje aan.
  • Om alleen links te publiceren die je zelfbezit , wis je dit vakje.

Uitgangen

Uitvoer Uitvoertype
Bericht String

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Verbinding vernieuwen

Om een ​​specifieke verbinding te vernieuwen op basis van de ID ervan, gebruikt u de opdracht Verbinding vernieuwen.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/

Eigenschappen

Eigendom Detail
Verbindings-ID Voer de unieke identificatiecode van de verbinding in om deze te vernieuwen.
Gebruik de vorige bronparameters Vink dit vakje aan om de bronparameters van de vorige run te gebruiken; hiermee worden alle andere door u opgegeven bronparameters overschreven.

Deze invoer wordt genegeerd door het eindpunt "Verbindingen vernieuwen".
Bronparameters*

Voer de parameters in die bij een succesvolle vernieuwing naar de bron moeten worden verzonden.

(Deze parameters worden genegeerd als "Gebruik vorige bronparameters" is ingeschakeld.)
Gebruik de vorige bestemmingsparameters Vink dit vakje aan om de bestemmingsparameters van de vorige run te gebruiken; hiermee worden alle andere door u opgegeven bestemmingsparameters overschreven.

Deze invoer wordt genegeerd door het eindpunt "Verbindingen vernieuwen".
Bestemmingsparameters*

Voer de parameters in die bij een succesvolle vernieuwing naar de bestemming moeten worden verzonden.

(Deze parameters worden genegeerd als "Vorige bestemmingsparameters gebruiken" is ingeschakeld.)
Opmerking: Parameters met meerdere selectiemogelijkheden worden momenteel niet ondersteund.

Uitgangen

Uitvoer Uitvoertype
Vernieuw status JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Vernieuw de batch verbindingen

Om meerdere verbindingen tegelijk te vernieuwen, gebruikt u de opdracht Refresh batch of connections.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/

Eigenschappen

Eigendom Detail
Verbindingen

Schakel deze optie in of uit voor het gebruik van variabelen.

Wanneer ingeschakeld:

  • De beschikbare variabelen kunnen worden geselecteerd via het menu aan de linkerkant.
  • Er kunnen geen nieuwe verbindingen worden toegevoegd.
Verbindings-ID Voer de unieke identificatiecode van de verbinding in om deze te vernieuwen.
Gebruik de vorige bronparameters Vink dit vakje aan om de bronparameters van de vorige run te gebruiken; hiermee worden alle andere door u opgegeven bronparameters overschreven.

Deze invoer wordt genegeerd door het eindpunt "Verbindingen vernieuwen".
Bronparameters

Voer de parameters in die bij een succesvolle vernieuwing naar de bron moeten worden verzonden.

(Deze parameters worden genegeerd als "Gebruik vorige bronparameters" is ingeschakeld.)
Gebruik de vorige bestemmingsparameters Vink dit vakje aan om de bestemmingsparameters van de vorige run te gebruiken; hiermee worden alle andere door u opgegeven bestemmingsparameters overschreven.

Deze invoer wordt genegeerd door het eindpunt "Verbindingen vernieuwen".
Bestemmingsparameters

Voer de parameters in die bij een succesvolle vernieuwing naar de bestemming moeten worden verzonden.

(Deze parameters worden genegeerd als "Vorige bestemmingsparameters gebruiken" is ingeschakeld.)

Uitgangen

Uitvoer Uitvoertype
Batchvernieuwingsstatus JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Rand verwijderen

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​rand te verwijderen, gebruikt u het eindpunt Create new record edits.

Een lijst met records ophalen

Om een ​​lijst met records te retourneren die aan de opgegeven filters voldoen, gebruikt u de opdracht Een lijst met records ophalen. Er is altijd minimaal één filter nodig.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-getrecords/

Eigenschappen

Eigendom Detail
Uitbreiden

Geeft gerelateerde bronnen terug die overeenkomen met de hoofdbron.

Opties:

  • Geen (standaard)
  • Relaties
Filter De eigenschappen waarop de resultaten gefilterd moeten worden.

Uitgangen

Uitvoer Uitvoertype
Batchvernieuwingsstatus JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Een lijst met typen ophalen

Om een ​​lijst met recordtypen en hun attributen op te vragen, gebruikt u de opdracht Een lijst met typen ophalen. Met dit commando weet je wat je kunt verwachten bij het ophalen van records.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-gettypes/

Eigenschappen

Eigendom Detail
Uitbreiden

Geeft gerelateerde bronnen terug die overeenkomen met de hoofdbron.

Opties:

  • Geen (standaard)
  • Relaties

Uitgangen

Uitvoer Uitvoertype
Batchvernieuwingsstatus JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Een enkel record ophalen

Om één enkel record op te halen, gebruikt u de opdracht Een lijst met records ophalen. De unieke identificatiecode is doorgaans een UUID, maar dit kan variëren.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-getrecordbyid/

Eigenschappen

Eigendom Detail
Uitbreiden

Geeft gerelateerde bronnen terug die overeenkomen met de hoofdbron.

Opties:

  • Geen (standaard)
  • Relaties
Record-ID Voer de unieke identificatiecode van het record in.

Uitgangen

Uitvoer Uitvoertype
Batchvernieuwingsstatus JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Een enkel type ophalen

Om één enkel record op te halen, gebruikt u de opdracht Een lijst met records ophalen. De unieke identificatiecode is doorgaans een UUID, maar dit kan variëren.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-gettypebyid/

Eigenschappen

Eigendom Detail
Uitbreiden

Geeft gerelateerde bronnen terug die overeenkomen met de hoofdbron.

Opties:

  • Geen (standaard)
  • Relaties
Record-ID Voer de unieke identificatiecode van het record in.

Uitgangen

Uitvoer Uitvoertype
Batchvernieuwingsstatus JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Voer query uit

Om een ​​Wdata-query uit te voeren en de resultaten ervan op te halen, gebruikt u de opdracht Run query.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-runquery/

Eigenschappen

Eigendom Detail
Zoek-ID Voer de ID in van de query die u wilt uitvoeren.
Parameters

Als de query parameters heeft gedefinieerd, voeg dan een kaart toe met hun namen en waarden.

Opmerking: Voer de waarden van alle parameters met meerkeuzeopties in Parameters met meerkeuzeopties.
Asynchroon uitvoeren Om de query asynchroon uit te voeren en niet te wachten tot de query is voltooid voordat de opdracht wordt uitgevoerd, vinkt u dit vakje aan.
Meerdere parameters selecteren Als de query parameters met meerdere selectiemogelijkheden bevat, voeg dan de naam en waarden van elk ervan toe.

Uitgangen

Uitvoer Uitvoertype
Zoekresultaat JSON
Opmerking: De Query Resultaat uitvoer bevat een ID, die kan worden gebruikt om de resultaten te downloaden en te exporteren.

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Rapport uitvoeren

Om een ​​opgeslagen rapport in het SOX- en interne auditdatabaseaccount van uw organisatie uit te voeren en de resultaten als een CSV-bestand te retourneren, gebruikt u de opdracht Rapport uitvoeren.

Gelijkwaardige API-aanroep: https://developers.workiva.com/platform-v1/platform-getreportascsv/

Eigenschappen

Eigendom Detail
Rapport-ID Voer de unieke identificatiecode in van het rapport waarin het opgeslagen rapport zich bevindt.
Voorbeeldinhoud Om een ​​voorbeeld van de rapportresultaten in het logboek van de opdracht op te nemen, vinkt u dit vakje aan.

Uitgangen

Uitvoer Uitvoertype
Rapporteren Bestand

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Stel rand in

Deze opdracht is alleen beschikbaar via de Platform API. Om een ​​rand in te stellen, gebruikt u het eindpunt Create new record edits.

Stel recordeigenschappen in

Deze opdracht is alleen beschikbaar via de Platform API. Om recordeigenschappen in te stellen, gebruikt u het eindpunt Create new record edits.

Bestand uit tabel verwijderen

Om een ​​bestand uit een Wdata-tabel te verwijderen en de import ongedaan te maken, gebruikt u de opdracht Un-import file From table.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-unimportfile/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de unieke identificatiecode in van de tabel waaruit u het bestand wilt verwijderen.
Bestands-ID Voer de unieke identificatiecode in van het bestand dat u uit de tabel wilt verwijderen.

Uitgangen

Uitvoer Uitvoertype
Bestand importeren JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Draaiweergave bijwerken

Om de metadata van een Wdata-weergave bij te werken, gebruikt u een Update pivot view -opdracht.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/

Eigenschappen

Eigendom Detail
id Voer de ID in van de weergave die u wilt bijwerken.
Naam Voer de nieuwe naam van de weergave in.
Zoek-ID Voer de ID in van de query waarvan u de weergave wilt maken.
Zoekresultaat-ID Voer de ID van het queryresultaat in om de weergave te creëren.
Aanvullende metadata Voer de door de gebruiker gedefinieerde metadata in die aan de weergave moet worden gekoppeld, als een JSON-object (optioneel).

Uitgangen

Uitvoer Uitvoertype
Draaiweergave JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

De querydefinitie bijwerken

Om de eigenschappen van een Wdata-query bij te werken, gebruikt u een Update query definition -opdracht.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-updatequery/

Eigenschappen

Eigendom Detail
Zoek-ID Voer de ID in van de query die u wilt bijwerken.
Naam Voer de nieuwe naam van de query in.
Beschrijving Voer de nieuwe beschrijving van de zoekopdracht in.
Primaire resultaat-ID Voer, indien gespecificeerd, de ID in van het standaardresultaat waarmee de zoekresultaten moeten worden ingevuld.
Zoektekst Voer de querydefinitie in als Presto SQL-syntaxis, zoals u dat zou doen in de SQL-editor van de query.
Tijdelijk Om de query slechts tijdelijk te genereren, zodat deze niet in uw werkruimte verschijnt, vinkt u dit vakje aan.
Parameters Voer de parameters in die nodig zijn om de query uit te voeren.

Uitgangen

Uitvoer Uitvoertype
Vraag JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Selectielijst bijwerken

Om de eigenschappen of items voor een lijst met waarden voor een queryparameter met meerdere selectiemogelijkheden bij te werken, gebruikt u een Update select list -opdracht.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/

Eigenschappen

Eigendom Detail
id Voer de ID in van de selectielijst die u wilt bijwerken.
Naam Voer de nieuwe naam van de selectielijst in.
Beschrijving Voer de nieuwe beschrijving van de selectielijst in.
Waardetype Selecteer het gegevenstype van de waarden in de lijst, zoals tekenreeks of geheel getal.
Waarden Voer de waarden van de lijst in, inclusief eventuele updates.

Uitgangen

Uitvoer Uitvoertype
Selectielijst bijwerken JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Metagegevens van het werkblad bijwerken

Om de metagegevens van een werkblad in een spreadsheet bij te werken, gebruikt u de opdracht Metagegevens van werkblad bijwerken.

Gelijkwaardige API-aanroep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in, samen met het blad waarvan u de metagegevens wilt bijwerken.
Blad-ID/naam Voer de naam of unieke identificatiecode in van het werkblad waarvan u de metagegevens wilt bijwerken.
Naam Voer de nieuwe naam van het werkblad in.
Bladindex Voer de nieuwe index van het werkblad in de spreadsheet in. Standaard werkt de opdracht het werkblad bij als het bovenste werkblad.
Ouderblad-ID Voer de ID in van het bovenliggende werkblad waaronder u het werkblad wilt aanmaken. Om iets aan het hoofdbestand toe te voegen, laat u dit veld leeg.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Metagegevens van spreadsheets bijwerken

Om de metagegevens van een spreadsheet bij te werken, gebruikt u de opdracht Update spreadsheet metadata.

Gelijkwaardige API-aanroep: https://developers.workiva.com/2022-01-01/updatesheet.html

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in, samen met het blad waarvan u de metagegevens wilt bijwerken.
Naam Voer de nieuwe naam van het spreadsheet in.

Uitgangen

Geen

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Tabel bijwerken

Om de kolommen van een Wdata-tabel bij te werken, gebruikt u een Update table -opdracht.

Gelijkwaardige API-aanroep: https://developers.workiva.com/wdata-v1/wdata-updatetable/

Eigenschappen

Eigendom Detail
Tabel-ID Voer de unieke identificatiecode in van de tabel die u wilt bijwerken.
Naam Voer de naam in van de tabel die u wilt bijwerken.
Beschrijving Voer een beschrijving in van de tabel die u wilt bijwerken.
type Selecteer of u een gegevenstabel (of feit) of opzoektabel (of dimensie) wilt bijwerken.
Kolommen Voeg de kolommen toe waarmee de tabel moet worden bijgewerkt. Voer voor elke kolom de naam, het gegevenstype, de alias en de beschrijving in. Voor Mode, laat de standaardwaarde Nullable staan.

Uitgangen

Uitvoer Uitvoertype
Tabel JSON

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

Schrijf de gegevens op het werkblad.

Om gegevens in een CSV-gegevensset naar een specifiek gedeelte van een werkblad te schrijven, gebruikt u de opdracht Schrijf werkbladgegevens.

Eigenschappen

Eigendom Detail
Spreadsheet-ID Voer de unieke identificatiecode van het spreadsheet in, samen met het blad waarnaar de gegevens moeten worden geschreven.
Blad-ID/naam Voer de unieke identificatiecode in van het werkblad waarnaar de gegevens moeten worden geschreven.
Gegevensbestand Voer het CSV-bestand in met de gegevens die u naar het werkblad wilt schrijven. Het bereik van de gegevens mag niet het gebiedoverschrijden.
Scheidingsteken Voer het scheidingsteken in dat wordt gebruikt in Gegevensbestand. 
Regio Voer een A1-representatie in van de cel of het celbereik in het werkblad waarnaar de gegevens moeten worden geschreven. Om het bereik in één of alle richtingen onbegrensd te laten, laat u de betreffende kolom of rij leeg.
Gebruik asynchroon

Om de gegevens asynchroon te laden, bijvoorbeeld bij een grote dataset, vinkt u dit vakje aan.

Opmerking: Bij gebruik van asynchrone bewerkingen moet u zelf polling toevoegen om de status van de taak te bepalen.
Gebruik de platform-API

Om de ingevoerde indeling van de celwaarden in het gebiedte gebruiken, vinkt u dit vakje aan.

Hierdoor wordt de opdracht gedwongen om het update values ​​in a range endpoint te gebruiken in plaats van het write data to a region endpointvan de spreadsheet-API. 

Opmerking: Deze opdracht wordt altijd asynchroon uitgevoerd bij gebruik van de platform-API. Je moet zelf een polling-functie toevoegen om de status van de taak te bepalen.

Uitgangen

Uitvoer Uitvoertype
Geschreven rijen Geheel getal
Geschreven cellen Geheel getal

Uitgangscodes

Code type Detail
0 Succes Succes
1 Fout Fout

 

Was dit artikel nuttig?
Aantal gebruikers dat dit nuttig vond: 6 van 9
Om taken binnen het Workiva-platform te automatiseren als onderdeel van een keten, bijvoorbeeld om de uitwisseling va...