For å automatisere oppgaver i Workiva-plattformen som en del av en kjede, for eksempel for å muliggjøre utveksling av data med andre datakilder, legg til et trinn som inkluderer en Workiva-tilkoblingskommando.
For å aktivere disse kommandoene må en IT-administrator først sette opp en Workiva-kobling.
Fjern arkdata
For å slette alle data i et ark, bruk kommandoen Fjern arkdata.
Tilsvarende API-kall:https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett fil
For å laste opp en kommaseparert verdi (CSV), Javascript-objektnotasjon (JSON) eller komprimert ZIP-fil og vise postene, bruk kommandoen Opprett fil. 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 avgrenset av et linjeskifttegn.
- Hvis det er en ZIP-fil, må den inneholde én CSV- eller JSON-fil, hvis navn brukes til å navngi den importerte filen. Hvis du laster ned filen på nytt, lastes kildekoden ned.
- Hvis det er en URL, sender endepunktet en forespørsel om å hente en fil ved hjelp av en enkel uautentisert
GETforespørsel.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen du vil vise filene til. |
| Fil |
Skriv inn filen som skal lastes opp. Ignoreres hvis Nedlastings-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 Nedlastings-URL er angitt, skriver du inn navnet på filen som skal lastes opp; som standard er dette basisnavnet til Nedlastings-URL. |
| Nedlastings-URL |
Skriv inn URL-en som peker til filen som skal lastes ned, for eksempel en Amazon S3-signert URL. Valgfritt hvis Fil er angitt. Merk: Kommandoen foretar en enkel |
Utganger
| Utdata | Utgangstype |
|---|---|
| Resultater | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett nye redigeringer av oppføringer
For å opprette nye redigeringer av poster gitt de angitte egenskapene, bruk kommandoen Opprett nye redigeringer av poster. Hver redigering krever minst én operasjon og et mål-ID.
Grense: Opptil 1000 redigeringer kan behandles per forespørsel.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-createedits/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Operasjon |
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 egenskapene for den. |
| Oppførings-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åloppføringen. 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 | Skriv inn den midlertidige ID-en som skal brukes når en post opprettes. 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 typen oppføring som skal opprettes. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivotvisning | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett pivotvisning
For å opprette en ny Wdata-visning gitt spørringen og spørreresultatet, bruk kommandoen Opprett pivotvisning.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere visningen. |
| Søke-ID | Skriv inn ID-en til spørringen som visningen skal opprettes fra. |
| Søkeresultat-ID | Skriv inn ID-en til spørreresultatet som visningen skal opprettes fra. |
| Ytterligere metadata | Skriv inn de brukerdefinerte metadataene som skal legges til visningen som et JSON-objekt (valgfritt). |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivotvisning | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett forhåndsvisningsspørring (avskrevet)
Denne kommandoen er utdatert ettersom endepunktet ikke lenger støttes.
Opprett spørring
For å opprette en ny Wdata-spørring, bruk kommandoen Opprett spørring.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createquery/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere spørringen. |
| Beskrivelse | Skriv inn en beskrivelse av spørringen. |
| Primær resultat-ID | Hvis spesifisert, angi ID-en til standardresultatet som skal fylles ut med spørreresultatene. |
| 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 midlertidig slik at den ikke vises i arbeidsområdet ditt, merker du av i denne boksen. |
| Parametere | Skriv inn parameterne som kreves for å kjøre spørringen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett post
Denne kommandoen er bare tilgjengelig via Platform API. For å opprette en ny post, bruk endepunktet Opprett nye postredigeringer.
Opprett valgliste
For å opprette en liste med verdier for en flervalgsspørringsparameter, bruk kommandoen Opprett valgliste.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Navn | Skriv inn et unikt navn for å identifisere utvalgslisten. |
| Beskrivelse | For å identifisere utvalgslisten ytterligere, skriv inn en beskrivelse av verdiene eller parameteren. |
| Verditype | Velg datatypen for listeverdiene, for eksempel streng eller heltall. |
| Verdier | Skriv inn verdiene i listen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Opprett metadata for utvalgte lister | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett ark
For å legge til et nytt ark i et regneark, bruk kommandoen Opprett ark.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket du vil legge arket til i. |
| Navn | Skriv inn et unikt navn for å identifisere arket. |
| Arkindeks |
Skriv inn indeksen for det nye arket i regnearket. Merk: Som standard legger kommandoen arket til som det øverste arket. |
| ID for overordnet ark | Skriv inn ID-en til det overordnede arket for å opprette arket under. La feltet stå tomt for å legge til i rotregnearket. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Arkmetadata | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett regneark
For å opprette et nytt regneark, bruk kommandoen Opprett regneark.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| Navn | Skriv inn det unike navnet for å identifisere regnearket. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Arkmetadata | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Opprett tabell
For å opprette en ny Wdata-tabell i arbeidsområdet ditt, bruk kommandoen Opprett tabell.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-createtable/
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 datatabell (eller faktatabell) eller oppslagstabell (eller dimensjonstabell). |
| Kolonner |
Legg til kolonnene som skal inkluderes i tabellen:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett fil
For å slette en fil fra Wdata-arbeidsområdet ditt, bruk kommandoen Slett fil.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Fil-ID | Skriv inn ID-en til filen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett pivotvisning
For å slette en Wdata-visning fra arbeidsområdet ditt, bruk kommandoen Slett pivotvisning.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Egenskaper
| Egenskap | Detalj |
|---|---|
| ID | Skriv inn ID-en til visningen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett spørring
For å slette en Wdata-spørring fra arbeidsområdet ditt, bruk kommandoen Slett spørring.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søke-ID | Skriv inn ID-en til spørringen som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett oppføring
Denne kommandoen er bare tilgjengelig via Platform API. For å slette en post, bruk kommandoen Opprett ny postredigering.
Slett ark
For å slette et ark og dets underark (rekursivt) fra et regneark, bruk kommandoen Slett ark.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett regneark
For å slette et regneark fra arbeidsområdet ditt, bruk kommandoen Slett regneark.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som skal slettes. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Slett tabell
For å slette en Wdata-tabell fra arbeidsområdet ditt, bruk kommandoen Slett tabell.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen som skal slettes |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Last ned fil
For å laste ned et datasett fra Wdata-arbeidsområdet ditt, bruk kommandoen Last ned fil.
Merk: Denne kommandoen er ikke kompatibel med andre objekttyper som regneark, tabeller eller spørringer.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Fil-ID | Skriv inn ID-en til filen som skal lastes ned. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Fil | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Last ned Pivot View (avskrevet)
Denne kommandoen er utdatert ettersom endepunktet ikke lenger støttes.
Last ned søkeresultatet
For å laste ned resultatene av en Wdata-spørring til en fil, bruk kommandoen Download query result.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søkeresultat-ID | Skriv inn ID-en til spørreresultatet som skal lastes ned. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Søkeresultat | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Rediger
Denne kommandoen er bare tilgjengelig via Platform API. For å redigere en post, bruk endepunktet Opprett nye postredigeringer.
Eksporter fil til regneark
For å eksportere et datasett fra en Wdata-tabell til et nytt eller eksisterende regneark, bruk kommandoen Eksporter fil til regneark.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Fil-ID | Skriv inn ID-en til tabelldatasettet som skal eksporteres. |
| Regneark-URL | Skriv inn URL-en til regnearket du vil eksportere til. For å opprette et nytt regneark, la det stå tomt. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Arkinformasjon | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Eksporter spørreresultat
For å eksportere et Wdata-spørreresultat til et nytt eller eksisterende regneark, bruk kommandoen Eksporter spørreresultat.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søkeresultat-ID | Skriv inn ID-en til spørreresultatet som skal eksporteres. |
| Regneark-URL | Skriv inn URL-en til regnearket du vil eksportere til. For å opprette et nytt regneark, la det stå tomt. |
| Eksporter som datasett | Når det er merket av, eksporteres dataene som et tilkoblet datasett, og cellene kan bare redigeres ved å oppdatere datasettet i regnearket. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent filegenskaper
For å hente egenskapene til en fil i Wdata-arbeidsområdet ditt, bruk kommandoen Get file properties.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getfile/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Fil-ID | Skriv inn ID-en til filen for å hente egenskapene til. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filegenskaper | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent pivotvisning
For å hente metadataene til en Wdata-visning, bruk kommandoen Get pivot view.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Egenskaper
| Egenskap | Detalj |
|---|---|
| ID | Skriv inn ID-en til pivotvisningen det skal hentes metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivotvisning | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent spørringsmetadata
For å hente metadataene fra en Wdata-spørring, bruk kommandoen Get query metadata.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getquery/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søke-ID | Skriv inn ID-en til spørringen du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Få oversikt
Denne kommandoen er bare tilgjengelig via Platform API. For å hente en post, bruk endepunktet Hent en enkelt post.
Hent poster
Denne kommandoen er bare tilgjengelig via Platform API. For å hente flere poster, bruk endepunktet Hent en liste over poster.
Få rapporter
For å hente alle rapporter fra organisasjonens SOX- og internrevisjonsdatabasekonto, bruk kommandoen Get reports.
Tilsvarende API-kall:https://developers.workiva.com/platform-v1/platform-graphreportexport/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Rapporter | Fil |
| Antall rapporter | Heltall |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent utvalgsliste
For å hente en liste over verdier for en flervalgsspørringsparameter basert på listens ID, bruk kommandoen Get select list.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Velg liste-ID | Skriv inn den unike identifikatoren for valglisten som skal hentes. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Hent nyttelasten til utvalgslisten | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent arkdata
For å hente alle dataene i et spesifisert område av et ark, bruk kommandoen Hent arkdata.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 for arket du vil hente data fra. |
| Region | Skriv inn A1-stilrepresentasjonen av en celle eller et område, for eksempel [Startkolonne][Startrad]:[Stoppkolonne][Stopprad]. For å ha området ubegrenset i noen eller alle retninger, utelat den tilsvarende kolonnen eller raden. |
| Verdistil | Velg om du vil returnere den rå eller beregnede celleverdien. Hvis for eksempel verdien til en celle er =1+:1, velger du Rå for =1+1 eller Beregnet for den beregnede verdien 2. |
| Revisjon | Angi versjonen av arket som data skal hentes fra. For gjeldende versjon, skriv inn -1. |
| Bruk plattform-API | Når denne boksen er merket av, returnerer denne kommandoen arkdataene ved hjelp av standard desimalnotasjon.Hvis den er tom, returneres arkdataene ved hjelp av vitenskapelig notasjon. Dette tvinger kommandoen til å bruke funksjonen Hent data fra et arkendepunkt i stedet for regneark-API-ens funksjon Returner data fra et regionendepunkt. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Radantall | Heltall |
| Data | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent metadata for ark
For å hente metadataene til et ark i et regneark, bruk kommandoen Hent arkmetadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getsheetdata.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 for arket du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Arkmetadata | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent regnearkmetadata
For å hente metadataene til et regneark, bruk kommandoen Hent regnearkmetadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Regnearkmetadata | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent tabellmetadata
For å hente metadataene til en Wdata-tabell, bruk kommandoen Get table metadata.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-gettable/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen du vil hente metadata fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent type
Denne kommandoen er bare tilgjengelig via Platform API. For å hente en post, bruk endepunktet Hent en enkelt post.
Hent typer
Denne kommandoen er bare tilgjengelig via Platform API. For å hente flere posttyper, bruk endepunktet Hent en liste over typer.
Helsesjekk
For å sjekke tilstanden til Wdata API-et, bruk en Helsesjekk -kommando.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Svar | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Importer filen til tabellen
For å importere en fil til en Wdata-tabell, bruk kommandoen Importer file into table.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-importfile/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen du vil importere filen til. |
| Fil-ID | Skriv inn ID-en til filen som skal importeres til tabellen. |
| Kolonnetilordninger | Tilordne hver kolonne i filen til tabellens kolonner. |
| Kjør asynkront | For at kommandoen skal kjøre asynkront og ikke vente til importen er fullført før kjeden fortsetter, merk av i denne boksen. |
| Tagger | For å inkludere metadata som organisasjonen din sporer om dataene, legg til tagger og velg navnene og verdiene deres. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Importer regneark til tabell
For å importere et regneark til en tabell og returnere et metaresultat for en fil, bruk kommandoen Importer regneark til tabell.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen du vil importere filen til. |
| Fil-ID | Skriv inn den unike identifikatoren for filen du vil importere regnearket til (valgfritt). |
| Filnavn | Skriv inn det unike navnet som skal gis filen ved import til tabellen. |
| Regneark-URL | Skriv inn hele URL-en til regnearket du vil importere data fra. |
| Kjør asynkront | For at kommandoen skal kjøre asynkront og ikke vente til importen er fullført før kjeden fortsetter, merk av i denne boksen. |
| Tagger | For å inkludere metadata som organisasjonen din sporer om dataene, legg til tagger og velg navnene og verdiene deres. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over tilkoblinger
For å liste opp data mellom funksjoner på Workiva-plattformen, bruk kommandoen List connections.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Egenskap | Detalj |
|---|---|
| Kildetype | Bruk rullegardinmenyen til å velge filtypen eller elementet du vil hente data fra. |
| Destinasjonstype | Bruk rullegardinmenyen til å velge filtypen eller elementet du vil sende data til. |
| Kilde-ID | Skriv inn den unike identifikatoren for filen eller elementet det skal hentes 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 Kildetype + Kilde-ID eller Destinasjonstype + Destinasjons-ID; forespørselen vil mislykkes hvis ett av disse parene ikke er tilstede.
Utganger
| Utdata | Utgangstype |
|---|---|
| Forbindelser | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over filfeil
For å liste opp feilene som er knyttet til en fil, for eksempel på grunn av en import, bruk kommandoen List file errors.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Fil-ID | Skriv inn ID-en til filen det skal hentes feil for. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Feilliste | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over filer
For å hente en liste over filer i en Wdata-tabell og deres metadata, bruk kommandoen List files.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn ID-en til tabellen du vil hente filer fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filliste | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over pivotvisninger
For å liste opp Wdata-visningene i arbeidsområdet ditt og hente metadataene deres, bruk kommandoen List pivot views.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivotvisninger | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Listesøk
For å liste opp Wdata-spørringene i arbeidsområdet ditt og hente metadataene deres, bruk 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 | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over søkeresultater
For å liste opp de tilgjengelige resultatene for en Wdata-spørring, bruk kommandoen List query results.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søke-ID | Skriv inn ID-en til spørringen du vil hente resultater fra. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Søkeresultater | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Listevalglister
Hvis du vil liste opp alle verdilister for flervalgsspørringsparametere i arbeidsområdet og hente metadataene deres, bruker du kommandoen List select lists.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Listevalglister | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Listeark
For å liste opp alle ark i et regneark og hente metadataene deres, bruk kommandoen List sheets.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket for å liste opp arkene i. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Ark | JSON |
| Antall ark | Heltall |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over tabeller
For å liste opp alle Wdata-tabeller i arbeidsområdet ditt og hente metadataene deres, bruk kommandoen List tables.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-gettables/
Egenskaper
Ingen
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabellliste | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Liste over brukere
For å hente en liste over detaljer om en organisasjons brukere, bruk kommandoen List users. Den tildelte integrasjonsbrukeren din må ha rollen som organisasjonsadministrator for å utføre denne kommandoen.
I likhet med en organisasjonsadministrators eksport av «Personvisning», sorteres detaljene etter visningsnavn og inkluderer brukernes:
- Brukernavn
- E-postadresser
- SAML-ID-er
- Siste innlogginger
- Arbeidsområdemedlemskap
- Lisenser og roller
Tilsvarende API-kall: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Organisasjons-ID | Skriv inn den unike identifikatoren til organisasjonen du vil vise brukere for. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Brukerrapport | Fil |
| Antall poster | Heltall |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Overskriv arkdata
For å tømme alle cellene i et ark og erstatte dem med verdiene som er oppgitt i filen, bruk kommandoen Overskriv arkdata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/updatesheet.html#
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som arkdata skal overskrives i. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren for arket som dataene skal overskrives i. |
| Datafil | Skriv inn CSV-filen som inneholder dataene som skal fylles ut i arket. |
| Skilletegn | Skriv inn skilletegnet som brukes i Datafil. |
| Bruk plattform-API | For å bruke formatet Angitt i for regnearkets celleverdier, merk av i denne boksen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rad skrevet | Heltall |
| Celler skrevet | Heltall |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Publiser regneark
For å publisere lenkene i et regneark, bruk kommandoen Publiser regneark.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket som skal publiseres. |
| Publiser alle koblinger |
Velg hvilke av regnearkets lenker som skal publiseres:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Melding | Streng |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater forbindelse
For å oppdatere en bestemt tilkobling basert på ID-en, bruk kommandoen Oppdater tilkobling.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Forbindelses-ID | Skriv inn den unike identifikatoren for tilkoblingen som skal oppdateres. |
| Bruk tidligere kildeparametere | Kryss av i denne boksen for å bruke kildeparameterne fra forrige kjøring. Dette overstyrer alle andre kildeparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet «Oppdater gruppe med tilkoblinger». |
| Kildeparametere* |
Skriv inn parameterne som skal sendes til kilden ved en vellykket oppdatering. (Disse parameterne vil bli ignorert hvis «Bruk tidligere kildeparametere» er aktivert.) |
| Bruk tidligere destinasjonsparametere | Kryss av i denne boksen for å bruke målparameterne fra forrige kjøring. Dette overstyrer alle andre målparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet «Oppdater gruppe med tilkoblinger». |
| Destinasjonsparametere* |
Skriv inn parameterne som skal sendes til destinasjonen ved en vellykket oppdatering. (Disse parameterne vil bli ignorert hvis «Bruk tidligere destinasjonsparametere» er aktivert.) |
Merk: Flervalgsparametere støttes ikke for øyeblikket.
Utganger
| Utdata | Utgangstype |
|---|---|
| Oppdater status | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater gruppen med tilkoblinger
For å oppdatere flere tilkoblinger samtidig, bruk kommandoen Oppdater gruppe med tilkoblinger.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Forbindelser |
Veksle for å aktivere eller deaktivere bruk av variabler. Når aktivert:
|
| Forbindelses-ID | Skriv inn den unike identifikatoren for tilkoblingen som skal oppdateres. |
| Bruk tidligere kildeparametere | Kryss av i denne boksen for å bruke kildeparameterne fra forrige kjøring. Dette overstyrer alle andre kildeparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet «Oppdater gruppe med tilkoblinger». |
| Kildeparametere |
Skriv inn parameterne som skal sendes til kilden ved en vellykket oppdatering. (Disse parameterne vil bli ignorert hvis «Bruk tidligere kildeparametere» er aktivert.) |
| Bruk tidligere destinasjonsparametere | Kryss av i denne boksen for å bruke målparameterne fra forrige kjøring. Dette overstyrer alle andre målparametere du har angitt. Denne inndataen vil bli ignorert av endepunktet «Oppdater gruppe med tilkoblinger». |
| Destinasjonsparametere |
Skriv inn parameterne som skal sendes til destinasjonen ved en vellykket oppdatering. (Disse parameterne vil bli ignorert hvis «Bruk tidligere destinasjonsparametere» er aktivert.) |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Fjern kanten
Denne kommandoen er bare tilgjengelig via Platform API. For å fjerne en kant, bruk endepunktet Opprett nye postredigeringer.
Hent en liste over poster
For å returnere en liste over poster som samsvarer med de oppgitte filtrene, bruk kommandoen Hent en liste over poster. Minst ett filter er alltid nødvendig.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-getrecords/
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent en liste over typer
For å returnere en liste over posttyper og deres attributter, bruk kommandoen Hent en liste over typer. Denne kommandoen lar deg vite hva du kan forvente når du henter poster.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-gettypes/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent en enkelt post
For å hente én enkelt post, bruk kommandoen Hent en liste over 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 | Detalj |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
| Oppførings-ID | Skriv inn postens unike identifikator. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Hent én enkelt type
For å hente én enkelt post, bruk kommandoen Hent en liste over 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 | Detalj |
|---|---|
| Utvid |
Returnerer relaterte ressurser på linje med hovedressursen. Alternativer:
|
| Oppførings-ID | Skriv inn postens unike identifikator. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Status for batchoppdatering | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Kjør spørring
For å kjøre en Wdata-spørring og hente resultatene, bruk en Kjør spørring -kommando.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-runquery/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søke-ID | Skriv inn ID-en til spørringen som skal kjøres. |
| Parametere |
Hvis spørringen har definerte parametere, legg til en oversikt over navnene og verdiene deres. Merk: Skriv inn verdiene til 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 definerte flervalgsparametere, legger du til navnet og verdiene for hver av dem. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Søkeresultat | JSON |
Merk: Resultatet fra Query Result inneholder en ID som kan brukes til å laste ned og eksportere resultatene.
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Kjør rapport
For å kjøre en lagret rapport i organisasjonens SOX- og internrevisjonsdatabasekonto og returnere resultatene som en CSV-fil, bruk kommandoen Kjør rapport.
Tilsvarende API-kall: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Rapport-ID | Skriv inn den unike identifikatoren for rapporten som inneholder den lagrede rapporten. |
| Forhåndsvis innhold | Hvis du vil inkludere en forhåndsvisning av rapportens resultater i kommandoens logg, merker du av i denne boksen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rapport | Fil |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Sett kanten
Denne kommandoen er bare tilgjengelig via Platform API. For å angi en grense, bruk endepunktet Opprett nye postredigeringer.
Angi egenskaper for posten
Denne kommandoen er bare tilgjengelig via Platform API. For å angi egenskaper for posten, bruk endepunktet Opprett nye redigeringer av posten.
Fjern import av fil fra tabell
For å avimportere og fjerne en fil fra en Wdata-tabell, bruk en Avimporter fil fra tabell -kommando.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Tabell-ID | Skriv inn den unike identifikatoren for tabellen du vil fjerne filen fra. |
| Fil-ID | Skriv inn den unike identifikatoren for filen som skal fjernes fra tabellen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Filimport | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater pivotvisning
For å oppdatere metadataene til en Wdata-visning, bruk en Oppdater pivotvisning -kommando.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Egenskaper
| Egenskap | Detalj |
|---|---|
| ID | Skriv inn ID-en til visningen som skal oppdateres. |
| Navn | Skriv inn det nye navnet på visningen. |
| Søke-ID | Skriv inn ID-en til spørringen som visningen skal opprettes fra. |
| Søkeresultat-ID | Skriv inn ID-en til spørreresultatet som visningen skal opprettes fra. |
| Ytterligere metadata | Skriv inn de brukerdefinerte metadataene som skal legges til visningen, som et JSON-objekt (valgfritt). |
Utganger
| Utdata | Utgangstype |
|---|---|
| Pivotvisning | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater spørringsdefinisjonen
For å oppdatere egenskapene til en Wdata-spørring, bruk en Oppdater spørringsdefinisjon -kommando.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Søke-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 spesifisert, angi ID-en til standardresultatet som skal fylles ut med spørreresultatene. |
| Spørretekst | Skriv inn spørringsdefinisjonen som Presto SQL-syntaks, slik du ville gjort med i spørringens SQL-editor. |
| Midlertidig | Hvis du bare vil generere spørringen midlertidig, slik at den ikke vises i arbeidsområdet ditt, merker du av i denne boksen. |
| Parametere | Skriv inn parameterne som kreves for å kjøre spørringen. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Spørring | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater utvalgslisten
Hvis du vil oppdatere egenskapene eller elementene for en liste med verdier for en flervalgsspørringsparameter, bruker du kommandoen Oppdater valgliste.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Egenskaper
| Egenskap | Detalj |
|---|---|
| ID | Skriv inn ID-en til utvalgslisten som skal oppdateres. |
| Navn | Skriv inn det nye navnet på valglisten. |
| Beskrivelse | Skriv inn den nye beskrivelsen av valglisten. |
| Verditype | Velg datatypen for listeverdiene, for eksempel streng eller heltall. |
| Verdier | Skriv inn verdiene i listen, inkludert eventuelle oppdateringer. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Oppdater utvalgslisten | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater metadata for arket
For å oppdatere metadataene til et ark i et regneark, bruk kommandoen Oppdater arkmetadata.
Tilsvarende API-kall: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket med arket du vil oppdatere metadata i. |
| Ark-ID/navn | Skriv inn navnet eller den unike identifikatoren for arket du vil oppdatere metadata i. |
| Navn | Skriv inn det nye navnet på arket. |
| Arkindeks | Skriv inn den nye indeksen for arket i regnearket. Som standard oppdaterer kommandoene arket som det øverste arket. |
| ID for overordnet ark | Skriv inn ID-en til det overordnede arket for å opprette arket under. La feltet stå tomt for å legge til i rotregnearket. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater regnearkets metadata
For å oppdatere metadataene til et regneark, bruk kommandoen Oppdater regnearkmetadata.
Tilsvarende API-kall: https://developers.workiva.com/2022-01-01/updatesheet.html
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren for regnearket med arket du vil oppdatere metadata i. |
| Navn | Skriv inn det nye navnet på regnearket. |
Utganger
Ingen
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Oppdater tabellen
For å oppdatere kolonnene i en Wdata-tabell, bruk kommandoen Oppdater tabell.
Tilsvarende API-kall: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Egenskaper
| Egenskap | Detalj |
|---|---|
| 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 fakta-- eller Oppslag- eller dimensjon--tabell |
| Kolonner | Legg til kolonnene som skal oppdateres i tabellen. For hver kolonne skriver du inn navn, datatype, alias og beskrivelse. For Modus, la standardverdien være nullbar. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Tabell | JSON |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |
Skriv arkdata
For å skrive data i et CSV-datasett til et bestemt område i et ark, bruk kommandoen Skriv arkdata.
Egenskaper
| Egenskap | Detalj |
|---|---|
| Regneark-ID | Skriv inn den unike identifikatoren til regnearket med arket det skal skrives data til. |
| Ark-ID/navn | Skriv inn den unike identifikatoren for arket det skal skrives data til. |
| Datafil | Skriv inn CSV-filen med dataene som skal skrives til arket. Dataområdet må ikke overskride -området. |
| Skilletegn | Skriv inn skilletegnet som brukes i Datafil. |
| 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 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. Merknad: Når du bruker async, må du legge til din egen polling for å bestemme statusen til jobben. |
| Bruk plattform-API |
For å bruke det angitte formatet for celleverdieneRegion, merk av i denne boksen. Dette vil tvinge kommandoen til å bruke oppdateringsverdiene i et områdesluttpunkt i stedet for regneark-API-ens skrivedata til et regionsluttpunkt. Merknad: Denne kommandoen vil alltid kjøre asynkront når plattformens API brukes. Du må legge til din egen avstemning for å bestemme statusen til jobben. |
Utganger
| Utdata | Utgangstype |
|---|---|
| Rader skrevet | Heltall |
| Celler skrevet | Heltall |
Utgangskoder
| Kode | Type | Detalj |
|---|---|---|
| 0 | Vellykket | Vellykket |
| 1 | Feil | Feil |