For å automatisere oppgaver i Workiva-plattformen som en del av en kjede, for eksempel for å muliggjøre utveksling av data med andre datakilder, legger du til et trinn som inkluderer en Workiva-tilkoblingskommando.
For å aktivere disse kommandoene må en IT-administrator først sette opp en Workiva-kontakt.
Klare arkdata
Hvis du vil slette alle data i et ark, bruker du kommandoen Clear sheet data.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket med arket som skal tømmes. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren til arket som skal tømmes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett fil
Hvis du vil laste opp en CSV-fil (kommaseparerte verdier), JSON-fil (Javascript Object Notation) eller komprimert ZIP-fil og liste opp postene i den, bruker du kommandoen Create file. Du kan også laste opp URL-en til filen, for eksempel en Amazon S3®-signert URL til en fil i en S3-bøtte.
- Hvis det er en JSON-fil, må den ha én JSON-post per linje - en JSON-fil er en serie JSON-objekter som er avgrenset av et newline-tegn.
- Hvis det er en ZIP-fil, må den inneholde en enkelt CSV- eller JSON-fil, hvis navn brukes til å navngi den importerte filen. Hvis du laster ned filen på nytt, lastes kilden ned.
- Hvis det er en URL, sender endepunktet en forespørsel om å hente en fil ved hjelp av en enkel, uautorisert
GET-forespørsel.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen som filene skal listes opp i. |
| Fil | Skriv inn filen som skal lastes opp. Ignoreres hvis Download URL er angitt. Merk: Filen må ha filtypen .CSV eller .JSON, eller være en ZIP-fil som inneholder en fil med filtypen .CSV eller .JSON. |
| Navn | Hvis Download URL er angitt, skriver du inn navnet på filen som skal lastes opp; som standard er basisnavnet Download URL. |
| Last ned URL | Skriv inn URL-adressen som peker til filen som skal lastes ned, for eksempel en Amazon S3-signert URL. Valgfritt hvis File er angitt. Merk: Kommandoen sender en enkel |
Utganger
| Utdata | Utgangstype |
|---|---|
| Resultater | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett nye postredigeringer
For å opprette nye postredigeringer med de angitte egenskapene bruker du kommandoen Create new record edits. Hver redigering krever minst en operasjon og en targetId.
Begrensning: Opptil 1000 redigeringer kan behandles per forespørsel.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-createedits/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Drift |
Velg operasjonen som skal utføres. Alternativer:
|
| Etikett | Skriv inn en etikett som beskriver forholdet mellom de to postene. Brukes til å opprette eller slette en relasjon. |
| Egenskaper | Angi egenskapene som er knyttet til posttypen. Brukes til å opprette en post eller angi dens egenskaper. |
| Record ID | Skriv inn ID-en eller den midlertidige post-ID-en til kilden. Brukes til å opprette eller slette en relasjon. |
| Mål-ID | Skriv inn ID-en til målposten. Hvis du oppretter en post, kan du bruke enten post-ID-en eller den midlertidige post-ID-en; hvis du sletter en post, må du bruke den faktiske post-ID-en. |
| Midlertidig post-ID | Angi den midlertidige ID-en som skal brukes når du oppretter en post; denne midlertidige ID-en erstattes ved behandling. Du kan bruke denne ID-en i samme forespørsel for å opprette relasjoner mellom opprettede poster. |
| Type | Angi hvilken type post som skal opprettes. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivot-visning | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett pivotvisning
For å opprette en ny Wdata-visning med utgangspunkt i spørringen og spørringsresultatet, bruker du kommandoen Create pivot view.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere visningen. |
| Forespørsels-ID | Skriv inn ID-en til spørringen som visningen skal opprettes fra. |
| ID for søkeresultat | Skriv inn ID-en til spørringsresultatet som visningen skal opprettes fra. |
| Ytterligere metadata | Skriv inn de brukerdefinerte metadataene som skal knyttes til visningen som et JSON-objekt (valgfritt). |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivot-visning | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett forhåndsvisningsspørring
Hvis du vil opprette en midlertidig forhåndsvisningsspørring på en tabell som deretter kan kjøres, bruker du kommandoen Create preview query.
Tilsvarende API-kall: N/A
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen som skal spørres etter. |
| Grense | Angi det maksimale antallet resultater som skal returneres. |
| Fil | Hvis det er angitt, skriver du inn navnet på filen i tabellen som skal spørres etter. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett spørring
For å opprette en ny Wdata-spørring bruker du kommandoen Create query.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createquery/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere spørringen. |
| Beskrivelse | Skriv inn en beskrivelse av spørringen. |
| Primær resultat-ID | Hvis angitt, angir du ID-en til standardresultatet som skal fylles ut med søkeresultatene. |
| Spørretekst | Skriv inn spørringsdefinisjonen som Presto SQL-syntaks, som du ville gjort i spørringens SQL Editor. |
| Midlertidig | Hvis du vil generere spørringen midlertidig, slik at den ikke ikke vises i arbeidsområdet ditt, merker du av i denne boksen. |
| Parametere | Angi parameterne som kreves for å kjøre spørringen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett post
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å opprette en ny post bruker du endepunktet Create new record edits.
Opprett utvalgt liste
Hvis du vil opprette en liste med verdier for en spørringsparameter med flere valg, bruker du kommandoen Create select list.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere valglisten. |
| Beskrivelse | For å identifisere valglisten ytterligere kan du legge inn en beskrivelse av verdiene eller parameteren. |
| Verditype | Velg datatypen for listens verdier, for eksempel streng eller heltall. |
| Verdier | Skriv inn listens verdier. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Opprett metadata for utvalgt liste | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil |
Feil |
Opprett ark
Hvis du vil legge til et nytt ark i et regneark, bruker du kommandoen Create sheet.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som arket skal legges til i. |
| Navn | Skriv inn et unikt navn for å identifisere arket. |
| Indeks for ark | Skriv inn indeksen for det nye arket i regnearket. Merk: Som standard legger kommandoen til arket som det øverste arket. |
| Foreldreark-ID | Skriv inn ID-en til det overordnede arket som arket skal opprettes under. Hvis du vil legge til i rotregnearket, lar du feltet stå tomt. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Metadata for ark | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett regneark
Du oppretter et nytt regneark ved å bruke kommandoen Create spreadsheet.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere regnearket. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Metadata for ark | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett tabell
For å opprette en ny Wdata-tabell i arbeidsområdet ditt bruker du kommandoen Create table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createtable/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere tabellen. |
| Beskrivelse | Skriv inn en beskrivelse av den nye tabellen. |
| Type | Velg om du vil opprette en Data-tabell (eller fact) eller en Lookup-tabell (eller dimension). |
| Kolonner | Legg til kolonnene som skal inkluderes i tabellen:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett fil
Hvis du vil slette en fil fra Wdata-arbeidsområdet, bruker du kommandoen Delete file.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Fil-ID | Skriv inn ID-en til filen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett pivotvisning
Hvis du vil slette en Wdata-visning fra arbeidsområdet ditt, bruker du kommandoen Delete pivot view.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID | Skriv inn ID-en til visningen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett spørring
Hvis du vil slette en Wdata-spørring fra arbeidsområdet ditt, bruker du kommandoen Delete query.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forespørsels-ID | Skriv inn ID-en til spørringen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett post
Slett ark
Hvis du vil slette et ark og dets underordnede ark (rekursivt) fra et regneark, bruker du kommandoen Delete sheet.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket med arket som skal slettes. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren for arket som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett regneark
Hvis du vil slette et regneark fra arbeidsområdet, bruker du kommandoen Delete spreadsheet.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett tabell
Hvis du vil slette en Wdata-tabell fra arbeidsområdet ditt, bruker du kommandoen Delete table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen som skal slettes |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Last ned fil
For å laste ned et datasett fra Wdata-arbeidsområdet bruker du kommandoen Download file.
Merk: Denne kommandoen er ikke kompatibel med andre objekttyper, for eksempel regneark, tabeller eller spørringer.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Fil-ID | Skriv inn ID-en til filen som skal lastes ned. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Fil | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
<!--
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 |
Last ned søkeresultat
Hvis du vil laste ned resultatene av en Wdata-spørring til en fil, bruker du kommandoen Download query result.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID for søkeresultat | Skriv inn ID-en til søkeresultatet som skal lastes ned. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Resultat av spørringen | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Rediger
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å redigere en post bruker du endepunktet Create new record edits.
Eksporter fil til regneark
Hvis du vil eksportere et datasett fra en Wdata-tabell til et nytt eller eksisterende regneark, bruker du kommandoen Export file to spreadsheet.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Fil-ID | Skriv inn ID-en til tabelldatasettet som skal eksporteres. |
| URL til regneark | Skriv inn URL-adressen til regnearket du vil eksportere til. Hvis du vil opprette et nytt regneark, lar du feltet stå tomt. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Ark info | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Eksporter søkeresultat
Hvis du vil eksportere et Wdata-spørringsresultat til et nytt eller eksisterende regneark, bruker du kommandoen Export query result.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID for søkeresultat | Skriv inn ID-en til spørringsresultatet som skal eksporteres. |
| URL til regneark |
Skriv inn URL-adressen til regnearket du vil eksportere til. Hvis du vil opprette et nytt regneark, lar du feltet stå tomt. |
| Eksporter som datasett |
Når dette alternativet er avkrysset, eksporteres dataene som et sammenhengende datasett, og cellene kan bare redigeres ved å oppdatere datasettet i regnearket. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent filegenskaper
Hvis du vil hente egenskapene til en fil i Wdata-arbeidsområdet, bruker du kommandoen Get file properties.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getfile/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Fil-ID | Skriv inn ID-en til filen du vil hente egenskaper for. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filegenskaper | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Få pivot-visning
For å hente metadataene til en Wdata-visning bruker du kommandoen Get pivot view.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID | Skriv inn ID-en til pivotvisningen du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivot-visning | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent metadata for spørringen
For å hente metadataene til en Wdata-spørring bruker du kommandoen Get query metadata.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getquery/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forespørsels-ID | Skriv inn ID-en til spørringen du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Få rekord
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å hente en oppføring bruker du endepunktet Retrieve a single record.
Hent poster
Denne kommandoen er bare tilgjengelig via plattform-API-et. Hvis du vil hente flere poster, bruker du endepunktet Hent en liste over poster.
Få rapporter
For å hente alle rapporter fra organisasjonens SOX- og internrevisjonsdatabasekonto bruker du kommandoen Get reports.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Rapporter | Fil |
| Rapporter antall | Heltall |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent utvalgt liste
Hvis du vil hente en liste med verdier for en spørringsparameter med flere valg basert på listens ID, bruker du kommandoen Get select list.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Velg liste-ID | Skriv inn den unike identifikatoren for valglisten som skal hentes. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Hent nyttelast for utvalgt liste | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent arkdata
Hvis du vil hente alle data i et spesifisert område av et ark, bruker du kommandoen Hent arkdata.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren til regnearket med arket du vil hente data fra. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren til arket du vil hente data fra. |
| Region | Skriv inn A1-stilrepresentasjonen av en celle eller et område, for eksempel [Start Column][Start Row]:[Stop Column][Stop Row]. Hvis du vil at området skal være ubegrenset i en eller alle retninger, utelater du den tilsvarende kolonnen eller raden. |
| Verdistil | Velg om du vil returnere den rå eller beregnede celleverdien. Hvis en celle for eksempel har verdien =1+:1, velger du Raw for =1+1, eller Calculated for den beregnede verdien 2. |
| Revisjon | Angi hvilken versjon av arket du vil hente data fra. For gjeldende versjon, skriv inn -1. |
| Bruk plattform-API | Når denne boksen er merket av, returnerer denne kommandoen arkdataene med standard desimalnotasjon. Hvis den er tom, returneres arkdataene med vitenskapelig notasjon. Dette vil tvinge kommandoen til å brukeHent data fra et ark-endepunkti stedet for regneark-APIetsReturner data fra et regionendepunkt. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Antall rader | Heltall |
| Data | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent metadata om arket
Hvis du vil hente metadataene for et ark i et regneark, bruker du kommandoen Get sheet metadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getsheetdata.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren til regnearket med arket du vil hente metadata fra. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren til arket du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Metadata for ark | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent metadata om regnearket
Hvis du vil hente metadataene for et regneark, bruker du kommandoen Get spreadsheet metadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Metadata for regneark | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent tabellmetadata
For å hente metadataene til en Wdata-tabell bruker du kommandoen Get table metadata.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-gettable/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Angi den unike identifikatoren for tabellen du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent type
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å hente en oppføring bruker du endepunktet Retrieve a single record.
Få typer
Denne kommandoen er bare tilgjengelig via plattform-API-et. Hvis du vil hente flere posttyper, bruker du endepunktet Hent en liste over typer.
<!-- display page content -->
Helsesjekk
For å sjekke tilstanden til Wdata API kan du bruke kommandoen Health check.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Svar | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Importer fil til tabell
For å importere en fil til en Wdata-tabell bruker du kommandoen Import file into table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-importfile/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen som filen skal importeres til. |
| Fil-ID | Skriv inn ID-en til filen som skal importeres til tabellen. |
| Tilordning av kolonner | Tilordne hver kolonne i filen til tabellens kolonner. |
| Kjør asynkront | Hvis du vil at kommandoen skal kjøre asynkront og ikke vente til importen er fullført før du fortsetter med kjeden, merker du av i denne boksen. |
| Tagger | Hvis du vil inkludere metadata som organisasjonen din sporer om dataene, legger du til tagger og velger navn og verdier for dem. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Importer regneark til tabell
Hvis du vil importere et regneark til en tabell og returnere et filmetaresultat, bruker du kommandoen Importer regneark til tabell.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Angi den unike identifikatoren for tabellen som filen skal importeres til. |
| Fil-ID | Angi den unike identifikatoren for filen som regnearket skal importeres til (valgfritt). |
| Filnavn | Skriv inn det unike navnet som filen skal få ved import til tabellen. |
| URL til regneark | Skriv inn den fullstendige URL-adressen til regnearket du vil importere data fra. |
| Kjør asynkront | Hvis du vil at kommandoen skal kjøre asynkront og ikke vente til importen er fullført før du fortsetter med kjeden, merker du av i denne boksen. |
| Tagger | Hvis du vil inkludere metadata som organisasjonen din sporer om dataene, legger du til tagger og velger navn og verdier for dem. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over tilkoblinger
Hvis du vil liste opp data mellom funksjoner i Workiva-plattformen, bruker du kommandoen List connections.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Egenskap | Detaljer |
|---|---|
| Kildetype | Bruk rullegardinmenyen til å velge hvilken type fil eller element du vil hente data fra. |
| Destinasjonstype | Bruk rullegardinmenyen til å velge hvilken type fil eller element du vil sende data til. |
| Kilde-ID | Skriv inn den unike identifikatoren for filen eller elementet du vil hente data fra. |
| Destinasjons-ID | Skriv inn den unike identifikatoren for filen eller elementet du vil sende data til. |
Merk: Forespørselen din må inneholde enten en Kildetype + Kilde-ID eller en Destinasjonstype + Destinasjons-ID; forespørselen vil mislykkes hvis et av disse parene ikke finnes.
Utganger
| Utdata | Utgangstype |
|---|---|
| Forbindelser | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over filfeil
Hvis du vil ha en liste over feilene som er knyttet til en fil, for eksempel på grunn av en import, kan du bruke kommandoen List file errors.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Fil-ID | Skriv inn ID-en til filen du vil hente feil for. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Feilliste | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over filer
Hvis du vil hente en liste over filene i en Wdata-tabell og metadataene deres, kan du bruke kommandoen List files.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen du vil hente filer fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Liste over filer | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over pivotvisninger
Hvis du vil liste opp Wdata-visningene i arbeidsområdet ditt og hente metadataene deres, bruker du kommandoen List pivot views.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivot-visning | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over forespørsler
Hvis du vil liste opp Wdata-spørringene i arbeidsområdet ditt og hente metadataene deres, kan du bruke kommandoen List queries.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørringer | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over søkeresultater
Hvis du vil ha en liste over tilgjengelige resultater for en Wdata-spørring, bruker du kommandoen List query results.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forespørsels-ID | Skriv inn ID-en til spørringen du vil hente resultater fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Resultater av spørringen | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Velg lister
Hvis du vil liste opp alle verdilister for flervalgsspørringsparametere i arbeidsområdet ditt og hente metadataene deres, kan du bruke kommandoen List select lists.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Velg lister | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Listeark
Hvis du vil liste opp alle arkene i et regneark og hente ut metadataene deres, kan du bruke kommandoen List sheets.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som arkene skal listes opp i. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Ark | JSON |
| Antall ark | Heltall |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over tabeller
Hvis du vil liste opp alle Wdata-tabeller i arbeidsområdet ditt og hente ut metadataene deres, bruker du kommandoen List tables.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-gettables/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabelliste | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over brukere
Hvis du vil hente ut en liste med detaljer om en organisasjons brukere, bruker du kommandoen List users. Den tildelte integrasjonsbrukeren må ha rollen Org Admin for å kunne utføre denne kommandoen.
På samme måte som i en organisasjonsadministrators "People View"-eksport, er detaljene sortert etter visningsnavn og inkluderer brukernes:
- Brukernavn
- E-postadresser
- SAML-ID-er
- Siste innlogginger
- Medlemskap i Workspace
- Lisenser og roller
Tilsvarende API-kall: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Organisasjons-ID | Skriv inn den unike identifikatoren til organisasjonen du vil liste opp brukere for. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Brukere rapporterer | Fil |
| Antall poster | Heltall |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Overskrive arkdata
Hvis du vil slette alle cellene i et ark og erstatte dem med verdiene i filen, bruker du kommandoen Overskriv arkdata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/updatesheet.html#
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som skal overskrive arkdataene. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren til arket du vil overskrive data i. |
| Datafil | Skriv inn CSV-filen som inneholder dataene som arket skal fylles ut med. |
| Skilletegn | Skriv inn skilletegnet som brukes i Data File. |
| Bruk plattform-API | Hvis du vil bruke formatet Entered in for celleverdiene i regnearket, merker du av i denne boksen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rad skrevet | Heltall |
| Celler skrevet | Heltall |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Publiser regneark
For å publisere lenkene i et regneark bruker du kommandoen Publish spreadsheet.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som skal publiseres. |
| Publiser alle koblinger | Velg hvilke av lenkene i regnearket som skal publiseres:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Melding | Streng |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater forbindelse
Hvis du vil oppdatere en bestemt tilkobling basert på ID-en, bruker du kommandoen Refresh connection.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forbindelses-ID | Skriv inn den unike identifikatoren for tilkoblingen som skal oppdateres. |
| Bruk tidligere kildeparametere | Merk av i denne boksen for å bruke kildeparametrene fra forrige kjøring; dette overstyrer eventuelle andre kildeparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet "Oppdater gruppe av tilkoblinger". |
| Kildeparametere* |
Angi parametrene som skal sendes til kilden når oppdateringen lykkes. (Disse parameterne ignoreres hvis "Bruk tidligere kildeparametere" er aktivert) |
| Bruk tidligere destinasjonsparametere | Merk av i denne boksen for å bruke destinasjonsparametrene fra forrige kjøring; dette overstyrer eventuelle andre destinasjonsparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet "Oppdater gruppe av tilkoblinger". |
| Parametere for destinasjon |
Angi parametrene som skal sendes til destinasjonen ved en vellykket oppdatering. (Disse parameterne ignoreres hvis "Bruk tidligere destinasjonsparametere" er aktivert) |
Merk: Multi-Select Parameters støttes ikke for øyeblikket.
Utganger
| Utdata | Utgangstype |
|---|---|
| Oppdater status | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater en gruppe tilkoblinger
Hvis du vil oppdatere flere tilkoblinger samtidig, bruker du kommandoen Refresh batch of connections.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forbindelser |
Veksle for å aktivere eller deaktivere bruk av variabler. Når den er aktivert:
|
| Forbindelses-ID | Skriv inn den unike identifikatoren for tilkoblingen som skal oppdateres. |
| Bruk tidligere kildeparametere | Merk av i denne boksen for å bruke kildeparametrene fra forrige kjøring; dette overstyrer eventuelle andre kildeparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet "Oppdater gruppe av tilkoblinger". |
| Kildeparametere |
Angi parametrene som skal sendes til kilden når oppdateringen lykkes. (Disse parameterne ignoreres hvis "Bruk tidligere kildeparametere" er aktivert) |
| Bruk tidligere destinasjonsparametere | Merk av i denne boksen for å bruke destinasjonsparametrene fra forrige kjøring; dette overstyrer eventuelle andre destinasjonsparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet "Oppdater gruppe av tilkoblinger". |
| Parametere for destinasjon |
Angi parametrene som skal sendes til destinasjonen ved en vellykket oppdatering. (Disse parameterne ignoreres hvis "Bruk tidligere destinasjonsparametere" er aktivert) |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Fjern kanten
Denne kommandoen er bare tilgjengelig via plattform-API-et. Hvis du vil fjerne en kant, bruker du endepunktet Create new record edits.
Hent en liste over poster
For å få tilbake en liste over poster som samsvarer med de angitte filtrene, bruker du kommandoen Retrieve a list of records. Det er alltid nødvendig med minst ett filter.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-getrecords/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
| Filtrer | Egenskapene som resultatene skal filtreres etter. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent en liste over typer
Hvis du vil ha en liste over posttyper og deres attributter, bruker du kommandoen Retrieve a list of types. Denne kommandoen forteller deg hva du kan forvente når du henter poster.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-gettypes/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent en enkelt oppføring
Hvis du vil hente én enkelt post, bruker du kommandoen Hent en liste med poster. Den unike identifikatoren er vanligvis en UUID, men dette kan variere.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
| Record ID | Skriv inn postens unike identifikator. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent en enkelt type
Hvis du vil hente én enkelt post, bruker du kommandoen Hent en liste med poster. Den unike identifikatoren er vanligvis en UUID, men dette kan variere.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
| Record ID | Skriv inn postens unike identifikator. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Kjør spørring
For å kjøre en Wdata-spørring og hente ut resultatene, bruker du kommandoen Run query.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-runquery/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forespørsels-ID | Skriv inn ID-en til spørringen som skal kjøres. |
| Parametere | Hvis spørringen har definerte parametere, legger du til en oversikt over navn og verdier. Merk: Skriv inn verdiene for eventuelle flervalgsparametere i Flervalgsparametere. |
| Kjør asynkront | Hvis du vil kjøre spørringen asynkront, og ikke vente til spørringen er ferdig for å fullføre kommandoen, merker du av i denne boksen. |
| Flervalgsparametere | Hvis spørringen har flere parametere definert, legger du til navn og verdier for hver av dem. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Resultat av spørringen | JSON |
Merk: Utdataene fra Query Result inneholder en ID som kan brukes til å laste ned og eksportere resultatene.
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Kjør rapport
Hvis du vil kjøre en lagret rapport i organisasjonens SOX- og internrevisjonsdatabasekonto og returnere resultatene som en CSV-fil, bruker du kommandoen Run report.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Rapport-ID | Skriv inn den unike identifikatoren for rapporten som inneholder den lagrede rapporten. |
| Forhåndsvisning av innhold | Hvis du vil inkludere en forhåndsvisning av rapportens resultater i kommandologgen, merker du av i denne boksen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rapport | Fil |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Sett kant
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å angi en kant bruker du endepunktet Create new record edits.
Angi plateegenskaper
Denne kommandoen er bare tilgjengelig via plattform-API-et. For å angi egenskaper for poster bruker du endepunktet Create new record edits.
Fjern import av fil fra tabell
For å avimportere og fjerne en fil fra en Wdata-tabell bruker du kommandoen Un-import file From table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen som filen skal fjernes fra. |
| Fil-ID | Skriv inn den unike identifikatoren for filen som skal fjernes fra tabellen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater pivotvisning
For å oppdatere metadataene til en Wdata-visning bruker du kommandoen Update pivot view.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID | Skriv inn ID-en til visningen som skal oppdateres. |
| Navn | Skriv inn det nye navnet på visningen. |
| Forespørsels-ID | Skriv inn ID-en til spørringen som visningen skal opprettes fra. |
| ID for søkeresultat | Skriv inn ID-en til spørringsresultatet som visningen skal opprettes fra. |
| Ytterligere metadata | Skriv inn de brukerdefinerte metadataene som skal knyttes til visningen, som et JSON-objekt (valgfritt). |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivot-visning | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater spørreskjemadefinisjonen
For å oppdatere egenskapene til en Wdata-spørring bruker du kommandoen Update query definition.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Forespørsels-ID | Skriv inn ID-en til spørringen som skal oppdateres. |
| Navn | Skriv inn det nye navnet på spørringen. |
| Beskrivelse | Skriv inn den nye beskrivelsen av spørringen. |
| Primær resultat-ID | Hvis angitt, angir du ID-en til standardresultatet som skal fylles ut med søkeresultatene. |
| Spørretekst | Skriv inn spørringsdefinisjonen som Presto SQL-syntaks, slik du ville gjort i spørringens SQL Editor. |
| Midlertidig | Hvis du vil generere spørringen bare midlertidig, slik at den ikke ikke vises i arbeidsområdet ditt, merker du av i denne boksen. |
| Parametere | Angi parameterne som kreves for å kjøre spørringen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater valglisten
Hvis du vil oppdatere egenskapene eller elementene for en liste med verdier for en spørringsparameter med flere valg, kan du bruke kommandoen Update select list.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| ID | Skriv inn ID-en til valglisten som skal oppdateres. |
| Navn | Skriv inn det nye navnet på valglisten. |
| Beskrivelse | Skriv inn den nye beskrivelsen av valglisten. |
| Verditype | Velg datatypen for listens verdier, for eksempel streng eller heltall. |
| Verdier | Skriv inn listens verdier, inkludert eventuelle oppdateringer. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Oppdater valglisten | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater arkets metadata
Hvis du vil oppdatere metadataene for et ark i et regneark, bruker du kommandoen Update sheet metadata.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren til regnearket med arket som metadataene skal oppdateres i. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren til arket som metadataene skal oppdateres i. |
| Navn | Skriv inn det nye navnet på arket. |
| Indeks for ark | Skriv inn den nye indeksen for arket i regnearket. Som standard oppdaterer kommandoene arket som det øverste arket. |
| Foreldreark-ID | Skriv inn ID-en til det overordnede arket som arket skal opprettes under. Hvis du vil legge til i rotregnearket, lar du feltet stå tomt. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater regnearkets metadata
For å oppdatere et regnearks metadata bruker du kommandoen Update spreadsheet metadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/updatesheet.html
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren til regnearket med arket som metadataene skal oppdateres i. |
| Navn | Skriv inn det nye navnet på regnearket. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater tabell
For å oppdatere kolonnene i en Wdata-tabell bruker du kommandoen Update table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen som skal oppdateres. |
| Navn | Skriv inn navnet på tabellen som skal oppdateres. |
| Beskrivelse | Skriv inn en beskrivelse av tabellen som skal oppdateres. |
| Type | Velg om du vil oppdatere en Data- eller fact-eller Lookup- eller dimension-table |
| Kolonner | Legg til kolonnene du vil oppdatere tabellen med. Skriv inn navn, datatype, alias og beskrivelse for hver kolonne. For Mode, la standardinnstillingen være Nullable. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Skriv arkdata
Hvis du vil skrive data i et CSV-datasett til en bestemt region på et ark, bruker du kommandoen Write sheet data.
Egenskaper
| Egenskap | Detaljer |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket med arket du vil skrive data til. |
| Ark-ID/navn | Skriv inn den unike identifikatoren for arket du vil skrive data til. |
| Datafil | Angi CSV-filen med dataene som skal skrives til arket. Dataområdet må ikke overskride Region. |
| Skilletegn | Skriv inn skilletegnet som brukes i Data File. |
| Region | Skriv inn en A1-representasjon av cellen eller celleområdet i arket som dataene skal skrives til. Hvis du vil at området skal være ubegrenset i en eller alle retninger, lar du den tilsvarende kolonnen eller raden være tom. |
| Bruk asynkron |
Hvis du vil laste inn dataene asynkront, for eksempel for et stort datasett, merker du av i denne boksen. Merk: Når du bruker async, må du legge til din egen polling for å finne statusen til jobben. |
| Bruk plattform-API |
Hvis du vil bruke entered-in formatet for celleverdiene i Region, merker du av i denne boksen. Dette vil tvinge kommandoen til å bruke oppdateringsverdier i et områdeendepunkt i stedet for regneark-APIets skriv data til et regionendepunkt. Merk: Denne kommandoen vil alltid kjøres asynkront når du bruker plattform-API-et. Du må legge til din egen polling for å finne status for jobben. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rader skrevet | Heltall |
| Celler skrevet | Heltall |
Utgangskoder
| Kode | Type | Detaljer |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |