Workiva kundestøttesenter

Innledning

Denne artikkelen bygger på oppsettet av API-samlingen din, og forklarer hvordan du bruker Workiva API til å eksportere filer fra Workiva. Denne veiledningen gjelder ved eksport:

• Dokumenter som .PDF, .DOCXeller .XHTML
• Regneark som .XLSX, .PDFeller .CSV
• Presentasjoner som .PDF eller .PPTX

Et ekstra alternativ er tilgjengelig for å eksportere native Workiva-filer i .tar.gz -format.

Forutsetninger

Før du fortsetter, må du sørge for at du har fullført alle trinnene i veiledningen Importering av Workiva API-samlinger til Postman .

Autentisering

1. Åpne Postman-arbeidsområdet ditt og sørg for at riktig miljø er valgt.

2. Utvid samlingen IAM-tjenester, åpne mappen OAuth2 og velg Hent et token.

   

3. Klikk på Send for å generere et autentiseringstoken. Tokenet lagres automatisk i miljøvariabelen {{access_token}} og vil bli brukt av alle påfølgende forespørsler.

Merk: Tilgangstokenet utløper etter 600 sekunder (10 minutter). Når den er utløpt, gjenta dette trinnet for å generere en ny token.

Start en fileksport (dokumenter, presentasjoner, regneark)

Dette eksemplet fokuserer på eksport av Workiva-dokumenter som .PDF, .DOCXeller .XHTML. De samme konseptene gjelder når du eksporterer regneark eller presentasjoner.

1. Utvid samlingen Platform API og naviger til Dokumenter → Dokument-ID → Eksporter.
2. Åpne forespørselen Start en dokumenteksport .
3. I fanen Parametere skriver du inn dokument-ID.
4. Oppdater forespørselsteksten for å spesifisere eksportformatet :

   • PDF

     { "pdfOptions": { "includeAlternateRowFill": true, "includeAttachmentLabels": true, "includeComments": true, "includeDraftWatermark": true, "includeHyperlinks": true, "includeLeaderDots": true, "includeTrackChanges": true, "tagForWebAccessibility": true, "useCmykColorspace": true }, "format": "pdf", "sections": [] }

   • DOCX

     { "docxOptions": { "includeLeaderDots": true, "showTableCellShading": true }, "format": "docx", "sections": [] }

   • XHTML

     { "xhtmlOptions": { "editableSimple": true, "editableXhtml": false, "includeExternalHyperlinks": false, "includeHeadersAndFooters": false }, "format": "xhtml", "sections": [] }

5. Send forespørselen om å starte eksporten. Denne prosessen består av tre trinn:

   • Send POST-forespørselen. Svaret inneholder en Location -overskrift som inneholder en URL.

     

   • Send en GET-forespørsel til URL-en i Location -overskriften for å sjekke eksportstatusen og hente ressurs -URL-en når behandlingen er fullført.

     

   • Lag en siste GET-forespørsel ved å bruke ressurs-URL-en for å laste ned den eksporterte filen.

     

Den eksporterte filen kan returneres som binære data. Dette er forventet oppførsel. Bare lagre filen med riktig filtypenavn (for eksempel .pdf, .docxeller .xhtml).

Deretter kan du se hvordan du importerer en fil ved hjelp av API-samlingen.