|
Klassiska filtyper är inte längre tillgängliga för användning från och med januari 2021. Du kan överföra dina klassiska filer eller ladda ner en PDF. Läs mer

Workiva supportcenter

Kommandon för Workiva-anslutning

Kommandon för Workiva-anslutning

  • Senast uppdaterad

För att automatisera uppgifter inom Workiva-plattformen som en del av en kedja, t.ex. för att möjliggöra utbyte av data med andra datakällor, lägger du till ett steg som innehåller ett Workiva-anslutningskommando.

För att aktivera dessa kommandon måste en IT-administratör först konfigurera en Workiva-anslutning.

Data i klart ark

Om du vill rensa alla data i en ark använder du kommandot Clear sheet data.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som ska rensas.
Ark ID/namn Ange namnet eller den unika identifieraren för arket som ska rensas.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa arkivering

Om du vill ladda upp en CSV-fil (Comma-separated Values), JSON-fil (Javascript Object Notation) eller komprimerad ZIP-fil och lista dess poster använder du kommandot Create file. Du kan också ladda upp URL:en till filen, t.ex. en Amazon S3®-signerad URL till en fil i en S3-bucket.

  • Om det är en JSON-fil måste den ha en enda JSON-post per rad - en JSON-fil är en serie JSON-objekt som avgränsas av ett newline-tecken.
  • Om det är en ZIP-fil måste den innehålla en enda CSV- eller JSON-fil, vars namn används för att namnge den importerade filen. Om du laddar ner filen igen laddas källan ner.
  • Om det är en URL gör slutpunkten en begäran om att hämta en fil med en enkel oautentiserad GET -begäran.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-uploadfile/

Egenskaper

Egenskap Detalj
Tabell-ID Ange ID för den tabell där arkiveringen ska listas.
Fil Ange den fil som ska laddas upp. Ignoreras om Download URL anges.
Obs: Filen måste ha ett .CSV- eller .JSON-tillägg, eller vara en ZIP-fil som innehåller en fil med ett .CSV- eller .JSON-tillägg.
Namn Om Download URL anges, ange namnet på den fil som ska laddas upp; som standard är basnamnet Download URL.
Ladda ner URL Ange URL:en som pekar på filen som ska hämtas, t.ex. en Amazon S3-signerad URL. Valfritt om Arkivering anges.
Obs: Kommandot gör en enkel GET begäran mot URL:en, utan autentisering.

Utdata

Utdata Typ av utgång
Resultat JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa nya redigeringar av poster

För att skapa nya poster med de angivna egenskaperna använder du kommandot Skapa nya poster. Varje redigering kräver minst en operation och en targetId.

Begränsning: Upp till 1000 redigeringar kan behandlas per begäran.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-createedits/

Egenskaper

Egenskap Detalj
Drift

Välj den operation som ska utföras.

Alternativ:

  • Skapa post
  • Radera post
  • Skapa relation
  • Ta bort relation
  • Ställ Propertie
Etikett Ange en etikett som beskriver förhållandet mellan de två posterna. Används för att skapa eller ta bort en relation.
Egenskaper Ange de egenskaper som är relaterade till typen av post. Används för att skapa en post eller ställa in dess egenskaper.
Post ID Ange ID eller tillfälligt post-ID för källan. Används för att skapa eller ta bort en relation.
Mål-ID Ange målpostens ID. Om du skapar en post kan du använda antingen postens ID eller det tillfälliga postens ID
Tillfälligt ID för post Ange det tillfälliga ID som kommer att användas när du skapar en post Du kan använda detta ID inom samma begäran för att skapa relationer mellan skapade poster.
Typ Ange vilken typ av post som ska skapas.

Utdata

Utdata Typ av utgång
Pivot-vy JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa pivot-vy

Om du vill skapa en ny Wdata-vy med hjälp av dess fråga och frågeresultat använder du kommandot Create pivot view.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-createpivotview/

Egenskaper

Egenskap Detalj
Namn Ange ett unikt namn som hjälper till att identifiera vyn.
ID för förfrågan Ange ID för den fråga som vyn ska skapas från.
ID för förfrågningsresultat Ange ID för det frågeresultat som vyn ska skapas från.
Ytterligare metadata Ange de användardefinierade metadata som ska bifogas till vyn som ett JSON-objekt (valfritt).

Utdata

Utdata Typ av utgång
Pivot-vy JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa en fråga för förhandsgranskning

Om du vill skapa en tillfällig förhandsgranskning av en tabell som sedan kan köras använder du kommandot Create preview query.

Motsvarande API-anrop: EJ TILLÄMPLIGT

Egenskaper

Egenskap Detalj
Tabell-ID Ange ID för den tabell som ska efterfrågas.
Gräns Ange det maximala antalet resultat som ska returneras.
Fil Om så anges, ange namnet på den arkivering i tabellen som ska efterfrågas.

Utdata

Utdata Typ av utgång
Fråga JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa fråga

Om du vill skapa en ny Wdata-fråga använder du kommandot Create query.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-createquery/

Egenskaper

Egenskap Detalj
Namn Ange ett unikt namn som hjälper till att identifiera frågan.
Beskrivning Ange en beskrivning av frågan.
ID för primärt resultat Om det anges, ange ID för standardresultatet som ska fyllas i med frågeresultaten.
Fråga text Ange frågans definition som Presto SQL-syntax, som du skulle göra i frågans SQL Editor.
Tillfälligt Markera den här rutan om du vill generera frågan tillfälligt så att den inte inte visas på arbetsytan.
Parametrar Ange de parametrar som krävs för att köra frågan.

Utdata

Utdata Typ av utgång
Fråga JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa post

Detta kommando är endast tillgängligt via plattforms-API:et. För att skapa en ny post, använd Skapa ny post redigerar endpoint.

Skapa urvalslista

Om du vill skapa en lista med värden för en frågeparameter med flera urval använder du kommandot Create select list.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-createselectlist/

Egenskaper

Egenskap Detalj
Namn Ange ett unikt namn som hjälper till att identifiera urvalslistan.
Beskrivning För att ytterligare identifiera urvalslistan, ange en beskrivning av dess värden eller parameter.
Värdetyp Välj datatyp för listans värden, t.ex. sträng eller heltal.
Värden Ange listans värden. 

Utdata

Utdata Typ av utgång
Skapa metadata för urvalslista JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel

Fel

Skapa ark

Om du vill lägga till ett nytt ark i ett kalkylark använder du kommandot Create sheet.

Motsvarande API-anrop: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/

Egenskaper

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket som arket ska läggas till i.
Namn Ange ett unikt namn som hjälper till att identifiera arket.
Index för ark Ange index för det nya arket i kalkylarket.
Obs: Som standard lägger kommandot till arket som det översta arket.
ID för förälderns ark Ange ID för det överordnade arket som arket ska skapas under. Lämna tomt om du vill lägga till i kalkylarket för roten.

Utdata

Utdata Typ av utgång
Metadata för ark JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa kalkylark

Om du vill skapa en ny kalkylark använder du kommandot Create spreadsheet.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html

Fastigheter

Egenskap Detalj
Namn Ange ett unikt namn som hjälper till att identifiera kalkylarket.

Utdata

Utdata Typ av utgång
Metadata för ark JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skapa bord

Om du vill skapa en ny Wdata-tabell i arbetsytan använder du kommandot Create table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-createtable/

Egenskaper

Egenskap Detalj
Namn Ange ett unikt namn som hjälper till att identifiera tabellen.
Beskrivning Ange en beskrivning av den nya tabellen.
Typ Välj om du vill skapa en tabell Data (eller fact) eller Lookup (eller dimension).
Kolumner Lägg till de kolumner som ska ingå i tabellen:
  • Om du vill lägga till kolumner manuellt klickar du på Add för varje kolumn och anger namn, datatyp, alias och beskrivning. För Mode, behåll standardvärdet Nullable.
  • Om du vill lägga till kolumnernas detaljer som JavaScript Object Notation (JSON) aktiverar du Variable och anger JSON-objektet eller -variabeln.

Utdata

Utdata Typ av utgång
Tabell JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ta bort fil

Om du vill ta bort en arkivering från arbetsytan Wdata använder du kommandot Delete file.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-deletefile/

Egenskaper

Egenskap Detalj
Fil-ID Ange ID för den arkivering som ska raderas.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ta bort vy för pivot

Om du vill ta bort en Wdata-vy från arbetsytan använder du kommandot Delete pivot view.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/

Egenskaper

Egenskap Detalj
ID Ange ID för den vy som ska raderas.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ta bort förfrågan

Om du vill ta bort en Wdata-fråga från arbetsytan använder du kommandot Delete query.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-deletequery/

Egenskaper

Egenskap Detalj
ID för förfrågan Ange ID för den fråga som ska tas bort.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Radera post

Detta kommando är endast tillgängligt via plattforms-API:et. Om du vill radera en post använder du kommandot Create new record edits .

Ta bort ark

Om du vill ta bort ett ark och dess underordnade ark (rekursivt) från ett kalkylblad använder du kommandot Delete sheet .

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/deletelegacysheet.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som ska raderas.
Ark ID/namn Ange namnet eller den unika identifieraren för det ark som ska raderas.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ta bort kalkylark

Om du vill ta bort ett kalkylark från arbetsytan använder du kommandot Delete spreadsheet.

Motsvarande API-anrop: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/

Egenskaper

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för det kalkylark som ska raderas.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Radera tabell

Om du vill ta bort en Wdata-tabell från arbetsytan använder du kommandot Delete table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-deletetable/

Egenskaper

Egenskap Detalj
Tabell-ID Ange den unika identifieraren för den tabell som ska raderas

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ladda ner fil

Om du vill hämta ett dataset från arbetsytan Wdata använder du kommandot Download file.

Obs: Det här kommandot är inte kompatibelt med andra objekttyper som kalkylark, tabeller eller frågor.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/

Egenskaper

Egenskap Detalj
Fil-ID Ange ID för den fil som ska hämtas.

Utdata

Utdata Typ av utgång
Fil Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

<!--

Download Pivot View

Downloads the content from a pivot view

Inputs

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

Outputs

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

Exit Codes

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

Download pivot view

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

Properties

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

Outputs

Output Output Type
Pivot view content File

Exit codes

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

Ladda ner sökresultat

Om du vill hämta resultatet av en Wdata-fråga till en arkivering använder du kommandot Download query result.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/

Egenskaper

Egenskap Detalj
ID för förfrågningsresultat Ange ID för det sökresultat som ska hämtas.

Utdata

Utdata Typ av utgång
Resultat av förfrågan Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Redigera

Detta kommando är endast tillgängligt via plattforms-API:et. För att redigera en post, använd Skapa ny post redigerar slutpunkt.

Exportera fil till kalkylark

Om du vill exportera ett dataset från en Wdata-tabell till ett nytt eller befintligt kalkylark använder du kommandot Export file to spreadsheet.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/

Egenskaper

Egenskap Detalj
Fil-ID Ange ID för det dataset för tabellen som ska exporteras.
Kalkylarkets URL Ange URL:en till kalkylarket som du vill exportera till. Lämna tomt om du vill skapa ett nytt kalkylark.

Utdata

Utdata Typ av utgång
Information om ark Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Exportera sökresultat

Om du vill exportera ett Wdata-frågeresultat till ett nytt eller befintligt kalkylark använder du kommandot Export query result.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/

Egenskaper

Egenskap Detalj
ID för förfrågningsresultat Ange ID för det frågeresultat som ska exporteras.
Kalkylarkets URL

Ange URL:en till kalkylarket som du vill exportera till. Lämna tomt om du vill skapa ett nytt kalkylark.
Exportera som dataset

När den är markerad exporteras data som ett anslutet dataset och cellerna kan endast redigeras genom att uppdatera datasetet i kalkylarket.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta egenskaper för filer

Om du vill hämta egenskaperna för en arkivering i arbetsytan Wdata använder du kommandot Get file properties.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-getfile/

Egenskaper

Egenskap Detalj
Fil-ID Ange ID för den arkivering som du vill få egenskaper för.

Utdata

Utdata Typ av utgång
Egenskaper för arkivering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta vy för pivot

Om du vill hämta metadata för en Wdata-vy använder du kommandot Get pivot view.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-getpivotview/

Egenskaper

Egenskap Detalj
ID Ange ID för den pivot-vy som metadata ska hämtas från.

Utdata

Utdata Typ av utgång
Pivot-vy JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta metadata för frågan

Om du vill hämta metadata för en Wdata-fråga använder du kommandot Get query metadata.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-getquery/

Egenskaper

Egenskap Detalj
ID för förfrågan Ange ID för den fråga som metadata ska hämtas från.

Utdata

Utdata Typ av utgång
Fråga JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta post

Detta kommando är endast tillgängligt via plattforms-API:et. För att hämta en post, använd Hämta en enda post endpoint.

Hämta poster

Detta kommando är endast tillgängligt via plattforms-API:et. Om du vill hämta flera poster använder du slutpunkten Hämta en lista med poster.

Hämta rapporter

