De commando's in dit artikel worden gebruikt met de Workiva Chains connector . Om uw keten-ID's te vinden, bekijk dit artikel over het vinden van ID's in Workiva .
Connector naar de Workiva REST API
Tenzij anders aangegeven, dient u de waarde in te stellen die overeenkomt met uw Appspot.
| Invoer | type | AppSpot | Details |
| Basis-URL | Tekstveld | Prod (VS) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstveld | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstveld | Prod-CA | https://h.ca.wdesk.com/s/wdata/oc/api/ |
| Basis-URL | Tekstveld | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
Voer keten uit
Voert een keten uit en wacht tot deze is voltooid.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-startchain/
Opmerking : Hoewel deze opdracht kan worden gebruikt wanneer een dynamische keten-ID vereist is, raden we in de meeste gevallen aan om een Run Chain-gebeurtenis te gebruiken. De Run Chain-gebeurtenis is nauwer verbonden met de uit te voeren keten en biedt een eenvoudigere gebruikerservaring.
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de omgeving. |
| Ketting-ID | Tekstveld | De ID van de keten. |
| Runtimevariabelen | Groepsveld | De waarden voor de runtime-variabelen die in de keten worden gebruikt. |
| Peilinginterval | Nummerveld | Optioneel : De hoeveelheid tijd (in seconden) die moet worden gewacht voordat wordt gecontroleerd of de keten is voltooid. Dit staat standaard op vijf seconden en moet alleen worden aangepast als u verwacht dat uw ketting langdurig zal draaien. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingloop | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Zoek kettingreeksen op basis van de invoerwaarde
Haalt alle reeksen op die de opgegeven tekst bevatten.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de omgeving waarnaar u zoekt. |
| Zoektekst | Tekstveld | De invoerwaarde waarnaar gezocht moet worden. |
| Maximale resultaten | Nummerveld | Het maximale aantal resultaten dat moet worden opgehaald. Gebruik 0 om alle items op te halen. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingruns | Bestand |
| Aantal kettingruns | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Pak de ketting
Haalt eigenschappen op voor een keten.
Gelijkwaardige API-aanroep: https://developers.workiva.com/chains-v1/chains-getchain/
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de doelomgeving. |
| Ketting-ID | Tekstveld | De ID van de keten. |
Uitgangen
| Uitvoer | Uitvoertype |
| Ketting | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Krijg kettingopdrachten
Haalt de eigenschappen op voor alle opdrachten in een reeks.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getcommands/
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de doelomgeving. |
| Ketting-ID | Tekstveld | De ID van de keten. |
Uitgangen
| Uitvoer | Uitvoertype |
| Commando's | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Bekijk de geschiedenis van de keten
Haalt de historische ketenruns voor een keten op.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de doelomgeving. |
| Ketting-ID | Tekstveld | De ID van de keten. |
| Maximale resultaten | Nummerveld | Het maximale aantal resultaten dat moet worden opgehaald. Gebruik 0 om alle items op te halen. |
| Startdatum | Tekstveld | Filters tonen reeksen die na de opgegeven startdatum hebben plaatsgevonden. Deze waarde kan de ISO8601-indeling of een Unix-tijdstempel gebruiken. |
| Einddatum | Tekstveld | Filterketens die vóór de opgegeven einddatum zijn uitgevoerd. Deze waarde kan de ISO8601-indeling of een Unix-tijdstempel gebruiken. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingruns | Bestand |
| Aantal kettingruns | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Krijg kettingloop
Vraag de details van een kettingrace op.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getchainrun/
Invoer
| Invoer | type | Details |
| Kettingloop-ID | Tekstveld | De ID van de ketenuitvoering. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingloop | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Chain Run uitvoeren met knooppunten
Bekijk de details van een blockchain-run, inclusief de details van de nodes.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Invoer
| Invoer | type | Details |
| Invoer | type | Details |
| Kettingloop-ID | Tekstveld | De ID van de ketenuitvoering. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingloop | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Pak kettingen
Haalt alle ketens en hun eigenschappen in een specifieke omgeving op.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getchains/
Invoer
| Invoer | type | Details |
| Omgevings-ID | Tekstveld | De ID van de doelomgeving. |
Uitgangen
| Uitvoer | Uitvoertype |
| Chains | Bestand |
| Aantal kettingen | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Ga naar de omgeving
Haalt eigenschappen op voor een specifieke omgeving.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getenvironment/
Invoer
| Invoer | type | Details |
| Werkruimte-ID | Tekstveld | De ID van de werkruimte waar de omgeving zich bevindt. |
| Omgevings-ID | Tekstveld | De ID van de doelomgeving. |
Uitgangen
| Uitvoer | Uitvoertype |
| Omgeving | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Omgevingen verkrijgen
Geeft een lijst weer van de omgevingen in een werkruimte.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getenvironments/
Invoer
| Invoer | type | Details |
| Werkruimte-ID | Tekstveld | De ID van de werkruimte die de omgevingen bevat. |
Uitgangen
| Uitvoer | Uitvoertype |
| Omgevingen | Bestand |
| Aantal omgevingen | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Werkruimte verkrijgen
Haalt een werkruimte en de bijbehorende eigenschappen op.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-getworkspace/
Invoer
| Invoer | type | Details |
| Werkruimte-ID | Tekstveld | De ID van de werkruimte. |
Uitgangen
| Uitvoer | Uitvoertype |
| Werkruimte | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Werkruimtes verkrijgen
Geeft een lijst weer van alle werkplekken voor een bedrijf.
Gelijkwaardige API-aanroep : https://developers.workiva.com/chains-v1/chains-getworkspaces/
Invoer
Geen
Uitgangen
| Uitvoer | Uitvoertype |
| Werkruimtes | Bestand |
| Aantal werkplekken | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Publiceer kaartgroep
Publiceert een toewijzingsgroep, zoals gespecificeerd door de GUID van de toewijzingsgroep.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-publish/
Invoer
| Invoer | type | Details |
| Mappinggroep GUID | Tekstveld | De GUID van de toewijzingsgroep. |
Uitgangen
Geen
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Zoekketenruns
Zoekt naar ketenruns die overeenkomen met de opgegeven filters.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Opmerking : De parameter environment_id is niet vereist voor supergebruikers of organisatiebeheerders.
Invoer
| Invoer | type | Details |
| Filters | Groepsveld | De filters die op de zoekopdracht moeten worden toegepast. |
| Maximale resultaten | Nummerveld | Het maximale aantal resultaten dat moet worden opgehaald. Gebruik 0 om alle items op te halen. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingruns | Bestand |
| Aantal kettingruns | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Stopketting
Stopt een actieve keten.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-stopchain/
Invoer
| Invoer | type | Details |
| Kettingloop-ID | Tekstveld | De ID van de keten die moet worden gestopt. |
Uitgangen
| Uitvoer | Uitvoertype |
| Kettingloop | Bestand |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Toewijzingsregels uploaden
Uploadt een set regels voor een toewijzingsgroep, zoals gespecificeerd door de GUID van de toewijzingsgroep.
Equivalent API call : https://developers.workiva.com/chains-v1/chains-updaterules/
Invoer
| Invoer | type | Details |
| Mappinggroep GUID | Tekstveld | De GUID van de toewijzingsgroep. |
| Uploadmodus | Vervolgkeuzeveld | De uploadmodus. Wanneer mode=published , wordt de momenteel gepubliceerde versie bijgewerkt en opnieuw gepubliceerd. Wanneer mode=draft , wordt alleen het concept bijgewerkt. Wanneer mode=both , worden zowel de gepubliceerde versie als het concept bijgewerkt. |
| Mappingregelbestand | Bestandsveld | Het bestand met de toewijzingsregels dat geüpload moet worden. |
Uitgangen
| Uitvoer | Uitvoertype |
| Uploadfouten | Bestand |
| Resultaat uploaden | Bestand |
| Aantal geüploade regels | Geheel getal |
| Aantal fouten | Geheel getal |
Uitgangscodes
| Uitgangscode | type | Details |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |