Workiva Connector-kommandoer bruker Workiva Platform API. Den nåværende versjonen er 2022-01-01, men denne vil bli pensjonert. For å holde kjedene dine i gang, flytter vi alle Workiva-koblingskommandoer til versjon 2026-01-01.
De fleste Workiva Connector-kommandoene flyttes automatisk til 2026-01-01 den 30. november 2026, og du trenger ikke å gjøre noe. Se Workiva Connector: Kommandoer som flyttes til Platform API 2026-01-01 for en fullstendig liste. Kommandoene Kjør rapport og Vis brukere har endringer som krever handling fra din side, så du må velge når du skal bytte dem. Du har frist til 31. oktober 2027 med å gjøre disse endringene. Den dagen vil disse kommandoene bli endret til det nye API-et, og de vil ikke fungere før de er riktig konfigurert.
Valg av API-versjon
Begge kommandoene har nå et API-versjon -felt som lar deg spesifisere 2022 eller 2026. Standardinnstillingen er 2022, så en kommando uten verdi bruker 2022.
Andre endringer
Merk: Navnene på utgangene forblir de samme, så resten av kjeden fortsetter å fungere.
- Kjør rapport eksporterer nå rapporten før den lastes ned. Dette kan ta lengre tid og mislykkes hvis eksporten tar mer enn omtrent 5 minutter. Den bør ikke kjøre i mer enn 10 minutter.
- Listebrukere trenger at omfanget
organization:read inkluderes i OAuth2-tildelingen din.
Hvis du vil ha mer informasjon om API-endringene, inkludert endringer i regnearkkommandoer, kan du se Workivas støtteside Workiva Connector: Kommandoer som flyttes til plattform-API 2026-01-01 .
Kjør rapport
Det som forblir det samme
-
Inndata:Rapport-ID, Forhåndsvisningsinnhold . - Utdata: Rapport CSV-filen.
- Kommandoen fullføres først etter at filen er klar.
Hva endres i 2026-01-01
- Kommandoen starter en eksport av rapporten, sjekker statusen omtrent én gang i sekundet, og laster deretter ned CSV-filen.
- Kjedeloggen vil vise «Kontrollerer operasjonsstatus...», statusen bekreftet , i kø eller startet , og «Operasjon fullført» hvis kommandoen fullføres riktig. Hvis kommandoen ikke fullføres riktig, registreres meldingen «Operasjon mislyktes» i loggen.
- Denne kommandoen kan ta lengre tid å kjøre enn i 2022-01-01-versjonen, ettersom koblingen sjekker eksporten opptil 300 ganger eller maksimalt 10 minutter, avhengig av hva som kommer først. Med én sjekk per sekund er det omtrent 5 minutter. Hvis eksporten ikke er fullført innen da, mislykkes kommandoen.
- Tips: Hvis tidsavbruddet for kjedekommandoen er kortere enn eksporten, øk den slik at filen kan ankomme.
- En feil rapport-ID mislykkes vanligvis med «operasjonen mislyktes».
- Ingen ny tillatelse er nødvendig. OAuth2-tildelingen trenger fortsatt
graph:read .
Bytt en kommando til 2026
- Åpne kjeden og velg kommandoen Kjør rapport .
- Sett API-versjon til 2026 .
- Lagre og kjør kjeden.
- Sjekk at utdataene fra Rapport inneholder dataene du forventer.
Feilsøking
| Melding | Hva du skal gjøre |
|---|---|
forsøksgrensen på 300 overskredet eller tidsgrensen på 10m0s overskredet |
Rapporteksporten ble ikke fullført i tide. Reduser rapportstørrelsen eller filtrene, eller sett kommandoen tilbake til «2022» og kontakt kundestøtte. |
operasjonen mislyktes eller operasjonen ble avbrutt |
Sjekk rapport-ID-en. Hvis det er riktig, kontakt kundestøtte med ID-ene som vises i loggen. |
FEIL: Kan ikke kjøre brukerrapport. |
Sjekk rapport-ID-en og at tilskuddet har graph:read . Meldingen som følger inneholder API-detaljene. |
Liste over brukere
Det som forblir det samme
- Inndata:
Organisasjons-ID . - Utdata: Brukerrapport JSON-filen og Antall poster .
- Brukeren av OAuth2-rettigheter må være en organisasjonsadministrator.
Hva endres i 2026-01-01
- OAuth2-tildelingen som brukes av tilkoblingen må ha omfanget
organization:read . - Uten dette omfanget vil kommandoen mislykkes med en HTML-feil av typen «Uautorisert (401)» eller «Forbudt (403)» i stedet for å returnere en liste over brukere.
Bytt en kommando til 2026
-
En organisasjonssikkerhetsadministrator legger til
organization:readtil API-tildelingen hvis klient-ID er lagret på Workiva-tilkoblingen din:- Klikk på brukerikonet øverst til høyre, velg Admin og deretter Organisasjonsadministrator .
- I menyen til venstre velger du Sikkerhet og deretter fanen Klargjøring .
- Finn tilskuddet og åpne det fra Handlinger -menyen.
- I Omfang velger du
organization:readog lagrer. Klienthemmeligheten forblir den samme.
Merk:
organization:reader et organisasjonsomfang. Den er ikke tilordnet fra arbeidsområdeinnstillingene. For
mer informasjon, se Workiva-støttesiden Opprett og administrer API-tildelinger i organisasjonsadministrasjon . - Åpne kjeden og velg kommandoen Liste over brukere .
- Sett API-versjon til 2026 .
- Lagre og kjør kjeden.
- (Valgfritt, men anbefalt) Registrer verdien Antall oppføringer .
- Endre verdien for API-versjon tilbake til 2022, og kjør kjeden på nytt.
- Bekreft at verdien Antall poster er den samme for begge kjøringene.
Merknader
- Standard API-versjonen er 2022-01-01, som er det en kommando uten verdi vil bruke.
- Nye kommandoer bør settes til 2026.
- Du kan velge 2022 eller 2026 for hver kommandoforekomst av Kjør rapport og List brukere .
- 2022-01-01-versjonen slutter å virke 30. november 2027 . Du må flytte kommandoene dine til 2026 før den datoen.
- Andre grafkommandoer i Workiva Connector flyttes automatisk til 2026-01-01 den 30. november 2026, og du trenger ikke å endre dem.
- JSON-utdataene deres kan liste opp felt og elementer i en annen rekkefølge. Verdiene er de samme.
Feilsøking
| Melding | Hva du skal gjøre |
|---|---|
FEIL: Kan ikke hente brukerrapport. , med status 401 eller 403 i feiltabellen |
Sjekk at API-bevilgningen har organization:read og at brukeren av bevilgningen er en organisasjonsadministrator. Kjør deretter kommandoen på nytt. |
FEIL: Kan ikke hente brukerrapport. , med en annen status |
Sjekk at organisasjons-ID-en er riktig. Feiltabellen inneholder API-detaljene. |
Endringer i regnearkkommandoer
Disse vil også bli automatisk oppdatert, og ingen kjederedigeringer er nødvendig. Innganger og utganger endres ikke, men et par ting fungerer annerledes:
- Slett regneark flytter regnearket til papirkurven i stedet for å slette det permanent.
- Hent arkdata ignorerer revisjonsverdien og returnerer de nyeste dataene med en advarsel.
- Skriv , Overskriv , Fjern arkdata , Oppdater arkmetadata , Publiser regneark og Slett regneark . Vent nå til endringen er fullført, og ignorer innstillingen Bruk asynkron . Disse kommandoene vil mislykkes hvis endringen tar mer enn omtrent 5 minutter.
- Hent arkdata , Skriv arkdata og Overskriv arkdata ignorerer innstillingen Bruk plattform-API .
Hva om jeg ikke gjør noe?
Kommandoer som bruker disse kommandoene vil fortsette å bruke 2022-01-01 frem til 31. oktober 2027 . Etter den datoen vil kommandoer som er satt til 2022-01-01 slutte å virke.
Trenger du hjelp?
Kontakt Workiva-støtte .