Om du vill hämta alla rapporter från organisationens SOX- och Internal Audit-databaskonto använder du kommandot Get reports.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-graphreportexport/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Rapporter Fil
Rapportera antal Heltal

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta utvald lista

Om du vill hämta en lista med värden för en frågeparameter med flera urval baserat på listans ID använder du kommandot Get select list.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-getselectlist/

Egenskaper

Egenskap Detalj
Välj ID för lista Ange den unika identifieraren för den urvalslista som ska hämtas.

Utdata

Utdata Typ av utgång
Hämta nyttolast för utvald lista JSON 

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta uppgifter om arket

Om du vill hämta alla data i en viss region på ett ark använder du kommandot Hämta arkdata.

Motsvarande API-anrop: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/

Egenskaper

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som du vill hämta data från.
Ark ID/namn Ange namnet eller den unika identifieraren för arket som du vill hämta data från.
Region Ange A1-stil för en cell eller ett intervall, t.ex. [Startkolumn][Startrad]:[Stoppkolumn][Stopprad]. Om du vill att intervallet ska vara obegränsat i någon eller alla riktningar utelämnar du motsvarande kolumn eller rad.
Värdebaserad stil Välj om du vill returnera cellens råvärde eller beräknade värde. Om en cells värde t.ex. är =1 :1, väljer du Raw för =1 1 eller Calculated för det beräknade värdet 2.
Revidering Ange den version av arket som data ska hämtas från. För aktuell version, ange -1.
Använd plattforms-API När denna ruta är markerad returnerar kommandot arkdata med standarddecimalnotation. Om den är tom returneras arkdata med vetenskaplig notation. Detta tvingar kommandot att använda Hämta data från ett ark endpoint i stället för kalkylbladets API Returnera data från en region endpoint.

Utdata

Utdata Typ av utgång
Antal rader Heltal
Data Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta metadata för ark

Om du vill hämta metadata för ett ark i ett kalkylark använder du kommandot Get sheet metadata.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/getsheetdata.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med det ark som metadata ska hämtas från.
Ark ID/namn Ange namnet eller den unika identifieraren för det ark som metadata ska hämtas från.

Utdata

Utdata Typ av utgång
Metadata för ark JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta metadata för kalkylark

Om du vill hämta metadata för ett kalkylark använder du kommandot Get spreadsheet metadata.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket som du vill hämta metadata från.

Utdata

Utdata Typ av utgång
Metadata för kalkylark JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta metadata för tabellen

Om du vill hämta metadata för en Wdata-tabell använder du kommandot Get table metadata.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-gettable/

Egenskaper

Egenskap Detalj
Tabell-ID Ange den unika identifieraren för den tabell som metadata ska hämtas från.

Utdata

Utdata Typ av utgång
Tabell JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta typ

Detta kommando är endast tillgängligt via plattforms-API:et. För att hämta en post, använd Hämta en enda post endpoint.

Hämta typer

Detta kommando är endast tillgängligt via plattforms-API:et. Om du vill hämta flera typer av poster använder du ändpunkten Hämta en lista över typer.
<!-- display page content -->

Hälsokontroll

Om du vill kontrollera hur Wdata API fungerar använder du kommandot Health check.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-healthcheck/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Svar JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Importera fil till tabell

Om du vill importera en arkivering till en Wdata-tabell använder du kommandot Import file into table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-importfile/

Egenskaper

Egenskap Detalj
Tabell-ID Ange ID för den tabell som filen ska importeras till.
Fil-ID Ange ID för den arkivering som ska importeras till tabellen.
Mappningar av kolumner Mappa varje kolumn i arkiveringen till tabellens kolumner.
Kör asynkront Markera den här rutan om du vill att kommandot ska köras asynkront och inte vänta tills importen är klar innan du fortsätter med kedjan.
Taggar För att inkludera metadata som din organisation spårar om data, lägg till taggar och välj deras namn och värden.

Utdata

Utdata Typ av utgång
Import av filer JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Importera kalkylark till tabell

Om du vill importera ett kalkylark till en tabell och returnera ett filmetaresultat använder du kommandot Import spreadsheet into table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/

Egenskaper

Egenskap Detalj
Tabell-ID Ange den unika identifieraren för den tabell som filen ska importeras till.
Fil-ID Ange den unika identifieraren för den arkivering som kalkylarket ska importeras till (valfritt).
Filnamn Ange det unika namn som filen ska ges vid import till tabellen.
Kalkylarkets URL Ange den fullständiga URL:en till kalkylarket som du vill importera data från.
Kör asynkront Markera den här rutan om du vill att kommandot ska köras asynkront och inte vänta tills importen är klar innan du fortsätter med kedjan.
Taggar För att inkludera metadata som din organisation spårar om data, lägg till taggar och välj deras namn och värden.

Utdata

Utdata Typ av utgång
Import av filer JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista anslutningar

Om du vill lista data mellan funktioner i Workiva-plattformen använder du kommandot List connections.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-listconnections/

Fastigheter
Egenskap Detalj
Källa Typ Använd rullgardinsmenyn för att välja vilken typ av fil eller objekt som data ska hämtas från.
Typ av mål Använd rullgardinsmenyn för att välja vilken typ av fil eller objekt som data ska skickas till.
Källa ID Ange den unika identifieraren för den arkivering eller det objekt som data ska hämtas från.
Mål ID Ange den unika identifieraren för den arkivering eller det objekt som data ska skickas till.
Obs: Din begäran måste innehålla antingen Source Type + Source ID eller Destination Type + Destination ID; begäran kommer att misslyckas om ett av dessa par inte finns.

Utdata

Utdata Typ av utgång
Kopplingar JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista filfel

Om du vill lista de fel som är kopplade till en fil, t.ex. på grund av en import, använder du kommandot List file errors.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-geterrors/

Egenskaper

Egenskap Detalj
Fil-ID Ange ID för den arkivering som du vill få felmeddelanden för.

Utdata

Utdata Typ av utgång
Fel lista JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista filer

Om du vill hämta en lista över filer i en Wdata-tabell och deras metadata använder du kommandot List files.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-getfiles/

Egenskaper

Egenskap Detalj
Tabell-ID Ange ID för den tabell som du vill hämta arkivering från.

Utdata

Utdata Typ av utgång
Lista över arkivering Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista vyer med pivot

Om du vill lista Wdata-vyerna i arbetsytan och hämta deras metadata använder du kommandot List pivot views.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Pivot-vyer JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista frågor

Om du vill lista Wdata-frågorna i arbetsytan och hämta deras metadata använder du kommandot List queries.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-listqueries/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Frågor JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista sökresultat

Om du vill lista de tillgängliga resultaten för en Wdata-fråga använder du kommandot List query results.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/

Egenskaper

Egenskap Detalj
ID för förfrågan Ange ID för den fråga som du vill få resultat från.

Utdata

Utdata Typ av utgång
Sökresultat JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista Välj listor

Om du vill lista alla listor med värden för frågeparametrar med flera val i arbetsytan och hämta deras metadata använder du kommandot List select lists.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-listselectlists/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Lista Välj listor JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista ark

Om du vill lista alla ark i en kalkylark och hämta deras metadata använder du kommandot List sheets.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/getlegacysheets.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket som du vill lista arken i.

Utdata

Utdata Typ av utgång
Ark JSON
Antal ark Heltal

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista tabeller

Om du vill lista alla Wdata-tabeller i arbetsytan och hämta deras metadata använder du kommandot List tables.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-gettables/

Egenskaper

Ingen

Utdata

Utdata Typ av utgång
Tabell lista JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Lista användare

Om du vill hämta en lista med information om en organisations användare använder du kommandot List users. Din tilldelade integrationsanvändare måste ha rollen Org Admin för att kunna utföra detta kommando.

I likhet med en organisationsadministratörs export av "People View" sorteras detaljerna efter visningsnamn och inkluderar användarnas:

  • Användarnamn
  • E-postadresser
  • SAML-ID:n
  • Senaste inloggningar
  • Medlemskap i arbetsytor
  • Licenser och roller

Motsvarande API-anrop: https://developers.workiva.com/admin-v1/admin-getorgreportusers/

Egenskaper

Egenskap Detalj
Organisations-ID Ange den unika identifieraren för den organisation som du vill lista användare för.

Utdata

Utdata Typ av utgång
Användarrapport Fil
Antal poster Heltal

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skriva över data från ark

Om du vill rensa alla celler i ett ark och ersätta dem med de värden som finns i arkiveringen använder du kommandot Overwrite sheet data.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/updatesheet.html#

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket för att skriva över arkdata i.
Ark ID/namn Ange namnet eller den unika identifieraren för det ark där data ska skrivas över.
Datafil Ange den CSV-fil som innehåller de data som arket ska fyllas i med.
Avgränsare Ange den avgränsare som används i Data File.
Använd plattformens API Markera den här rutan om du vill använda formatet Skrivs in i för kalkylarkets cellvärden.

