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 die een Workiva verbindingsopdracht bevat.
Om deze opdrachten in te schakelen, stelt een IT-beheerder eerst een Workiva-connector in.
Duidelijke bladgegevens
Om alle gegevens in een blad te wissen, gebruikt u de opdracht Bladgegevens wissen.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in voor de spreadsheet met het blad dat u wilt wissen. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad dat u wilt wissen. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bestand maken
Als u een CSV-bestand (comma-separated values), JSON-bestand (Javascript object notation) of gecomprimeerd ZIP-bestand wilt uploaden en een lijst met records wilt maken, gebruikt u de opdracht Bestand maken. U kunt ook de URL naar het bestand uploaden, zoals een door Amazon S3® ondertekende URL naar een bestand in een S3 bucket.
- Als het een JSON-bestand is, moet het een enkele JSON-record per regel hebben - een JSON-bestand is een reeks JSON-objecten die worden gescheiden door een newline-teken.
- Als het een ZIP-bestand is, moet het één CSV- of JSON-bestand bevatten, waarvan de naam gebruikt wordt om het geïmporteerde bestand een naam te geven. Als u het bestand opnieuw downloadt, wordt de bron gedownload.
- Als het een URL is, doet het eindpunt een verzoek om een bestand op te halen met een eenvoudig niet-geauthenticeerd
GETverzoek.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer het ID in van de tabel waarvan u de bestanden wilt weergeven. |
| Bestand | Voer het te uploaden bestand in. Wordt genegeerd als Download URL is ingevuld. 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 ingevuld, voer dan de naam in van het bestand dat u wilt uploaden; standaard is dit de basisnaam van Download URL. |
| URL downloaden | Voer de URL in die naar het te downloaden bestand wijst, zoals een door Amazon S3 ondertekende URL. Optioneel als Bestand is ingevoerd. Opmerking: De opdracht maakt een eenvoudige |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Resultaten | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Nieuwe recordbewerkingen maken
Om nieuwe recordbewerkingen te maken met de geleverde eigenschappen, gebruikt u een opdracht Nieuwe recordbewerkingen maken. Voor elke bewerking zijn ten minste een bewerking en doelId nodig.
Limiet: Per aanvraag kunnen maximaal 1000 bewerkingen worden verwerkt.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-createedits/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Operatie |
Selecteer de uit te voeren bewerking. Opties:
|
| Label | Voer een label in dat de relatie tussen de twee records beschrijft. Wordt gebruikt om een relatie aan te maken of te verwijderen. |
| Eigenschappen | Voer de eigenschappen van het recordtype in. Wordt gebruikt om een record aan te maken of de eigenschappen ervan in te stellen. |
| Record-ID | Voer het ID of tijdelijk record-ID van de bron in. Wordt gebruikt om een relatie aan te maken of te verwijderen. |
| Doel-ID | Voer de ID van de doelrecord in. Als u een record aanmaakt, kunt u de record-ID of de tijdelijke record-ID gebruiken; als u een record verwijdert, moet u de werkelijke record-ID gebruiken. |
| Tijdelijk record-ID | Voer de tijdelijke ID in die gebruikt zal worden bij het aanmaken van een record; deze tijdelijke ID wordt vervangen op het moment van verwerking. U kunt deze ID binnen dezelfde aanvraag gebruiken om relaties te leggen tussen aangemaakte records. |
| type | Voer het type record in dat u wilt maken. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Draaiveldweergave | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Draaiveldweergave maken
Om een nieuwe Wdata-weergave te maken op basis van de query en het queryresultaat, gebruikt u de opdracht Create pivot view.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Naam | Voer een unieke naam in om de weergave te helpen identificeren. |
| Vraag-ID | Voer de ID in van de query waarvan u de weergave wilt maken. |
| Zoekresultaat ID | Voer de ID in van het queryresultaat waarvan u de weergave wilt maken. |
| Extra metadata | Voer de door de gebruiker gedefinieerde metagegevens in om als JSON-object aan de weergave te koppelen (optioneel). |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Draaiveldweergave | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Voorbeeldquery maken
Om een tijdelijke previewquery op een tabel te maken die vervolgens kan worden uitgevoerd, gebruikt u een Maak previewquery opdracht.
Gelijkwaardige API-aanroep: N/A
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer het ID in van de tabel die u wilt opvragen. |
| Beperk | Voer het maximumaantal resultaten in dat moet worden geretourneerd. |
| Bestand | Voer, indien opgegeven, de naam in van het bestand in de tabel dat moet worden opgevraagd. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Query | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Vraag aanmaken
Om een nieuwe Wdata query te maken, gebruikt u de opdracht Create query.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-createquery/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Naam | Voer een unieke naam in om de query te helpen identificeren. |
| Beschrijving | Voer een beschrijving van de query in. |
| Primair resultaat ID | Voer, indien opgegeven, de ID van het standaardresultaat in dat met de resultaten van de query moet worden gevuld. |
| Tekst zoekopdracht | Voer de querydefinitie in Presto SQL-syntax in, zoals u zou doen in de SQL Editor van de query. |
| Tijdelijk | Om de query tijdelijk te genereren zodat deze niet 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
| Uitgang | Type uitgang |
|---|---|
| Query | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Record aanmaken
Deze opdracht is alleen beschikbaar via de Platform API. Om een nieuwe record aan te maken, gebruikt u het Create new record edits eindpunt.
Selectielijst maken
Om een lijst met waarden voor een multi-select queryparameter te maken, gebruikt u de opdracht Selectielijst maken.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Naam | Voer een unieke naam in om de selectielijst te helpen identificeren. |
| Beschrijving | Om de selectielijst verder te helpen identificeren, voert u een beschrijving van de waarden of parameter in. |
| Waardetype | Selecteer het gegevenstype van de waarden in de lijst, zoals tekenreeks of geheel getal. |
| Waarden | Voer de waarden van de lijst in. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Metagegevens voor selectielijst maken | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout |
Fout |
Blad maken
Om een nieuw blad aan een spreadsheet toe te voegen, gebruikt u de opdracht Blad maken.
Equivalente API-oproep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet waaraan u het blad wilt toevoegen. |
| Naam | Voer een unieke naam in om het blad te helpen identificeren. |
| Bladindex | Voer de index van het nieuwe blad binnen de spreadsheet in. Opmerking: Standaard voegt de opdracht het blad toe als bovenste blad. |
| Ouderblad ID | Voer het ID in van het bovenliggende blad waaronder u het blad wilt maken. Laat leeg om toe te voegen aan de root-spreadsheet. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Blad metagegevens | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Maak spreadsheet
Om een nieuwe spreadsheet te maken, gebruikt u de opdracht Spreadsheet maken.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Naam | Voer de unieke naam in om de spreadsheet te helpen identificeren. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Blad metagegevens | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Tabel aanmaken
Om een nieuwe Wdata-tabel in uw werkruimte te maken, gebruikt u de opdracht Create table.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-createtable/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Naam | Voer een unieke naam in om de tabel te helpen 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:
|
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Tabel | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bestand verwijderen
Om een bestand uit uw Wdata werkruimte te verwijderen, gebruikt u de opdracht Delete file.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Bestands-ID | Voer de ID van het te verwijderen bestand in. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Draaiveldweergave verwijderen
Als u een Wdata-weergave uit uw werkruimte wilt verwijderen, gebruikt u de opdracht Delete pivot view.
Equivalente API-oproep: 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
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Vraag verwijderen
Om een Wdata query uit uw werkruimte te verwijderen, gebruikt u de opdracht query verwijderen.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Vraag-ID | Voer de ID in van de query die u wilt verwijderen. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Verwijder record
Blad verwijderen
Om een blad en zijn kindbladen (recursief) uit een spreadsheet te verwijderen, gebruikt u de opdracht Blad verwijderen.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad dat u wilt verwijderen. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad dat u wilt verwijderen. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Spreadsheet verwijderen
Om een spreadsheet uit uw werkruimte te verwijderen, gebruikt u de opdracht Delete spreadsheet.
Equivalente API-oproep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet die u wilt verwijderen. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Tabel verwijderen
Om een Wdata-tabel uit uw werkruimte te verwijderen, gebruikt u de opdracht Delete table.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer de unieke identificatie in van de tabel die u wilt verwijderen |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bestand downloaden
Om een dataset van uw Wdata workspace te downloaden, gebruikt u de opdracht Download bestand.
Opmerking: Deze opdracht is niet compatibel met andere objecttypes zoals spreadsheets, tabellen of query's.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Bestands-ID | Voer de ID van het te downloaden bestand in. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bestand | Bestand |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
| Input | Detail |
| ID | Enter the ID of the pivot view to download |
Outputs
| Output | Output Type |
| Pivot View Content | File |
Exit Codes
| 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 |
Zoekresultaat downloaden
Om de resultaten van een Wdata query naar een bestand te downloaden, gebruikt u de opdracht Download query resultaat.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Zoekresultaat ID | Voer de ID in van het queryresultaat dat u wilt downloaden. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Zoekresultaat | Bestand |
Afsluitcodes
| 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 Create new record edits eindpunt.
Bestand exporteren naar spreadsheet
Om een dataset uit een Wdatatabel naar een nieuwe of bestaande spreadsheet te exporteren, gebruikt u de opdracht Export file to spreadsheet.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Bestands-ID | Voer de ID in van de tabelgegevensverzameling die u wilt exporteren. |
| URL van spreadsheet | Voer de URL in van de spreadsheet waarnaar u wilt exporteren. Laat leeg als u een nieuwe spreadsheet wilt maken. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Informatieblad | Bestand |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Query resultaat exporteren
Om een Wdata queryresultaat naar een nieuwe of bestaande spreadsheet te exporteren, gebruikt u de opdracht Queryresultaat exporteren.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Zoekresultaat ID | Voer de ID in van het queryresultaat dat u wilt exporteren. |
| URL van spreadsheet |
Voer de URL in van de spreadsheet waarnaar u wilt exporteren. Laat leeg als u een nieuwe spreadsheet wilt maken. |
| Exporteren als dataset |
Indien aangevinkt, worden de gegevens geëxporteerd als een gekoppelde dataset en kunnen de cellen alleen bewerkt worden door de dataset in de spreadsheet bij te werken. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bestandseigenschappen ophalen
Om de eigenschappen van een bestand in uw Wdata workspace op te halen, gebruikt u de opdracht Get file properties.
Equivalente API-oproep: 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
| Uitgang | Type uitgang |
|---|---|
| Bestandseigenschappen | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Een spilweergave krijgen
Om de metadata van een Wdata-weergave op te halen, gebruikt u de opdracht Get pivot view.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Eigenschappen
| Eigendom | Detail |
|---|---|
| id | Voer de ID in van de draaitabel waarvan u metagegevens wilt ophalen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Draaiveldweergave | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Vraag metagegevens op
Om de metadata van een Wdata query op te halen, gebruikt u de opdracht Get query metadata.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-getquery/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Vraag-ID | Voer het ID van de query in om metagegevens van te krijgen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Query | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Gegevens krijgen
Deze opdracht is alleen beschikbaar via de Platform API. Om een record op te halen, gebruikt u het Retrieve a single record eindpunt.
Records krijgen
Deze opdracht is alleen beschikbaar via de Platform API. Om meerdere records op te halen, gebruikt u het eindpunt Een lijst met records ophalen.
Rapporten krijgen
Om alle rapporten van de SOX en Interne Audit databaseaccount van uw organisatie op te halen, gebruikt u de opdracht Get reports.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Rapporten | Bestand |
| Aantal rapporten | Geheel getal |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Selectielijst ophalen
Om een lijst met waarden voor een multi-select queryparameter op te halen op basis van de ID van de lijst, gebruikt u een opdracht Get select list.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Selecteer lijst-ID | Voer de unieke identificatie van de op te halen selectielijst in. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Verkrijg de payload van de selectielijst | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bladgegevens ophalen
Om alle gegevens in een opgegeven gebied van een vel op te halen, gebruikt u de opdracht Haal velgegevens.
Equivalente API-oproep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad waarvan u gegevens wilt ophalen. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad waarvan u gegevens wilt ophalen. |
| Regio | Voer de A1-stijl weergave van een cel of bereik in, zoals [Start kolom][Start rij]:[Stop kolom][Stop rij]. Om het bereik in één of alle richtingen onbegrensd te maken, laat u de bijbehorende kolom of rij weg. |
| Waardevolle stijl | Selecteer of u de onbewerkte of berekende celwaarde wilt retourneren. Als de waarde van een cel bijvoorbeeld =1+:1 is, selecteert u Ruw voor =1+1, of Berekend voor de berekende waarde 2. |
| Herziening | Voer de versie van het blad in waarvan u gegevens wilt ophalen. Voor de huidige versie voert u -1 in. |
| Platform-API gebruiken | Als dit vakje is aangevinkt, geeft dit commando de velgegevens in standaard decimale notatie. Als deze leeg is, worden de bladgegevens in wetenschappelijke notatie geretourneerd. Hierdoor zal de opdracht hetRetrieve data from a sheet endpointgebruiken in plaats van de spreadsheet API'sReturn data from a region endpoint. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Aantal rijen | Geheel getal |
| Gegevens | Bestand |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Metagegevens vel ophalen
Om de metagegevens van een blad in een spreadsheet op te halen, gebruikt u de opdracht Haal bladmetagegevens.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/getsheetdata.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad waarvan metagegevens moeten worden opgehaald. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad waarvan u metagegevens wilt ophalen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Blad metagegevens | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Haal metagegevens van spreadsheets op
Om de metadata van een spreadsheet op te halen, gebruikt u de opdracht Haal metadata van spreadsheet.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet waarvan u metagegevens wilt ophalen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Metagegevens spreadsheet | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Metagegevens van tabel ophalen
Om de metadata van een Wdata-tabel op te halen, gebruikt u de opdracht Get table metadata.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-gettable/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer de unieke identificatiecode in van de tabel waarvan u metagegevens wilt ophalen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Tabel | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Type krijgen
Deze opdracht is alleen beschikbaar via de Platform API. Om een record op te halen, gebruikt u het Retrieve a single record eindpunt.
Soorten krijgen
Deze opdracht is alleen beschikbaar via de Platform API. Om meerdere recordtypes op te halen, gebruikt u het eindpunt Een lijst met types ophalen.
<!-- display page content -->
Gezondheidscontrole
Gebruik de opdracht Health check om de gezondheid van de Wdata API te controleren.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Reactie | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bestand in tabel importeren
Om een bestand in een Wdatatabel te importeren, gebruikt u de opdracht Bestand importeren in tabel.
Equivalente API-oproep: 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. |
| Kolom toewijzingen | Breng elke kolom in het bestand in kaart met de kolommen in de tabel. |
| Asynchroon uitvoeren | Schakel dit selectievakje in om de opdracht asynchroon uit te voeren en niet te laten wachten tot de import voltooid is voordat u verdergaat met de keten. |
| Labels | Om metadata die uw organisatie bijhoudt over de gegevens toe te voegen, voegt u tags toe en selecteert u hun namen en waarden. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bestanden importeren | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Spreadsheet importeren in tabel
Om een spreadsheet in een tabel te importeren en een meta-bestandsresultaat te retourneren, gebruikt u de opdracht Import spreadsheet into table.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer de unieke identificatie in van de tabel waarin u het bestand wilt importeren. |
| Bestands-ID | Voer de unieke identificatie in van het bestand waarin u de spreadsheet wilt importeren (optioneel). |
| Bestandsnaam | Voer de unieke naam in die het bestand krijgt bij het importeren in de tabel. |
| URL van spreadsheet | Voer de volledige URL in van de spreadsheet waaruit u gegevens wilt importeren. |
| Asynchroon uitvoeren | Schakel dit selectievakje in om de opdracht asynchroon uit te voeren en niet te laten wachten tot de import voltooid is voordat u verdergaat met de keten. |
| Labels | Om metadata die uw organisatie bijhoudt over de gegevens toe te voegen, voegt u tags toe en selecteert u hun namen en waarden. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bestanden importeren | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst verbindingen
Om gegevens tussen functies van het Workiva platform op te sommen, gebruikt u een List connections opdracht.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Eigendom | Detail |
|---|---|
| Bron Type | Selecteer in het vervolgkeuzemenu het type bestand of item waar u gegevens uit wilt halen. |
| Type bestemming | Selecteer in het vervolgkeuzemenu het type bestand of item waarnaar u gegevens wilt verzenden. |
| Bron ID | Voer de unieke identificatie in van het bestand of item waarvan u gegevens wilt ophalen. |
| Bestemming ID | Voer de unieke identificatie in van het bestand of item waarnaar u gegevens wilt verzenden. |
Opmerking: Uw verzoek moet een Bron Type + Bron ID of een Bestemming Type + Bestemming ID bevatten; het verzoek zal mislukken als een van deze paren niet aanwezig is.
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Verbindingen | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst met bestandsfouten
Om de fouten in een bestand op te sommen, bijvoorbeeld als gevolg van een import, gebruikt u de opdracht Lijst bestandsfouten.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Bestands-ID | Voer het ID van het bestand in waarvoor u fouten wilt krijgen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Foutenlijst | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst bestanden
Om een lijst van bestanden in een Wdatatabel en hun metadata op te vragen, gebruikt u de opdracht List files.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer het ID van de tabel in waaruit bestanden moeten worden opgehaald. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bestandenlijst | Bestand |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst draaitabelweergaven
Om de Wdata-weergaven in uw werkruimte op te sommen en hun metagegevens op te halen, gebruikt u de opdracht List pivot views.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Zwenkweergaven | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst zoekopdrachten
Om de Wdata queries in uw werkruimte op te sommen en hun metadata op te halen, gebruikt u de opdracht List queries.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Zoekopdrachten | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Zoekresultaten weergeven
Om de beschikbare resultaten voor een Wdata query op te sommen, gebruikt u de opdracht Lijst queryresultaten.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Vraag-ID | Voer het ID van de query in om resultaten van te krijgen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Resultaten zoekopdracht | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst selecteren
Om alle lijsten met waarden voor meerkeuze queryparameters in uw werkruimte op te sommen en hun metagegevens op te halen, gebruikt u een opdracht Lijst selectielijsten.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Lijst selecteren | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst vellen
Om alle bladen in een spreadsheet op te sommen en hun metadata op te halen, gebruikt u de opdracht List sheets.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet waarvan u de bladen wilt weergeven. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bladen | JSON |
| Aantal vellen | Geheel getal |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst tabellen
Om alle Wdata-tabellen in uw werkruimte op te sommen en hun metadata op te halen, gebruikt u de opdracht List tables.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-gettables/
Eigenschappen
Geen
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Tafellijst | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Lijst gebruikers
Om een lijst met details over de gebruikers van een organisatie op te halen, gebruikt u de opdracht List users. Uw toegewezen integratiegebruiker moet de rol Org Admin hebben om deze opdracht uit te voeren.
Vergelijkbaar met de "People View"-export van een organisatiebeheerder, worden de details gesorteerd op weergavenaam en bevatten ze die van de gebruikers:
- Gebruikersnamen
- E-mailadressen
- SAML ID's
- Laatste aanmeldingen
- Lidmaatschappen voor werkruimten
- Licenties en rollen
Equivalente API-oproep: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Organisatie ID | Voer de unieke identifier van de organisatie in waarvoor gebruikers in de lijst moeten worden opgenomen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Gebruikers melden | Bestand |
| Aantal records | Geheel getal |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bladgegevens overschrijven
Om alle cellen in een blad te wissen en te vervangen door de waarden in het bestand, gebruikt u een opdracht Bladgegevens overschrijven.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/updatesheet.html#
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet waarin u bladgegevens wilt overschrijven. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad waarin u gegevens wilt overschrijven. |
| Gegevensbestand | Voer het CSV-bestand in dat de gegevens bevat waarmee het blad gevuld moet worden. |
| Scheidingsteken | Voer het scheidingsteken in dat wordt gebruikt in Data File. |
| Gebruik platform-API | Schakel dit selectievakje in om de indeling Ingevoerd in van de celwaarden in het spreadsheet te gebruiken. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Rij geschreven | Geheel getal |
| Geschreven cellen | Geheel getal |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Spreadsheet publiceren
Om de links in een spreadsheet te publiceren, gebruikt u de opdracht Publish spreadsheet.
Equivalente API-oproep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet die u wilt publiceren. |
| Alle links publiceren | Selecteer welke links van de spreadsheet u wilt publiceren:
|
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bericht | String |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Verbinding vernieuwen
Om een specifieke verbinding te vernieuwen op basis van haar ID, gebruikt u de opdracht Vernieuw verbinding.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Verbindings-ID | Voer de unieke identificatie in van de verbinding die vernieuwd moet worden. |
| Vorige bronparameters gebruiken | Vink dit vakje aan om de bronparameters van de vorige run te gebruiken; dit heeft voorrang op alle andere bronparameters die u hebt opgegeven. Deze invoer wordt genegeerd door het eindpunt "Batch verbindingen vernieuwen". |
| Bronparameters* |
Voer de parameters in om naar de bron te sturen bij een succesvolle verversing. (Deze parameters worden genegeerd als "Vorige bronparameters gebruiken" is ingeschakeld) |
| Vorige bestemmingsparameters gebruiken | Vink dit vakje aan om de bestemmingsparameters van de vorige run te gebruiken; dit heeft voorrang op alle andere bestemmingsparameters die u hebt opgegeven. Deze invoer wordt genegeerd door het eindpunt "Batch verbindingen vernieuwen". |
| Bestemmingsparameters* |
Voer de parameters in die bij een succesvolle verversing naar de bestemming worden verzonden. (Deze parameters worden genegeerd als "Vorige bestemmingsparameters gebruiken" is ingeschakeld) |
Opmerking: Multi-Select Parameters worden momenteel niet ondersteund.
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status vernieuwen | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Batch verbindingen vernieuwen
Om meerdere verbindingen in één keer te verversen, gebruikt u een Ververs batch van verbindingen opdracht.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Verbindingen |
Schakelen om het gebruik van variabelen in of uit te schakelen. Indien ingeschakeld:
|
| Verbindings-ID | Voer de unieke identificatie in van de verbinding die vernieuwd moet worden. |
| Vorige bronparameters gebruiken | Vink dit vakje aan om de bronparameters van de vorige run te gebruiken; dit heeft voorrang op alle andere bronparameters die u hebt opgegeven. Deze invoer wordt genegeerd door het eindpunt "Batch verbindingen vernieuwen". |
| Bronparameters |
Voer de parameters in om naar de bron te sturen bij een succesvolle verversing. (Deze parameters worden genegeerd als "Vorige bronparameters gebruiken" is ingeschakeld) |
| Vorige bestemmingsparameters gebruiken | Vink dit vakje aan om de bestemmingsparameters van de vorige run te gebruiken; dit heeft voorrang op alle andere bestemmingsparameters die u hebt opgegeven. Deze invoer wordt genegeerd door het eindpunt "Batch verbindingen vernieuwen". |
| Bestemmingsparameters |
Voer de parameters in die bij een succesvolle verversing naar de bestemming worden verzonden. (Deze parameters worden genegeerd als "Vorige bestemmingsparameters gebruiken" is ingeschakeld) |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status batchverversing | JSON |
Afsluitcodes
| 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 Nieuwe recordbewerking maken.
Een lijst met records ophalen
Gebruik de opdracht Een lijst met records ophalen om een lijst met records te retourneren die aan de verstrekte filters voldoen. Er is altijd minstens één filter nodig.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-getrecords/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Uitbreiden |
Retourneert verwante bronnen inline met de hoofdbron. Opties:
|
| Filter | De eigenschappen om de resultaten op te filteren. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status batchverversing | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Een lijst met types ophalen
Om een lijst met recordtypes en hun attributen terug te krijgen, gebruikt u de opdracht Een lijst met types ophalen. Deze opdracht laat u weten wat u kunt verwachten bij het ophalen van records.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-gettypes/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Uitbreiden |
Retourneert verwante bronnen inline met de hoofdbron. Opties:
|
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status batchverversing | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Een enkel record ophalen
Om een enkele record op te halen, gebruikt u de opdracht Een lijst met records ophalen. De unieke identificatie is meestal een UUID, maar dit kan variëren.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Uitbreiden |
Retourneert verwante bronnen inline met de hoofdbron. Opties:
|
| Record-ID | Voer de unieke identificatiecode van het record in. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status batchverversing | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Een enkel type ophalen
Om een enkele record op te halen, gebruikt u de opdracht Een lijst met records ophalen. De unieke identificatie is meestal een UUID, maar dit kan variëren.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Uitbreiden |
Retourneert verwante bronnen inline met de hoofdbron. Opties:
|
| Record-ID | Voer de unieke identificatiecode van het record in. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Status batchverversing | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Vraag uitvoeren
Om een Wdata query uit te voeren en de resultaten ervan op te halen, gebruikt u de opdracht Run query.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-runquery/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Vraag-ID | Voer de ID van de uit te voeren query in. |
| Parameters | Als de query parameters heeft gedefinieerd, voeg dan een map met hun namen en waarden toe. Opmerking: Voer de waarden van eventuele multi-select parameters in Multi-select params. |
| Asynchroon uitvoeren | Vink dit vakje aan om de query asynchroon uit te voeren, en niet te wachten tot de query klaar is om de opdracht te voltooien. |
| Multi-select params | Als de query meerdere selectieparameters heeft, voegt u de naam en waarden van elke parameter toe. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Zoekresultaat | JSON |
Opmerking: De uitvoer Query Result bevat een ID, die gebruikt kan worden om de resultaten te downloaden en te exporteren.
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Rapport uitvoeren
Om een opgeslagen rapport in de SOX en Interne Audit databaseaccount van uw organisatie uit te voeren en de resultaten als CSV-bestand terug te sturen, gebruikt u de opdracht Rapport uitvoeren.
Equivalente API-oproep: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Rapport ID | Voer de unieke identificatie in van het rapport dat het opgeslagen rapport bevat. |
| Inhoud bekijken | Schakel dit vakje in om een voorbeeld van de resultaten van het rapport in het logboek van de opdracht op te nemen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Rapporteer | Bestand |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Rand instellen
Deze opdracht is alleen beschikbaar via de Platform API. Om een rand in te stellen, gebruikt u het eindpunt Nieuwe recordbewerkingen maken.
Record-eigenschappen instellen
Deze opdracht is alleen beschikbaar via de Platform API. Gebruik het eindpunt Nieuwe recordbewerkingen maken om de recordeigenschappen in te stellen.
Bestand uit tabel verwijderen
Om een bestand uit een Wdatatabel te un-importeren en te verwijderen, gebruikt u de opdracht Un-import file From table.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer de unieke identificatie in van de tabel waaruit u het bestand wilt verwijderen. |
| Bestands-ID | Voer de unieke identificatie in van het bestand dat u uit de tabel wilt verwijderen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Bestanden importeren | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Draaiveldweergave bijwerken
Om de metagegevens van een Wdata-weergave bij te werken, gebruikt u de opdracht Update pivot view.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Eigenschappen
| Eigendom | Detail |
|---|---|
| id | Voer de ID in van de view die u wilt bijwerken. |
| Naam | Voer de nieuwe naam van de weergave in. |
| Vraag-ID | Voer de ID in van de query waarvan u de weergave wilt maken. |
| Zoekresultaat ID | Voer de ID in van het queryresultaat waarvan u de weergave wilt maken. |
| Extra metadata | Voer de door de gebruiker gedefinieerde metagegevens in om aan de weergave te koppelen, als een JSON-object (optioneel). |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Draaiveldweergave | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Vraagdefinitie bijwerken
Om de eigenschappen van een Wdata query bij te werken, gebruikt u de opdracht Querydefinitie bijwerken.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Vraag-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 query in. |
| Primair resultaat ID | Voer, indien gespecificeerd, de ID van het standaardresultaat in dat met de resultaten van de query moet worden gevuld. |
| Tekst zoekopdracht | Voer de querydefinitie in Presto SQL-syntax in, zoals u dat zou doen in de SQL Editor van de query. |
| Tijdelijk | Om de query slechts tijdelijk te genereren, zodat deze niet 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
| Uitgang | Type uitgang |
|---|---|
| Query | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Selectielijst bijwerken
Om de eigenschappen of items voor een lijst met waarden voor een multi-select queryparameter bij te werken, gebruikt u een opdracht Selectielijst bijwerken.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Eigenschappen
| Eigendom | Detail |
|---|---|
| id | Voer de ID van de bij te werken keuzelijst in. |
| Naam | Voer de nieuwe naam van de keuzelijst in. |
| Beschrijving | Voer de nieuwe beschrijving van de keuzelijst 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
| Uitgang | Type uitgang |
|---|---|
| Selectielijst bijwerken | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Bladmetagegevens bijwerken
Om de metagegevens van een blad in een spreadsheet bij te werken, gebruikt u de opdracht Bladmetagegevens bijwerken.
Equivalente API-oproep: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad waarin de metagegevens moeten worden bijgewerkt. |
| Blad-ID/naam | Voer de naam of unieke identificatie in van het blad waarin de metagegevens moeten worden bijgewerkt. |
| Naam | Voer de nieuwe naam van het blad in. |
| Bladindex | Voer de nieuwe index van het blad in de spreadsheet in. Standaard wordt het blad door de opdrachten bijgewerkt als het bovenste blad. |
| Ouderblad ID | Voer het ID in van het bovenliggende blad waaronder u het blad wilt maken. Laat leeg om toe te voegen aan de root-spreadsheet. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Metagegevens van spreadsheets bijwerken
Om de metadata van een spreadsheet bij te werken, gebruikt u de opdracht Metadata van spreadsheet bijwerken.
Equivalente API-oproep: https://developers.workiva.com/2022-01-01/updatesheet.html
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad waarin de metagegevens moeten worden bijgewerkt. |
| Naam | Voer de nieuwe naam van de spreadsheet in. |
Uitgangen
Geen
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Tabel bijwerken
Om de kolommen van een Wdatatabel bij te werken, gebruikt u de opdracht Tabel bijwerken.
Equivalente API-oproep: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Eigenschappen
| Eigendom | Detail |
|---|---|
| Tabel ID | Voer de unieke identificatie van de bij te werken tabel in. |
| 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 Data- of feit-of Lookup- of dimensie-tabel wilt bijwerken |
| Kolommen | Voeg de kolommen toe om de tabel mee bij te werken. Voer voor elke kolom de naam, het gegevenstype, de alias en de beschrijving in. Voor Modus, laat de standaardwaarde Nullable staan. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Tabel | JSON |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |
Schrijf bladgegevens
Om gegevens in een CSV-gegevensset naar een specifiek gebied van een vel te schrijven, gebruikt u een opdracht Bladgegevens schrijven.
Eigenschappen
| Eigendom | Detail |
|---|---|
| Spreadsheet-ID | Voer de unieke identificatie in van de spreadsheet met het blad waarnaar u gegevens wilt schrijven. |
| Blad-ID/naam | Voer de unieke identificatie in van het blad waarnaar u gegevens wilt schrijven. |
| Gegevensbestand | Voer het CSV-bestand in met de gegevens die u naar het blad wilt schrijven. Het bereik van de gegevens mag niet groter zijn dan de Regio. |
| Scheidingsteken | Voer het scheidingsteken in dat wordt gebruikt in Data File. |
| Regio | Voer een A1-weergave in van de cel of het celbereik in het blad waarnaar de gegevens moeten worden weggeschreven. Om het bereik in één of alle richtingen onbegrensd te maken, laat u de bijbehorende kolom of rij leeg. |
| Gebruik async |
Vink dit vakje aan om de gegevens asynchroon te laden, zoals bij een grote dataset. Opmerking: Als u async gebruikt, moet u uw eigen polling toevoegen om de status van de taak te bepalen. |
| Gebruik platform-API |
Als u de entered-in indeling van de Regio celwaarden wilt gebruiken, schakelt u dit selectievakje in. Hierdoor wordt de opdracht gedwongen om de update-waarden in een bereikeindpunt te gebruiken in plaats van de spreadsheet-API's schrijf gegevens naar een regio-eindpunt. Opmerking: Deze opdracht wordt altijd asynchroon uitgevoerd bij gebruik van de platform-API. U moet uw eigen peilingen toevoegen om de status van de taak te bepalen. |
Uitgangen
| Uitgang | Type uitgang |
|---|---|
| Rijen geschreven | Geheel getal |
| Cellen geschreven | Geheel getal |
Afsluitcodes
| Code | type | Detail |
|---|---|---|
| 0 | Succes | Succes |
| 1 | Fout | Fout |