Workiva kundestøttesenter

Innledning

Denne veiledningen viser deg hvordan du bruker Workiva API til å importere en fil til Wdata.

Hvis du ønsker å automatisere importen av en datasettfil til en Wdata-tabell, men ikke ønsker å bruke -kjeder med Workiva-koblingen, kan du i stedet bruke Workiva API direkte fra kjeder med HTTP-koblingen eller fra ekstern programvare som kan samhandle med et REST API sikret med OAuth 2.0.

Førstegangsoppsett

Først må du opprette et API-tilskudd som vil generere en klient-ID og en hemmelighet. Dette kan gjøres av en hvilken som helst Workiva-brukerkonto med minst tillatelser som «Arbeidsplasseier» eller «Organisasjonssikkerhetsadministrator» og ved å følge instruksjonene her.

Autentisering

Når du har konfigurert API-tildelingen riktig, er det første trinnet i kommunikasjonen med API-et å få autentisering. Dette bruker en bransjestandard OAuth 2.0-bærertokenutveksling og krever et POST-kall som beskrevet i -instruksjonene her.

Importer

Det er to nødvendige trinn for å laste inn data i en Wdata-tabell ved hjelp av Workiva API:

1. Last opp filen til den valgte Wdata-tabellen (https://developers.workiva.com/wdata-v1/wdata-uploadfile/). Dette vil legge til filen din som et datasett i tabellen med statusen «staged». Derfor vil ikke de nye dataene vises i noen spørringer eller visninger i tabellen på dette tidspunktet.
2. Importer filen (https://developers.workiva.com/wdata-v1/wdata-importfile/). «Id-en» du mottar i svaret fra opplastingen kan deretter brukes i egenskapen «fileId» for å importere filen, og hvis det lykkes, legge til dataene i tabellen og gjøre dem tilgjengelige i spørringer og visninger.

Med eksempler

Nøkkel

I eksemplene nedenfor vises nettadresser for EU-plattformen. For USA eller Asia-Stillehavsregionen skal «eu» endres til henholdsvis «app» eller «Apac».

1. Last opp

   Last opp filen til den valgte Wdata-tabellen: https://developers.workiva.com/wdata-v1/wdata-uploadfile/

   Eksempel:

   POST: {baseURL}/api/v1/file Overskrifter: Content-Type: multipart/form-data; boundary="boundary" Brødtekst: --boundary Content-Disposition: form-data; name="delimiter" semicolon --boundary Content-Disposition: form-data; name="tableId" {tableId} --boundary Content-Disposition: form-data; name="file"; filename="filename.csv" Content-Type: text/vanlig frukt;mengde Eple;133 Aprikos;175 Avokado;182 Banan;187 Blåbær;160 Bjørnebær;178 Solbær;102 Blåbær;156 Solbær;194 Kirsebær;182 Cherimoya;169 Klementin;165 Daddel;112 Damson;164 Durian;157 Aubergine;189 --boundary-- 

2. Importer

   Bruk deretter «Id»-en du mottar i svaret som «fileId» for å importere filen til dette: https://developers.workiva.com/wdata-v1/wdata-importfile/

   Eksempel:

   POST: {baseURL}/api/v1/table/{tableId}/import Overskrifter: Innholdstype: application/json Brødtekst: { "delimiter":";", "fileId":"{fileId}" } 

   Merk: Denne forespørselen starter bare filimporten, og svaret sendes uten å vente på at den skal lykkes eller mislykkes.

Sjekk status

Det er ikke påkrevd, men det vil være god praksis i de fleste brukstilfeller å bekrefte og logge/rapportere om filimporten var vellykket eller ikke. Dette kan gjøres med de følgende to GET-forespørslene.

1. For å bekrefte at importfilens endepunkt har importert filen, bør du bruke (poll) endepunktet Hent en enkelt fil for den samme {fileId} fra importen og deretter sjekke svaret for filen din.

   Eksempel:

   GET: {baseURL}/api/v1/file/{fileId} Overskrifter: Innholdstype: application/json 

2. Hvis statusen er «IMPORTERER», pågår importen fortsatt, så du bør sette prosessen på pause en stund før du gjentar den forrige forespørselen (avstemningen).
3. Statusen «IMPORTERT» indikerer at filen ble importert.
4. Hvis statusen til filen din fortsatt er «STAGED» og «numErrors» er større enn null, har filen ikke blitt importert, og du kan bruke endepunktet Retrieve errors for å hente feilmeldingene som oppsto.

Feilsøking

Hvis du ikke kan sende noen forespørsler til API-et (401 Uautorisert feil)

• Sjekk at du har brukt riktig URL-prefiks for plasseringen til Workiva-arbeidsområdet ditt.
• Sjekk at du bruker riktig klient-ID og hemmelighet i forespørselen din uten mellomrom før eller etter.

Autentisering fungerer, men påfølgende forespørsler fungerer ikke (404- eller 500-feil)

• Sjekk at brukeren som er angitt i API-tildelingen du har opprettet, har tilgang til den angitte Wdata-tabell-ID-en.
• Sjekk at Wdata-tabellen er i samme arbeidsområde som API-tildelingen.
• Sjekk at du bruker riktige fil-ID-er uten mellomrom før eller etter.
• Sjekk at overskriftene dine, spesielt «Content-Type», samsvarer med dokumentasjonen.

Filen min lastes opp uten problemer, men det oppstår feil ved import

• Sjekk at du har angitt riktig skilletegn.
• Sørg for at dataene i filen er i et flatt filformat med overskriftene i rad 1 fra kolonne A og dataene i rad 2 fra kolonne A.
• Sørg for at antallet overskriftskolonner samsvarer med antallet datakolonner.
• Sjekk at datatypene samsvarer med de som er angitt i Wdata-tabelloppsettet.
• Hent feil relatert til filimport for videre feilsøking