Utdata

Utdata Typ av utgång
Rad skriven Heltal
Celler skrivna Heltal

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Publicera kalkylark

Om du vill publicera länkarna i ett kalkylark använder du kommandot Publish spreadsheet.

Motsvarande API-anrop: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/

Egenskaper

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket som ska publiceras.
Publicera alla -länkar Välj vilken av kalkylarkets länkar som ska publiceras:
  • Markera den här rutan om du vill publicera alla länkar.
  • Om du bara vill publicera länkar som du själv äger, avmarkera den här rutan.

Utdata

Utdata Typ av utgång
Meddelande Sträng

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera koppling

Om du vill uppdatera en specifik anslutning baserat på dess ID använder du kommandot Refresh connection.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/

Egenskaper

Egenskap Detalj
Kopplings-ID Ange den unika identifieraren för den anslutning som ska uppdateras.
Använd tidigare källparametrar Markera den här rutan om du vill använda källparametrarna från den föregående körningen

Denna inmatning ignoreras av slutpunkten "Refresh batch of connections".
Parametrar för källan*

Ange de parametrar som ska skickas till källan vid en lyckad uppdatering.

(Dessa parametrar ignoreras om "Använd tidigare källparametrar" är aktiverat).
Använd parametrar för tidigare mål Markera den här rutan om du vill använda parametrarna för målet i den föregående körningen

Denna inmatning ignoreras av slutpunkten "Refresh batch of connections".
Parametrar för mål*

Ange de parametrar som ska skickas till målet vid en lyckad uppdatering.

(Dessa parametrar ignoreras om "Använd parametrar för tidigare mål" är aktiverat).
Obs: Multi-Select Parameters har för närvarande inget support.

Utdata

Utdata Typ av utgång
Uppdatera status JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera antalet anslutningar

Om du vill uppdatera flera anslutningar på en gång använder du kommandot Refresh batch of connections.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/

Egenskaper

Egenskap Detalj
Kopplingar

Växla för att aktivera eller inaktivera användningen av variabler.

När den är aktiverad:

  • Tillgängliga variabler kan väljas från menyn till vänster.
  • Det går inte att lägga till nya anslutningar.
Kopplings-ID Ange den unika identifieraren för den anslutning som ska uppdateras.
Använd tidigare källparametrar Markera den här rutan om du vill använda källparametrarna från den föregående körningen

Denna inmatning ignoreras av slutpunkten "Refresh batch of connections".
Källparametrar

Ange de parametrar som ska skickas till källan vid en lyckad uppdatering.

(Dessa parametrar ignoreras om "Använd tidigare källparametrar" är aktiverat).
Använd parametrar för tidigare mål Markera den här rutan om du vill använda parametrarna för målet i den föregående körningen

Denna inmatning ignoreras av slutpunkten "Refresh batch of connections".
Parametrar för mål

Ange de parametrar som ska skickas till målet vid en lyckad uppdatering.

(Dessa parametrar ignoreras om "Använd parametrar för tidigare mål" är aktiverat).

Utdata

Utdata Typ av utgång
Status för batchuppdatering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ta bort nod

Detta kommando är endast tillgängligt via plattforms-API:et. För att ta bort en nod, använd Skapa ny post edits slutpunkt.

Hämta en lista med poster

Om du vill returnera en lista med poster som matchar de angivna filtren använder du kommandot Hämta en lista med poster. Det krävs alltid minst ett filter.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-getrecords/

Egenskaper

Egenskap Detalj
Expandera

Returnerar relaterade resurser i linje med huvudresursen.

Alternativ:

  • Ingen (standard)
  • Relationer
Filter De egenskaper som resultaten ska filtreras efter.

Utdata

Utdata Typ av utgång
Status för batchuppdatering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta en lista med typer

Om du vill få fram en lista över typer av poster och deras attribut använder du kommandot Hämta en lista över typer. Med det här kommandot vet du vad du kan förvänta dig när du hämtar poster.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-gettypes/

Egenskaper

Egenskap Detalj
Expandera

Returnerar relaterade resurser i linje med huvudresursen.

Alternativ:

  • Ingen (standard)
  • Relationer

Utdata

Utdata Typ av utgång
Status för batchuppdatering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta en enda post

