Kommandona i den här artikeln används med Workiva Chains-anslutningen. För att hitta dina kedje-ID:n, se den här artikeln om hitta ID:n i Workiva.
Anslutning till Workiva Rest API
Om inget annat anges, ställ in värdet så att det motsvarar din Appspot.
| Ingång | Typ | AppSpot | Detalj |
| Bas URL | Textfält | Prod (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Bas URL | Textfält | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| Bas URL | Textfält | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Utför kedjan
Exekverar en kedja och väntar på att den ska slutföras.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-startchain/
Obs: Även om detta kommando kan användas när ett dynamiskt kedje-ID krävs, rekommenderar vi att du använder Run Chain-händelsen i de flesta fall. Händelsen Run Chain är närmare kopplad till den kedja som körs och ger en enklare användarupplevelse.
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för miljön. |
| Kedje-ID | Textfält | ID för kedjan. |
| Variabler för exekvering | Gruppfält | Värdena för de variabler för exekvering som används i kedjan. |
| Poll-intervall | Nummerfält | Valfritt: Den tid (i sekunder) som ska vänta innan man kontrollerar om kedjan har slutförts. Standardvärdet är fem sekunder, och det bör endast justeras om du förväntar dig att kedjan ska köras under en längre tid. |
Utdata
| Utgång | Typ av utgång |
| Kedjekörning | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hitta kedjekörningar efter ingångsvärde
Hämtar alla kedjekörningar som innehåller den angivna texten.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för den miljö som du söker efter. |
| Sök text | Textfält | Det ingångsvärde som ska sökas efter. |
| Maximala resultat | Nummerfält | Det maximala antalet resultat som ska hämtas. Använd 0 för att hämta alla objekt. |
Utdata
| Utgång | Typ av utgång |
| Kedjan körs | Fil |
| Antal kedjekörningar | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta kedja
Hämtar egenskaper för en kedja.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getchain/
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för målmiljön. |
| Kedje-ID | Textfält | ID för kedjan. |
Utdata
| Utgång | Typ av utgång |
| Kedja | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta kedjekommandon
Hämtar egenskaper för alla kommandon i en kedja.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getcommands/
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för målmiljön. |
| Kedje-ID | Textfält | ID för kedjan. |
Utdata
| Utgång | Typ av utgång |
| Kommandon | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta kedjehistorik
Hämtar de historiska kedjekörningarna för en kedja.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för målmiljön. |
| Kedje-ID | Textfält | ID för kedjan. |
| Maximala resultat | Nummerfält | Det maximala antalet resultat som ska hämtas. Använd 0 för att hämta alla objekt. |
| Startdatum | Textfält | Filtrerar kedjekörningar som inträffat efter det angivna startdatumet. Detta värde kan vara i ISO8601-format eller en Unix-tidsstämpel. |
| Slutdatum | Textfält | Filtrerar kedjekörningar som inträffade före det angivna slutdatumet. Detta värde kan vara i ISO8601-format eller en Unix-tidsstämpel. |
Utdata
| Utgång | Typ av utgång |
| Kedjan körs | Fil |
| Antal kedjekörningar | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Få kedjan att gå
Få detaljerna om en kedjekörning.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getchainrun/
Ingångar
| Ingång | Typ | Detalj |
| ID för kedjekörning | Textfält | ID för kedjekörningen. |
Utdata
| Utgång | Typ av utgång |
| Kedjekörning | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Få kedjan att fungera med noder
Få information om en kedjekörning, inklusive nodinformation.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Ingångar
| Ingång | Typ | Detalj |
| ID för kedjekörning | Textfält | ID för kedjekörningen. |
Utdata
| Utgång | Typ av utgång |
| Kedjekörning | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta kedjor
Hämtar alla kedjor och deras egenskaper i en specifik miljö.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getchains/
Ingångar
| Ingång | Typ | Detalj |
| Miljö-ID | Textfält | ID för målmiljön. |
Utdata
| Utgång | Typ av utgång |
| Kedjor | Fil |
| Antal kedjor | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta miljö
Hämtar egenskaper för en specifik miljö.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getenvironment/
Ingångar
| Ingång | Typ | Detalj |
| ID för arbetsyta | Textfält | ID för arbetsytan där miljön bor. |
| Miljö-ID | Textfält | ID för målmiljön. |
Utdata
| Utgång | Typ av utgång |
| Miljö | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta miljöer
Hämtar en lista över miljöer i en arbetsyta.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getenvironments/
Ingångar
| Ingång | Typ | Detalj |
| ID för arbetsyta | Textfält | ID för den arbetsyta som innehåller miljöerna. |
Utdata
| Utgång | Typ av utgång |
| Miljöer | Fil |
| Antal miljöer | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta arbetsyta
Hämtar en arbetsyta och dess egenskaper.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getworkspace/
Ingångar
| Ingång | Typ | Detalj |
| ID för arbetsyta | Textfält | ID för arbetsytan. |
Utdata
| Utgång | Typ av utgång |
| Arbetsyta | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Hämta arbetsytor
Hämtar en lista över alla arbetsytor för ett företag.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Ingångar
Ingen
Utdata
| Utgång | Typ av utgång |
| Arbetsytor | Fil |
| Antal arbetsytor | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Publicera Mapping Group
Publicerar en mappningsgrupp, enligt specifikationen i Mapping Group GUID.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-publish/
Ingångar
| Ingång | Typ | Detalj |
| Mappningsgrupp GUID | Textfält | GUID för mappningsgruppen. |
Utdata
Ingen
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Sök kedjekörningar
Söker efter kedjekörningar som matchar de angivna filtren.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Obs: Parametern environment_id krävs inte för superanvändare eller org-administratörer.
Ingångar
| Ingång | Typ | Detalj |
| Filter | Gruppfält | De filter som ska tillämpas på sökningen. |
| Maximala resultat | Nummerfält | Det maximala antalet resultat som ska hämtas. Använd 0 för att hämta alla objekt. |
Utdata
| Utgång | Typ av utgång |
| Kedjan körs | Fil |
| Antal kedjekörningar | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Stoppa kedjan
Stoppar en pågående kedja.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-stopchain/
Ingångar
| Ingång | Typ | Detalj |
| ID för kedjekörning | Textfält | ID för den kedjekörning som ska stoppas. |
Utdata
| Utgång | Typ av utgång |
| Kedjekörning | Fil |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |
Ladda upp mappningsregler
Laddar upp en mappningsgrupps regelsamling, enligt specifikationen i mappningsgruppens GUID.
Motsvarande API-anrop: https://developers.workiva.com/chains-v1/chains-updaterules/
Ingångar
| Ingång | Typ | Detalj |
| Mappningsgrupp GUID | Textfält | GUID för mappningsgruppen. |
| Uppladdningsläge | Rullgardinsfält | Uppladdningsläge. När mode=published uppdateras och återpubliceras den aktuella publicerade versionen. När mode=draft uppdateras endast utkastet. När mode=both uppdateras både den publicerade versionen och utkastet. |
| Fil för mappningsregel | Filfält | Den arkivering som innehåller de mappningsregler som ska laddas upp. |
Utdata
| Utgång | Typ av utgång |
| Fel vid uppladdning | Fil |
| Ladda upp resultat | Fil |
| Antal uppladdade regler | Heltal |
| Antal fel | Heltal |
Utgångskoder
| Utgångskod | Typ | Detalj |
| 0 | Lyckades | Lyckades |
| 1 | Fel | Allmänt misslyckande |
| 2 | Fel | Autentiseringen gick inte |