I comandi di questo articolo sono utilizzati con il connettore catene di Workiva. Per trovare gli ID della tua catena, consulta l'articolo trovare gli ID in Workiva.
Connettore all'API Rest di Workiva
Se non diversamente indicato, imposta il valore in modo che corrisponda al tuo Appspot.
| Input | Tipo | AppSpot | Dettaglio |
| URL di base | TextField | Prod (USA) | https://h.app.wdesk.com/s/wdata/oc/api/ |
| URL di base | TextField | Prod-EU | https://h.eu.wdesk.com/s/wdata/oc/api/ |
| URL di base | TextField | Prod-APAC | https://h.apac.wdesk.com/s/wdata/oc/api/ |
Esegui catena
Esegue una catena e attende che venga completata.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-startchain/
Nota: anche se questo comando può essere utilizzato quando è richiesto un ID catena dinamico, nella maggior parte dei casi si consiglia di utilizzare un evento Esegui catena. L'evento Esegui catena è più strettamente legato alla catena in esecuzione e offre un'esperienza utente più semplice.
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente. |
| ID catena | TextField | L'ID della catena. |
| Variabili di runtime | GroupField | I valori delle variabili di runtime utilizzate nella catena. |
| Intervallo di polling | NumberField | Opzionale: il tempo di attesa (in secondi) prima di verificare se la catena è stata completata. L'impostazione predefinita è di cinque secondi e deve essere regolata solo se prevedi che la tua catena funzioni per molto tempo. |
Output
| Output | Tipo di output |
| Esecuzione catena | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Trova le esecuzioni della catena per valore di input
Recupera tutte le esecuzioni che contengono il testo fornito.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-chaininputssearch/
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente che stai cercando. |
| Cerca testo | TextField | Il valore di input da ricercare. |
| Risultati massimi | NumberField | Il numero massimo di risultati da recuperare. Usa 0 per recuperare tutti gli elementi. |
Output
| Output | Tipo di output |
| Esecuzioni catena | File |
| Numero di esecuzioni della catena | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni catena
Recupera le proprietà di una catena.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getchain/
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente di destinazione. |
| ID catena | TextField | L'ID della catena. |
Output
| Output | Tipo di output |
| Catena | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni comandi della catena
Recupera le proprietà di tutti i comandi di una catena.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getcommands/
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente di destinazione. |
| ID catena | TextField | L'ID della catena. |
Output
| Output | Tipo di output |
| Comandi | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni cronologia della catena
Recupera lo storico delle esecuzioni di una catena.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-chainrunhistory/
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente di destinazione. |
| ID catena | TextField | L'ID della catena. |
| Risultati massimi | NumberField | Il numero massimo di risultati da recuperare. Usa 0 per recuperare tutti gli elementi. |
| Data di inizio | TextField | Filtra le esecuzioni della catena avvenute dopo la data di inizio specificata. Questo valore può utilizzare il formato ISO8601 o un timestamp Unix. |
| Data di fine | TextField | Filtra le esecuzioni della catena avvenute prima della data di fine specificata. Questo valore può utilizzare il formato ISO8601 o un timestamp Unix. |
Output
| Output | Tipo di output |
| Esecuzioni catena | File |
| Numero di esecuzioni della catena | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni esecuzione della catena
Ottieni i dettagli dell'esecuzione di una catena.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getchainrun/
Input
| Input | Tipo | Dettaglio |
| ID esecuzione catena | TextField | L'ID dell'esecuzione della catena. |
Output
| Output | Tipo di output |
| Esecuzione catena | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni l'esecuzione della catena con i nodi
Ottieni i dettagli di un'esecuzione della catena, compresi i dettagli del nodo.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getchainrunnodes/
Input
| Input | Tipo | Dettaglio |
| ID esecuzione catena | TextField | L'ID dell'esecuzione della catena. |
Output
| Output | Tipo di output |
| Esecuzione catena | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni catene
Recupera tutte le catene e le loro proprietà in un ambiente specifico.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getchains/
Input
| Input | Tipo | Dettaglio |
| ID ambiente | TextField | L'ID dell'ambiente di destinazione. |
Output
| Output | Tipo di output |
| Catene | File |
| Numero di catene | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni ambiente
Recupera le proprietà di un ambiente specifico.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getenvironment/
Input
| Input | Tipo | Dettaglio |
| ID workspace | TextField | L'ID del workspace in cui risiede l'ambiente. |
| ID ambiente | TextField | L'ID dell'ambiente di destinazione. |
Output
| Output | Tipo di output |
| Ambiente | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni ambienti
Recupera un elenco di ambienti in un workspace.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getenvironments/
Input
| Input | Tipo | Dettaglio |
| ID workspace | TextField | L'ID del workspace che contiene gli ambienti. |
Output
| Output | Tipo di output |
| Ambienti | File |
| Numero di ambienti | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni workspace
Recupera un workspace e le sue proprietà.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getworkspace/
Input
| Input | Tipo | Dettaglio |
| ID workspace | TextField | L'ID del workspace. |
Output
| Output | Tipo di output |
| Workspace | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Ottieni workspace
Recupera un elenco di tutti i workspace di un'azienda.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-getworkspaces/
Input
Nessuno
Output
| Output | Tipo di output |
| Workspace | File |
| Numero di workspace | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Pubblica gruppo di mappatura
Pubblica un gruppo di mappatura, come specificato dal GUID del gruppo di mappatura.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-publish/
Input
| Input | Tipo | Dettaglio |
| Gruppo di mappatura GUID | TextField | Il GUID del gruppo di mappatura. |
Output
Nessuno
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Cerca esecuzioni della catena
Cerca le catene che corrispondono ai filtri indicati.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-chainfiltersearch/
Nota: il parametro environment_id non è richiesto per i superutenti o gli amministratori di org.
Input
| Input | Tipo | Dettaglio |
| Filtri | GroupField | I filtri da applicare alla ricerca. |
| Risultati massimi | NumberField | Il numero massimo di risultati da recuperare. Usa 0 per recuperare tutti gli elementi. |
Output
| Output | Tipo di output |
| Esecuzioni catena | File |
| Numero di esecuzioni della catena | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Interrompi catena
Interrompe una catena in esecuzione.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-stopchain/
Input
| Input | Tipo | Dettaglio |
| ID esecuzione catena | TextField | L'ID per l'interruzione dell'esecuzione della catena. |
Output
| Output | Tipo di output |
| Esecuzione catena | File |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |
Carica le regole di mappatura
Carica un set di regole di un gruppo di mappatura, come specificato dal GUID del gruppo di mappatura.
Chiamata API equivalente: https://developers.workiva.com/chains-v1/chains-updaterules/
Input
| Input | Tipo | Dettaglio |
| Gruppo di mappatura GUID | TextField | Il GUID del gruppo di mappatura. |
| Modalità di caricamento | DropdownField | La modalità di caricamento. Nel caso mode=published, la versione attualmente pubblicata viene aggiornata e ripubblicata. Nel caso mode=draft, viene aggiornata solo la bozza. Nel caso mode=both, vengono aggiornate sia la versione pubblicata che la bozza. |
| File di regole di mappatura | FileField | Il file contenente le regole di mappatura da caricare. |
Output
| Output | Tipo di output |
| Errori di caricamento | File |
| Risultato del caricamento | File |
| Numero di regole caricate | Numero intero |
| Numero di errori | Numero intero |
Codici di uscita
| Codice di uscita | Tipo | Dettaglio |
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Guasto generico |
| 2 | Errore | Autenticazione non riuscita |