Kommandoene i denne artikkelen brukes med Workiva Chains-koblingen . For å finne kjede-ID-ene dine, se denne artikkelen om å finne ID-er i Workiva .
Kobling til Workiva Rest API
Med mindre annet er angitt, angi verdien slik at den samsvarer med Appspot-en din.
| Inndata | Type | AppSpot | Detalj |
| Basis-URL | Tekstfelt | Prod. (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstfelt | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstfelt | Prod-CA | https://h.ca.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstfelt | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
Utfør kjede
Utfører en kjede og venter på at den skal fullføres.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-startchain/
Merknad : Selv om denne kommandoen kan brukes når en dynamisk kjede-ID er nødvendig, anbefaler vi å bruke en Run Chain-hendelse i de fleste tilfeller. Run Chain-hendelsen er tettere knyttet til kjeden som kjøres, og gir en enklere brukeropplevelse.
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til miljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
| Kjøretidsvariabler | Gruppefelt | Verdiene for kjøretidsvariablene som brukes i kjeden. |
| Avstemningsintervall | Nummerfelt | Valgfritt : Hvor lang tid (i sekunder) det skal ventes før det kontrolleres om kjeden er fullført. Standardinnstillingen er fem sekunder, og den bør bare justeres hvis du forventer at kjedet skal gå lenge. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Finn kjedekjøringer etter inngangsverdi
Henter alle kjedeløp som inneholder den oppgitte teksten.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til miljøet du søker etter. |
| Søketekst | Tekstfelt | Inndataverdien som skal søkes etter. |
| Maksimale resultater | Nummerfelt | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementene. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Få kjede
Henter egenskaper for en kjede.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getchain/
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
Utganger
| Utdata | Utgangstype |
| Kjede | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Få kjedekommandoer
Henter egenskaper for alle kommandoer i en kjede.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getcommands/
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
Utganger
| Utdata | Utgangstype |
| Kommandoer | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Hent kjedehistorikk
Henter de historiske kjedekjøringene for en kjede.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
| Maksimale resultater | Nummerfelt | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementene. |
| Startdato | Tekstfelt | Filtrerer kjedekjøringer som skjedde etter den angitte startdatoen. Denne verdien kan bruke ISO8601-format eller et Unix-tidsstempel. |
| Sluttdato | Tekstfelt | Filtrerer kjedekjøringer som skjedde før den angitte sluttdatoen. Denne verdien kan bruke ISO8601-format eller et Unix-tidsstempel. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Få kjedekjøring
Få detaljene om en kjedekjøring.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getchainrun/
Inndata
| Inndata | Type | Detalj |
| Kjedekjørings-ID | Tekstfelt | ID-en til kjedekjøringen. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Få kjedekjøring med noder
Få detaljene om en kjedekjøring, inkludert nodedetaljene.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Inndata
| Inndata | Type | Detalj |
| Inndata | Type | Detalj |
| Kjedekjørings-ID | Tekstfelt | ID-en til kjedekjøringen. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Få kjeder
Henter alle kjeder og deres egenskaper i et bestemt miljø.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getchains/
Inndata
| Inndata | Type | Detalj |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
Utganger
| Utdata | Utgangstype |
| Kjeder | Fil |
| Antall kjeder | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Hent miljø
Henter egenskaper for et bestemt miljø.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getenvironment/
Inndata
| Inndata | Type | Detalj |
| Arbeidsområde-ID | Tekstfelt | ID-en til arbeidsområdet der miljøet befinner seg. |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
Utganger
| Utdata | Utgangstype |
| Miljø | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Hent miljøer
Henter en liste over miljøer i et arbeidsområde.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getenvironments/
Inndata
| Inndata | Type | Detalj |
| Arbeidsområde-ID | Tekstfelt | ID-en til arbeidsområdet som inneholder miljøene. |
Utganger
| Utdata | Utgangstype |
| Miljøer | Fil |
| Antall miljøer | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Skaff deg arbeidsområde
Henter et arbeidsområde og dets egenskaper.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getworkspace/
Inndata
| Inndata | Type | Detalj |
| Arbeidsområde-ID | Tekstfelt | ID-en til arbeidsområdet. |
Utganger
| Utdata | Utgangstype |
| Arbeidsområde | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Skaff deg arbeidsområder
Henter en liste over alle arbeidsområder for et selskap.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-getworkspaces/
Inndata
Ingen
Utganger
| Utdata | Utgangstype |
| Arbeidsområder | Fil |
| Antall arbeidsområder | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Publiser kartleggingsgruppe
Publiserer en tilordningsgruppe, som angitt av tilordningsgruppens GUID.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-publish/
Inndata
| Inndata | Type | Detalj |
| GUID for kartleggingsgruppe | Tekstfelt | GUID-en til tilordningsgruppen. |
Utganger
Ingen
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Søk etter kjedeløp
Søker etter kjedeløp som samsvarer med de gitte filtrene.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Merknad : Parameteren environment_id er ikke nødvendig for superbrukere eller organisasjonsadministratorer.
Inndata
| Inndata | Type | Detalj |
| Filtre | Gruppefelt | Filtrene som skal brukes på søket. |
| Maksimale resultater | Nummerfelt | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementene. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Stoppkjede
Stopper en kjede som kjører.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-stopchain/
Inndata
| Inndata | Type | Detalj |
| Kjedekjørings-ID | Tekstfelt | ID-en til kjeden som skal stoppes. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |
Opplastingstilordningsregler
Laster opp et regelsett for tilordningsgruppen, som angitt av tilordningsgruppens GUID.
Tilsvarende API-kall : https://developers.workiva.com/chains-v1/chains-updaterules/
Inndata
| Inndata | Type | Detalj |
| GUID for kartleggingsgruppe | Tekstfelt | GUID-en til tilordningsgruppen. |
| Opplastingsmodus | Nedtrekksfelt | Opplastingsmodus. Når mode=published , oppdateres og publiseres den gjeldende publiserte versjonen på nytt. Når mode=draft , oppdateres bare utkastet. Når mode=both , oppdateres både den publiserte versjonen og utkastet. |
| Fil med kartleggingsregel | Filfelt | Filen som inneholder kartleggingsreglene som skal lastes opp. |
Utganger
| Utdata | Utgangstype |
| Opplastingsfeil | Fil |
| Last opp resultat | Fil |
| Antall opplastede regler | Heltall |
| Antall feil | Heltall |
Utgangskoder
| Utgangskode | Type | Detalj |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell feil |
| 2 | Feil | Autentisering mislyktes |