Om du vill hämta en enstaka post använder du kommandot Hämta en lista med poster. Den unika identifieraren är vanligtvis en UUID, men detta kan variera.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-getrecordbyid/

Egenskaper

Egenskap Detalj
Expandera

Returnerar relaterade resurser i linje med huvudresursen.

Alternativ:

  • Ingen (standard)
  • Relationer
Post ID Ange postens unika identifierare.

Utdata

Utdata Typ av utgång
Status för batchuppdatering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Hämta en enda typ

Om du vill hämta en enstaka post använder du kommandot Hämta en lista med poster. Den unika identifieraren är vanligtvis en UUID, men detta kan variera.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-gettypebyid/

Egenskaper

Egenskap Detalj
Expandera

Returnerar relaterade resurser i linje med huvudresursen.

Alternativ:

  • Ingen (standard)
  • Relationer
Post ID Ange postens unika identifierare.

Utdata

Utdata Typ av utgång
Status för batchuppdatering JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Kör fråga

Om du vill köra en Wdata-fråga och hämta dess resultat använder du kommandot Run query.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-runquery/

Egenskaper

Egenskap Detalj
ID för förfrågan Ange ID för den fråga som ska köras.
Parametrar Om frågan har definierade parametrar lägger du till en karta över deras namn och värden.
Observera: Ange värdena för eventuella parametrar för flerval i Parametrar för flerval.
Kör asynkront Markera den här rutan om du vill köra frågan asynkront och inte vänta tills frågan är klar för att slutföra kommandot.
Välj flera parametrar Om frågan har flera parametrar för urval definierade, lägg till namn och värden för varje parameter.

Utdata

Utdata Typ av utgång
Resultat av förfrågan JSON
Obs: Utdata från Query Result innehåller ett ID som kan användas för att hämta och exportera resultaten.

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Kör rapport

Om du vill köra en sparad rapport i organisationens SOX- och Internal Audit-databas-konto och returnera resultaten som en CSV-fil använder du kommandot Kör rapport.

Motsvarande API-anrop: https://developers.workiva.com/platform-v1/platform-getreportascsv/

Egenskaper

Egenskap Detalj
Rapport-ID Ange den unika identifieraren för den rapport som innehåller den sparade rapporten.
Förhandsgranskning av innehåll Markera den här rutan för att inkludera en förhandsgranskning av rapportens resultat i kommandots logg.

Utdata

Utdata Typ av utgång
Rapport Fil

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Ställ in nod

Detta kommando är endast tillgängligt via plattforms-API:et. För att sätta en nod, använd Skapa ny post edits slutpunkt.

Ange egenskaper för posten

Detta kommando är endast tillgängligt via plattforms-API:et. För att ställa in egenskaper för posten använder du Skapa ny post redigerar endpoint.

Återimportera arkivering från tabell

Om du vill avimportera och ta bort en arkivering från en Wdata-tabell använder du kommandot Un-import file From table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-unimportfile/

Egenskaper

Egenskap Detalj
Tabell-ID Ange den unika identifieraren för den tabell som filen ska tas bort från.
Fil-ID Ange den unika identifieraren för den arkivering som ska tas bort från tabellen.

Utdata

Utdata Typ av utgång
Import av filer JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera vyn för pivot

Om du vill uppdatera metadata för en Wdata-vy använder du kommandot Update pivot view.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/

Egenskaper

Egenskap Detalj
ID Ange ID för den vy som ska uppdateras.
Namn Ange det nya namnet på vyn.
ID för förfrågan Ange ID för den fråga som vyn ska skapas från.
ID för förfrågningsresultat Ange ID för det frågeresultat som vyn ska skapas från.
Ytterligare metadata Ange de användardefinierade metadata som ska bifogas till vyn, som ett JSON-objekt (valfritt).

Utdata

Utdata Typ av utgång
Pivot-vy JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera frågans definition

Om du vill uppdatera egenskaperna för en Wdata-fråga använder du kommandot Update query definition.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-updatequery/

Egenskaper

Egenskap Detalj
ID för förfrågan Ange ID för den fråga som ska uppdateras.
Namn Ange det nya namnet på frågan.
Beskrivning Ange den nya beskrivningen av frågan.
ID för primärt resultat Om det anges, ange ID för standardresultatet som ska fyllas i med frågeresultaten.
Fråga text Ange frågedefinitionen som Presto SQL-syntax, som du skulle i frågans SQL Editor.
Tillfälligt Markera den här rutan om du vill generera frågan tillfälligt så att den inte inte visas i arbetsytan.
Parametrar Ange de parametrar som krävs för att köra frågan.

Utdata

Utdata Typ av utgång
Fråga JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera listan över utvalda

Om du vill uppdatera egenskaperna eller objekten för en lista med värden för en frågeparameter med flera val använder du kommandot Update select list.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/

Egenskaper

Egenskap Detalj
ID Ange ID för den urvalslista som ska uppdateras.
Namn Ange det nya namnet på urvalslistan.
Beskrivning Ange den nya beskrivningen av den valda listan.
Värdetyp Välj datatyp för listans värden, t.ex. sträng eller heltal.
Värden Ange listans värden, inklusive eventuella uppdateringar.

Utdata

Utdata Typ av utgång
Uppdatera listan över utvalda JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera metadata för ark

Om du vill uppdatera metadata för ett ark i ett kalkylark använder du kommandot Uppdatera metadata för ark.

Motsvarande API-anrop: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/

Egenskaper

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som metadata ska uppdateras i.
Ark ID/namn Ange namnet eller den unika identifieraren för det ark där metadata ska uppdateras.
Namn Ange det nya namnet på arket.
Index för ark Ange det nya indexet för arket i kalkylarket. Som standard uppdaterar kommandona arket som det översta arket.
ID för förälderns ark Ange ID för det överordnade arket som arket ska skapas under. Lämna tomt om du vill lägga till i kalkylarket för roten.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera metadata för kalkylark

Om du vill uppdatera metadata för en kalkylark använder du kommandot Uppdatera metadata för kalkylark.

Motsvarande API-anrop: https://developers.workiva.com/2022-01-01/updatesheet.html

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som metadata ska uppdateras i.
Namn Ange det nya namnet på kalkylarket.

Utdata

Ingen

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Uppdatera tabellen

Om du vill uppdatera kolumnerna i en Wdata-tabell använder du kommandot Update table.

Motsvarande API-anrop: https://developers.workiva.com/wdata-v1/wdata-updatetable/

Egenskaper

Egenskap Detalj
Tabell-ID Ange den unika identifieraren för den tabell som ska uppdateras.
Namn Ange namnet på den tabell som ska uppdateras.
Beskrivning Ange en beskrivning av den tabell som ska uppdateras.
Typ Välj om du vill uppdatera en Data-eller fact-eller Lookup-eller dimension-tabell
Kolumner Lägg till de kolumner som du vill uppdatera tabellen med. För varje kolumn anges namn, datatyp, alias och beskrivning. För Mode, behåll standardvärdet Nullable.

Utdata

Utdata Typ av utgång
Tabell JSON

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel

Skriv data i ark

Om du vill skriva data i en CSV-datauppsättning till en specifik region på ett ark använder du kommandot Write sheet data.

Fastigheter

Egenskap Detalj
Kalkylark-ID Ange den unika identifieraren för kalkylarket med arket som data ska skrivas till.
Ark ID/namn Ange den unika identifieraren för det ark som data ska skrivas till.
Datafil Ange CSV-filen med de data som ska skrivas till arket. Dataområdet får inte överstiga Region.
Avgränsare Ange den avgränsare som används i Data File. 
Region Ange en A1-representation av cellen eller cellintervallet i arket som data ska skrivas till. Om du vill att intervallet ska vara obegränsat i någon eller alla riktningar lämnar du motsvarande kolumn eller rad tom.
Använd asynkron

Markera den här rutan om du vill ladda data asynkront, t.ex. för ett stort dataset.

Obs: När du använder async måste du lägga till en egen polling för att fastställa jobbets status.
Använd plattformens API

Markera den här rutan om du vill använda det elektroniskantered-in -formatet för Region cellvärden.

Detta tvingar kommandot att använda uppdatera värden i en range endpoint i stället för kalkylark API:s skriv data till en region endpoint. 

Obs: Detta kommando kommer alltid att köras asynkront när du använder plattforms-API:et. Du måste lägga till din egen polling för att avgöra statusen för jobbet.

Utdata

Utdata Typ av utgång
Rader skrivna Heltal
Celler skrivna Heltal

Utgångskoder

Kod Typ Detalj
0 Lyckades Lyckades
1 Fel Fel
Var denna artikel till hjälp?
6 av 9 tyckte detta var till hjälp
För att automatisera uppgifter inom Workiva-plattformen som en del av en kedja, t.ex. för att möjliggöra utbyte av...