Kommandoene i denne artikkelen brukes med Workiva Chains-kontakten. For å finne kjede-ID-ene dine, se denne artikkelen på for å finne ID-er i Workiva.
Kobling til Workiva Rest API
Hvis ikke annet er angitt, må du stille inn verdien slik at den samsvarer med Appspot.
| Inndata | Type | AppSpot | Detaljer |
| Base URL | Tekstfelt | Prod (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Base URL | Tekstfelt | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| Base URL | Tekstfelt | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Utfør kjeden
Kjører en kjede og venter på at den skal fullføres.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-startchain/
Merk: Selv om denne kommandoen kan brukes når det er behov for en dynamisk kjede-ID, anbefaler vi i de fleste tilfeller å bruke en Run Chain-hendelse. Run Chain-hendelsen er tettere knyttet til kjeden som kjøres, og gir en enklere brukeropplevelse.
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til miljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
| Kjøretidsvariabler | GroupField | Verdiene for kjøretidsvariablene som brukes i kjeden. |
| Poll-intervaller | NumberField | Valgfritt: Tiden (i sekunder) som skal ventes før det sjekkes om kjeden er fullført. Standardinnstillingen er fem sekunder, og den bør bare justeres hvis du forventer at kjedet skal kjøre lenge. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Finn kjedeløp etter inngangsverdi
Henter alle kjedekjøringer som inneholder den oppgitte teksten.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til miljøet du søker etter. |
| Søk i tekst | Tekstfelt | Inngangsverdien det skal søkes etter. |
| Maksimale resultater | NumberField | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementer. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få kjede
Henter egenskaper for en kjede.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getchain/
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
Utganger
| Utdata | Utgangstype |
| Kjede | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 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/
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
Utganger
| Utdata | Utgangstype |
| Kommandoer | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få kjedehistorikk
Henter de historiske kjedekjøringene for en kjede.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
| Kjede-ID | Tekstfelt | ID-en til kjeden. |
| Maksimale resultater | NumberField | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementer. |
| Startdato | Tekstfelt | Filtrerer kjedekjøringer som har skjedd etter den angitte startdatoen. Denne verdien kan være i ISO8601-format eller et Unix-tidsstempel. |
| Sluttdato | Tekstfelt | Filtrerer kjedekjøringer som skjedde før den angitte sluttdatoen. Denne verdien kan være i ISO8601-format eller et Unix-tidsstempel. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få Chain Run
Få informasjon om en kjedekjøring.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getchainrun/
Innganger
| Inndata | Type | Detaljer |
| ID for kjedeløp | Tekstfelt | ID-en til kjedekjøringen. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få kjedekjøring med noder
Få informasjon om en kjedekjøring, inkludert nodeopplysninger.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Innganger
| Inndata | Type | Detaljer |
| ID for kjedeløp | Tekstfelt | ID-en til kjedekjøringen. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 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/
Innganger
| Inndata | Type | Detaljer |
| Miljø-ID | Tekstfelt | ID-en til målmiljøet. |
Utganger
| Utdata | Utgangstype |
| Kjeder | Fil |
| Antall kjeder | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få miljø
Henter egenskaper for et bestemt miljø.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getenvironment/
Innganger
| Inndata | Type | Detaljer |
| ID for arbeidsområdet | 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 | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Få miljøer
Henter en liste over miljøer i et arbeidsområde.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getenvironments/
Innganger
| Inndata | Type | Detaljer |
| ID for arbeidsområdet | Tekstfelt | ID-en til arbeidsområdet som inneholder miljøene. |
Utganger
| Utdata | Utgangstype |
| Miljøer | Fil |
| Antall miljøer | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Hent arbeidsområdet
Henter et arbeidsområde og dets egenskaper.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getworkspace/
Innganger
| Inndata | Type | Detaljer |
| ID for arbeidsområdet | Tekstfelt | ID-en til arbeidsområdet. |
Utganger
| Utdata | Utgangstype |
| Arbeidsområde | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Hent arbeidsområder
Henter en liste over alle arbeidsområder for et selskap.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Innganger
Ingen
Utganger
| Utdata | Utgangstype |
| Arbeidsområder | Fil |
| Antall arbeidsområder | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Publiser kartleggingsgruppe
Publiserer en mappingsgruppe, som spesifisert av Mapping Group GUID.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-publish/
Innganger
| Inndata | Type | Detaljer |
| Mapping Group GUID | Tekstfelt | GUID-en til kartleggingsgruppen. |
Utganger
Ingen
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Søk etter kjedeløp
Søker etter kjedekjøringer som samsvarer med de angitte filtrene.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Merk: Parameteren environment_id er ikke nødvendig for superbrukere eller org-administratorer.
Innganger
| Inndata | Type | Detaljer |
| Filtre | GroupField | Filtrene som skal brukes på søket. |
| Maksimale resultater | NumberField | Maksimalt antall resultater som skal hentes. Bruk 0 for å hente alle elementer. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
| Antall kjedeløp | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Stopp kjede
Stopper en Chain som kjører for øyeblikket.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-stopchain/
Innganger
| Inndata | Type | Detaljer |
| ID for kjedeløp | Tekstfelt | ID-en til kjeden som kjøres for å stoppe. |
Utganger
| Utdata | Utgangstype |
| Kjedeløp | Fil |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |
Last opp mappingsregler
Laster opp et regelsett for en tilordningsgruppe, som spesifisert av GUID-en for tilordningsgruppen.
Tilsvarende API-kall: https://developers.workiva.com/chains-v1/chains-updaterules/
Innganger
| Inndata | Type | Detaljer |
| Mapping Group GUID | Tekstfelt | GUID-en til kartleggingsgruppen. |
| Opplastingsmodus | Nedtrekksfelt | Opplastingsmodus. Når mode=published, oppdateres og publiseres den gjeldende publiserte versjonen på nytt. Når mode=draft, er det bare utkastet som oppdateres. Når mode=both, oppdateres både den publiserte versjonen og utkastet. |
| Mapping av regelfil | FileField | Filen som inneholder kartleggingsreglene som skal lastes opp. |
Utganger
| Utdata | Utgangstype |
| Feil ved opplasting | Fil |
| Last opp resultat | Fil |
| Antall opplastede regler | Heltall |
| Antall feil | Heltall |
Utgangskoder
| Utgangskode | Type | Detaljer |
| 0 | Vellykket | Vellykket |
| 1 | Feil | Generell svikt |
| 2 | Feil | Autentisering mislyktes |