De commando's in dit artikel worden gebruikt met de Workiva Chains connector. Bekijk dit artikel op om uw keten-ID's te vinden in Workiva.
Connector naar de Workiva Rest API
Stel de waarde zo in dat deze overeenkomt met uw Appspot, tenzij anders aangegeven.
| Ingang | type | AppSpot | Detail |
| Basis URL | Tekstveld | Prod (VS) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| Basis URL | Tekstveld | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| Basis URL | Tekstveld | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Keten uitvoeren
Voert een ketting uit en wacht tot deze voltooid is.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-startchain/
Opmerking: Hoewel deze opdracht kan worden gebruikt wanneer een dynamische keten-ID nodig is, raden wij in de meeste gevallen aan om een Run Chain event te gebruiken. De gebeurtenis Run Chain is nauwer verbonden met de keten die wordt uitgevoerd en biedt een eenvoudigere gebruikerservaring.
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | De ID van de omgeving. |
| Ketting ID | Tekstveld | Het ID van de ketting. |
| Runtime-variabelen | Groepsveld | De waarden voor de runtimevariabelen die in de ketting worden gebruikt. |
| Interval Poll | Getallenveld | Optioneel: De hoeveelheid tijd (in seconden) die moet worden gewacht voordat wordt gecontroleerd of de ketting is voltooid. Deze staat standaard op vijf seconden, en moet alleen aangepast worden als u verwacht dat uw ketting lange tijd zal lopen. |
Uitgangen
| Uitgang | Type uitgang |
| Kettingloop | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Zoek ketens op ingangswaarde
Haalt alle kettingruns op die de opgegeven tekst bevatten.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | Het ID van de Omgeving waarin u zoekt. |
| Zoek tekst | Tekstveld | De invoerwaarde waarnaar gezocht moet worden. |
| Maximale resultaten | Getallenveld | Het maximum aantal op te halen resultaten. Gebruik 0 om alle items op te halen. |
Uitgangen
| Uitgang | Type uitgang |
| Ketting loopt | Bestand |
| Aantal Kettinggangen | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Ketting krijgen
Haalt eigenschappen op voor een keten.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getchain/
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | Het ID van de doelomgeving. |
| Ketting ID | Tekstveld | Het ID van de ketting. |
Uitgangen
| Uitgang | Type uitgang |
| Ketting | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Kettingcommando's krijgen
Haalt eigenschappen op voor alle opdrachten in een keten.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getcommands/
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | Het ID van de doelomgeving. |
| Ketting ID | Tekstveld | Het ID van de ketting. |
Uitgangen
| Uitgang | Type uitgang |
| Opdrachten | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Krijg Kettinggeschiedenis
Haalt de historische kettingruns voor een keten op.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | Het ID van de doelomgeving. |
| Ketting ID | Tekstveld | Het ID van de ketting. |
| Maximale resultaten | Getallenveld | Het maximum aantal op te halen resultaten. Gebruik 0 om alle items op te halen. |
| Startdatum | Tekstveld | Filtert kettingruns die plaatsvonden na de opgegeven begindatum. Deze waarde kan het ISO8601 formaat of een Unix tijdstempel gebruiken. |
| Einddatum | Tekstveld | Filtert Kettingruns die vóór de opgegeven einddatum plaatsvonden. Deze waarde kan het ISO8601 formaat of een Unix tijdstempel gebruiken. |
Uitgangen
| Uitgang | Type uitgang |
| Ketting loopt | Bestand |
| Aantal Kettinggangen | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Kettingloop krijgen
Verkrijg de details van een kettingloop.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getchainrun/
Ingangen
| Ingang | type | Detail |
| Kettingloop ID | Tekstveld | Het ID van de kettingloop. |
Uitgangen
| Uitgang | Type uitgang |
| Kettingloop | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Ketting uitvoeren met knooppunten
Verkrijg de details van een uitgevoerde ketting, inclusief de details van het knooppunt.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Ingangen
| Ingang | type | Detail |
| Kettingloop ID | Tekstveld | Het ID van de kettingloop. |
Uitgangen
| Uitgang | Type uitgang |
| Kettingloop | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Kettingen krijgen
Haalt alle ketens en hun eigenschappen in een specifieke omgeving op.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getchains/
Ingangen
| Ingang | type | Detail |
| Milieu-ID | Tekstveld | Het ID van de doelomgeving. |
Uitgangen
| Uitgang | Type uitgang |
| Kettingen | Bestand |
| Aantal kettingen | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Milieu krijgen
Haalt eigenschappen op voor een specifieke omgeving.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getenvironment/
Ingangen
| Ingang | type | Detail |
| Werkruimte-ID | Tekstveld | Het ID van de werkruimte waar de omgeving zich bevindt. |
| Milieu-ID | Tekstveld | Het ID van de doelomgeving. |
Uitgangen
| Uitgang | Type uitgang |
| Milieu | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Omgevingen krijgen
Haalt een lijst van Omgevingen in een werkruimte op.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getenvironments/
Ingangen
| Ingang | type | Detail |
| Werkruimte-ID | Tekstveld | Het ID van de werkruimte die de omgevingen bevat. |
Uitgangen
| Uitgang | Type uitgang |
| Omgevingen | Bestand |
| Aantal omgevingen | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Werkruimte krijgen
Haalt een werkruimte en de eigenschappen ervan op.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getworkspace/
Ingangen
| Ingang | type | Detail |
| Werkruimte-ID | Tekstveld | Het ID van de werkruimte. |
Uitgangen
| Uitgang | Type uitgang |
| Werkruimte | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Werkruimten krijgen
Haalt een lijst van alle werkruimten voor een bedrijf op.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Ingangen
Geen
Uitgangen
| Uitgang | Type uitgang |
| Werkruimten | Bestand |
| Aantal werkplekken | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Groep cartografie publiceren
Publiceert een mappinggroep, zoals gespecificeerd door de Mappinggroep GUID.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-publish/
Ingangen
| Ingang | type | Detail |
| Mapping Groep GUID | Tekstveld | De GUID van de mappinggroep. |
Uitgangen
Geen
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Kettinglopen zoeken
Zoekt naar kettingruns die overeenkomen met de opgegeven filters.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Opmerking: De environment_id parameter is niet vereist voor superusers of org admins.
Ingangen
| Ingang | type | Detail |
| Filters | Groepsveld | De filters die op de zoekopdracht moeten worden toegepast. |
| Maximale resultaten | Getallenveld | Het maximum aantal op te halen resultaten. Gebruik 0 om alle items op te halen. |
Uitgangen
| Uitgang | Type uitgang |
| Ketting loopt | Bestand |
| Aantal Kettinggangen | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Stop Ketting
Stopt een momenteel lopende Chain.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-stopchain/
Ingangen
| Ingang | type | Detail |
| Kettingloop ID | Tekstveld | De ID van de te stoppen kettingloop. |
Uitgangen
| Uitgang | Type uitgang |
| Kettingloop | Bestand |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |
Regels voor toewijzing uploaden
Uploadt een afbeeldingsgroep regelset, zoals gespecificeerd door de afbeeldingsgroep GUID.
Equivalente API-oproep: https://developers.workiva.com/chains-v1/chains-updaterules/
Ingangen
| Ingang | type | Detail |
| Mapping Groep GUID | Tekstveld | De GUID van de mappinggroep. |
| Uploadmodus | Dropdownveld | De uploadmodus. Wanneer mode=published, wordt de huidige gepubliceerde versie bijgewerkt en opnieuw gepubliceerd. Wanneer mode=draft wordt alleen het ontwerp bijgewerkt. Wanneer mode=both, worden zowel de gepubliceerde versie als het ontwerp bijgewerkt. |
| Bestand met toewijzingsregels | Bestandsveld | Het bestand met de mappingregels dat geüpload moet worden. |
Uitgangen
| Uitgang | Type uitgang |
| Fouten bij het uploaden | Bestand |
| Resultaat uploaden | Bestand |
| Aantal geüploade regels | Geheel getal |
| Aantal fouten | Geheel getal |
Afsluitcodes
| Afsluitcode | type | Detail |
| 0 | Succes | Succes |
| 1 | Fout | Algemeen falen |
| 2 | Fout | Authenticatie mislukt |