Per automatizzare le attività all'interno della piattaforma Workiva come parte di una catena, ad esempio per consentire lo scambio di dati con altre fonti di dati, aggiungi una fase che includa un comando di connessione a Workiva.
Per abilitare questi comandi, un amministratore IT deve innanzitutto impostare un connettore Workiva.
Cancella i dati del foglio
Per cancellare tutti i dati di un foglio, usa il comando Cancella dati foglio.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/updatelegacyspreadsheetdataasync.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio da cancellare. |
| ID/nome del foglio | Inserisci il nome o l'identificativo univoco del foglio da cancellare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea un file
Per caricare un file CSV (comma-separated values), JSON (Javascript object notation) o ZIP compresso ed elencarne i record, utilizza il comando Crea file. Puoi anche caricare l'URL del file, ad esempio un URL firmato Amazon S3® di un file in un bucket S3.
- Se si tratta di un file JSON, deve avere un singolo record JSON per riga: un file JSON è una serie di oggetti JSON delimitati da un carattere newline.
- Se si tratta di un file ZIP, deve contenere un singolo file CSV o JSON, il cui nome viene utilizzato per denominare il file importato. Scaricando di nuovo il file si scarica la fonte..
- Se si tratta di un URL, l'endpoint effettua una richiesta per ottenere un file utilizzando una semplice richiesta non autenticata
OTTIENI.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-uploadfile/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'ID della tabella di cui elencare i file. |
| File | Inserisci il file da caricare. Ignorato se viene inserito Scarica l'URL. Nota: il file deve avere un'estensione .CSV o .JSON, oppure essere un file ZIP che contiene un file con estensione .CSV o .JSON. |
| Nome | Se viene inserito Scarica URL, inserisci il nome del file da caricare; per impostazione predefinita, il nome base di Scarica URL. |
| Scarica l'URL | Inserisci l'URL che punta al file da scaricare, ad esempio un URL firmato da Amazon S3. Opzionale se viene inserito il file. Nota: il comando effettua una semplice richiesta |
Output
| Output | Tipo di output |
|---|---|
| Risultati | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea nuove modifiche ai record
Per creare nuove modifiche ai record in base alle proprietà fornite, usa il comando Crea nuove modifiche ai record. Ogni modifica richiede almeno un'operazione e un targetId.
Limite: Possono essere elaborate fino a 1000 modifiche per richiesta.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-createedits/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Operazione |
Seleziona l'operazione da eseguire. Opzioni:
|
| Etichetta | Inserisci un'etichetta che descriva la relazione tra i due record. Serve per creare o eliminare una relazione. |
| Proprietà | Inserisci le proprietà relative al tipo di record. Si usa per creare un record o per impostarne le proprietà. |
| ID del record | Inserisci l'ID o l'ID temporaneo del record della fonte. Serve per creare o eliminare una relazione. |
| ID destinazione | Inserisci l'ID del record di destinazione. Se crei un record, puoi usare l'ID del record o l'ID del record temporaneo; se cancelli un record, devi usare l'ID del record effettivo. |
| ID del record temporaneo | Inserisci l'ID temporaneo che verrà utilizzato durante la creazione di un record; questo ID temporaneo viene sostituito al momento dell'elaborazione. Puoi utilizzare questo ID all'interno della stessa richiesta per creare relazioni tra i record creati. |
| Tipo | Inserisci il tipo di record da creare. |
Output
| Output | Tipo di output |
|---|---|
| Vista pivot | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea una vista pivot
Per creare una nuova vista Wdata in base alla query e al risultato della stessa, usa il comando Crea vista pivot.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-createpivotview/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Nome | Inserisci un nome univoco per identificare la vista. |
| ID della query | Inserisci l'ID della query da cui creare la vista. |
| ID del risultato della query | Inserisci l'ID del risultato della query da cui creare la vista. |
| Metadati aggiuntivi | Inserisci i metadati definiti dall'utente da allegare alla vista come oggetto JSON (opzionale). |
Output
| Output | Tipo di output |
|---|---|
| Vista pivot | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea una query di anteprima
Per creare una query temporanea di anteprima su una tabella che possa poi essere eseguita, usa il comando Crea query di anteprima.
Chiamata API equivalente: N/D
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'ID della tabella da interrogare. |
| Limite | Inserisci il numero massimo di risultati da restituire. |
| File | Se specificato, inserisci il nome del file della tabella da interrogare. |
Output
| Output | Tipo di output |
|---|---|
| Query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea query
Per creare una nuova query Wdata, usa il comando Crea query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-createquery/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Nome | Inserisci un nome univoco per identificare la query. |
| Descrizione | Inserisci una descrizione della query. |
| ID risultato primario | Se specificato, inserisci l'ID del risultato predefinito da popolare con i risultati della query. |
| Testo della query | Inserisci la definizione della query con la sintassi di Presto SQL, come faresti nell'editor SQL della query. |
| Temporanea | Per generare temporaneamente la query in modo che non appaia nel workspace, seleziona questa casella. |
| Parametri | Inserisci i parametri necessari per eseguire la query. |
Output
| Output | Tipo di output |
|---|---|
| Query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea record
Questo comando è disponibile solo attraverso l'API della piattaforma. Per creare un nuovo record, utilizza l'endpoint Crea nuovo record.
Crea elenco di selezione
Per creare un elenco di valori per un parametro di query multi-selezione, usa il comando Crea elenco di selezione.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-createselectlist/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Nome | Inserisci un nome unico per identificare l'elenco di selezione. |
| Descrizione | Per identificare ulteriormente l'elenco selezionato, inserisci una descrizione dei suoi valori o parametri. |
| Tipo di valore | Seleziona il tipo di dati dei valori dell'elenco, ad esempio stringa o numero intero. |
| Valori | Inserisci i valori dell'elenco. |
Output
| Output | Tipo di output |
|---|---|
| Crea metadati dell'elenco di selezione | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore |
Errore |
Crea foglio
Per aggiungere un nuovo foglio a un foglio di calcolo, usa il comando Crea foglio.
Chiamata API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-createsheet/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo a cui aggiungere il foglio. |
| Nome | Inserisci un nome univoco per identificare il foglio. |
| Indice dei fogli | Inserisci l'indice del nuovo foglio all'interno del foglio di calcolo. Nota: per impostazione predefinita, il comando aggiunge il foglio come foglio superiore. |
| ID foglio genitore | Inserisci l'ID del foglio genitore con cui creare il foglio. Per aggiungere al foglio di calcolo principale, lascia in bianco. |
Output
| Output | Tipo di output |
|---|---|
| Metadati del foglio | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea foglio di calcolo
Per creare un nuovo foglio di calcolo, usa il comando Crea foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/createlegacyspreadsheet.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Nome | Inserisci il nome univoco per identificare il foglio di calcolo. |
Output
| Output | Tipo di output |
|---|---|
| Metadati del foglio | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Crea tabella
Per creare una nuova tabella Wdata nel tuo workspace, usa il comando Crea tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-createtable/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Nome | Inserisci un nome univoco per identificare la tabella. |
| Descrizione | Inserisci una descrizione della nuova tabella. |
| Tipo | Seleziona se creare una tabella Dati (o fatto) o Ricerca (o dimensioni ). |
| Colonne | Aggiungi le colonne da includere nella tabella:
|
Output
| Output | Tipo di output |
|---|---|
| Tabella | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elimina file
Per eliminare un file dal workspace di Wdata, usa il comando Elimina file.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletefile/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID file | Inserisci l'ID del file da eliminare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elimina vista pivot
Per eliminare una vista Wdata dal workspace, usa il comando Elimina vista pivot.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletepivotview/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID | Inserisci l'ID della vista da eliminare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Cancella query
Per eliminare una query Wdata dal workspace, usa il comando Elimina query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletequery/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID della query | Inserisci l'ID della query da eliminare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elimina record
Elimina foglio
Per eliminare un foglio e i suoi fogli figli (in modo ricorsivo) da un foglio di calcolo, usa il comando Elimina foglio.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/deletelegacysheet.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio da eliminare. |
| ID/nome del foglio | Inserisci il nome o l'identificativo univoco del foglio da eliminare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elimina foglio di calcolo
Per eliminare un foglio di calcolo dal workspace, usa il comando Elimina foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-deletespreadsheet/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo da eliminare. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elimina tabella
Per eliminare una tabella Wdata dal workspace, usa il comando Elimina tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-deletetable/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'identificatore univoco della tabella da eliminare |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Scarica file
Per scaricare un set di dati dal tuo workspace Wdata, usa il comando Scarica file.
Nota: questo comando non è compatibile con altri tipi di oggetti come fogli di calcolo, tabelle o query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-downloadfile_1/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID file | Inserisci l'ID del file da scaricare. |
Output
| Output | Tipo di output |
|---|---|
| File | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
<!--
Download Pivot View
Downloads the content from a pivot view
Inputs
| Input | Detail |
| ID | Enter the ID of the pivot view to download |
Outputs
| Output | Output Type |
| Pivot View Content | File |
Exit Codes
| Code | Type | Detail |
| 0 | Success | Success |
| 1 | Error | Error |
Download pivot view
To download the contents of a view, use a Download pivot view command.
Properties
| Property | Detail |
|---|---|
| ID | Enter the ID of the view to download. |
Outputs
| Output | Output Type |
|---|---|
| Pivot view content | File |
Exit codes
| Code | Type | Detail |
|---|---|---|
| 0 | Success | Success |
| 1 | Error | Error |
Scarica risultati della query
Per scaricare i risultati di una query Wdata in un file, usa il comando Scarica risultati della query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-downloadqueryresult/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del risultato della query | Inserisci l'ID del risultato della query da scaricare. |
Output
| Output | Tipo di output |
|---|---|
| Risultati della query | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Modifica
Questo comando è disponibile solo attraverso l'API della piattaforma. Per modificare un record, utilizza l'endpoint Crea nuovo record.
Esportazione del file in un foglio di calcolo
Per esportare un set di dati da una tabella Wdata a un foglio elettronico nuovo o esistente, usa il comando Esporta file in un foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportfiletospreadsheets/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID file | Inserisci l'ID del dataset della tabella da esportare. |
| URL del foglio di calcolo | Inserisci l'URL del foglio di calcolo in cui esportare. Per creare un nuovo foglio di calcolo, lascia vuoto. |
Output
| Output | Tipo di output |
|---|---|
| Info sul foglio | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Esportazione dei risultati della query
Per esportare i risultati di una query Wdata in un foglio di calcolo nuovo o esistente, usa il comando Esporta risultati della query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-exportqueryresulttospreadsheets/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del risultato della query | Inserisci l'ID del risultato della query da esportare. |
| URL del foglio di calcolo |
Inserisci l'URL del foglio di calcolo in cui esportare. Per creare un nuovo foglio di calcolo, lascia vuoto. |
| Esportazione come set di dati |
Quando è selezionata, i dati saranno esportati come un set di dati collegati e le celle potranno essere modificate solo aggiornando il set di dati nel foglio di calcolo. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni le proprietà dei file
Per recuperare le proprietà di un file nel tuo workspace Wdata, usa il comando Ottieni proprietà file.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfile/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID file | Inserisci l'ID del file di cui vuoi ottenere le proprietà. |
Output
| Output | Tipo di output |
|---|---|
| Proprietà dei file | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni vista pivot
Per recuperare i metadati di una vista Wdata, usa il comando Ottieni vista pivot.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-getpivotview/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID | Inserisci l'ID della vista pivot da cui ottenere i metadati. |
Output
| Output | Tipo di output |
|---|---|
| Vista pivot | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni i metadati della query
Per recuperare i metadati di una query Wdata, usa il comando Ottieni metadati della query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-getquery/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID della query | Inserisci l'ID della query da cui ottenere i metadati. |
Output
| Output | Tipo di output |
|---|---|
| Query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni record
Questo comando è disponibile solo attraverso l'API della piattaforma. Per ottenere un record, usa l'endpoint Recupera un singolo record.
Ottieni più record
Questo comando è disponibile solo attraverso l'API della piattaforma. Per ottenere più record, utilizza l'endpoint Recupera un elenco di record.
Ottieni report
Per recuperare tutti i report dall'account del database SOX e audit interno della tua organizzazione, usa il comando Ottieni report.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-graphreportexport/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Report | File |
| Conteggio report | Numero intero |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni elenco di selezione
Per recuperare un elenco di valori per un parametro di query multi-selezione basato sull'ID dell'elenco, utilizza il comando Ottieni elenco di selezione.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-getselectlist/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Seleziona l'ID dell'elenco | Inserisci l'identificativo univoco dell'elenco di selezione da recuperare. |
Output
| Output | Tipo di output |
|---|---|
| Ottieni il payload dell'elenco di selezione | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni dati del foglio
Per recuperare tutti i dati in una regione specifica di un foglio, usa il comando Ottieni dati del foglio.
Chiamata API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-getdata/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio da cui prelevare i dati. |
| ID/nome del foglio | Inserisci il nome o l'identificativo univoco del foglio da cui prelevare i dati. |
| Regione | Inserisci la rappresentazione in stile A1 di una cella o di un intervallo, ad esempio [Colonna iniziale][Riga iniziale]:[Colonna di interruzione][Riga di interruzione]. Per avere un intervallo non limitato in una o tutte le direzioni, tralascia la colonna o la riga corrispondente. |
| Stile di valore | Seleziona se restituire il valore grezzo o calcolato della cella. Ad esempio, se il valore di una cella è =1+:1, seleziona Grezzo per =1+1, o Calcolato per il valore calcolato di 2. |
| Revisione | Inserisci la versione del foglio da cui recuperare i dati. Per la versione corrente, inserisci -1. |
| Usa l'API della piattaforma | Quando questa casella è contrassegnata, questo comando restituisce i dati del foglio utilizzando la notazione decimale standard. Se è vuoto, i dati del foglio vengono restituiti utilizzando la notazione scientifica. Questo costringerà il comando a utilizzare l'endpoint Retrieve data from a sheet endpoint piuttosto che l'API del foglio elettronico Return data from a region endpoint. |
Output
| Output | Tipo di output |
|---|---|
| Conteggio delle righe | Numero intero |
| Dati | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni metadati del foglio
Per recuperare i metadati di un foglio in un foglio di calcolo, usa il comando Ottieni metadati del foglio.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/getsheetdata.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio da cui ottenere i metadati. |
| ID/nome del foglio | Inserisci il nome o l'identificativo univoco del foglio da cui ottenere i metadati. |
Output
| Output | Tipo di output |
|---|---|
| Metadati del foglio | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni i metadati del foglio di calcolo
Per recuperare i metadati di un foglio di calcolo, usa il comando Ottieni metadati del foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/getplatformspreadsheetbyid.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo da cui prelevare i metadati. |
Output
| Output | Tipo di output |
|---|---|
| Metadati del foglio di calcolo | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni i metadati della tabella
Per recuperare i metadati di una tabella Wdata, usa il comando Ottieni metadati della tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettable/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'identificativo univoco della tabella da cui prelevare i metadati. |
Output
| Output | Tipo di output |
|---|---|
| Tabella | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Ottieni il tipo
Questo comando è disponibile solo attraverso l'API della piattaforma. Per ottenere un record, usa l'endpoint Recupera un singolo record.
Ottieni più tipi
Questo comando è disponibile solo attraverso l'API della piattaforma. Per ottenere più tipi di record, usa l'endpoint Recupera un elenco di tipi.
<!-- display page content -->
Controllo integrità
Per verificare lo stato di integrità dell'API Wdata, usa il comando Controllo integrità.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-healthcheck/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Risposta | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Importa il file nella tabella
Per importare un file in una tabella Wdata, usa il comando Importa file in una tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfile/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'ID della tabella in cui importare il file. |
| ID file | Inserisci l'ID del file da importare nella tabella. |
| Mapping colonne | Mappa ogni colonna del file con le colonne della tabella. |
| Esegui in modo asincrono | Per fare in modo che il comando venga eseguito in modo asincrono e non attendere il completamento dell'importazione prima di continuare con la catena, seleziona questa casella. |
| Tag | Per includere i metadati con cui la tua organizzazione tiene traccia dei dati, aggiungi dei tag e seleziona i loro nomi e valori. |
Output
| Output | Tipo di output |
|---|---|
| Importazione di file | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Importa foglio di calcolo in una tabella
Per importare un foglio di calcolo in una tabella e restituire un meta-file, usa il comando Importa un foglio di calcolo in una tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-importfromspreadsheets/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'identificativo univoco della tabella in cui importare il file. |
| ID file | Inserisci l'identificativo univoco del file in cui importare il foglio di calcolo (opzionale). |
| Nome del file | Inserisci il nome univoco da assegnare al file al momento dell'importazione nella tabella. |
| URL del foglio di calcolo | Inserisci l'URL completo del foglio di calcolo da cui importare i dati. |
| Esegui in modo asincrono | Per fare in modo che il comando venga eseguito in modo asincrono e non attendere il completamento dell'importazione prima di continuare con la catena, seleziona questa casella. |
| Tag | Per includere i metadati con cui la tua organizzazione tiene traccia dei dati, aggiungi dei tag e seleziona i loro nomi e valori. |
Output
| Output | Tipo di output |
|---|---|
| Importazione di file | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco delle connessioni
Per elencare i dati tra le funzioni della piattaforma Workiva, usa il comando Elenca connessioni.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-listconnections/
| Proprietà | Dettaglio |
|---|---|
| Tipo di fonte | Utilizzando il menu a discesa, seleziona il tipo di file o di elemento da cui prelevare i dati. |
| Tipo di destinazione | Utilizzando il menu a discesa, seleziona il tipo di file o di elemento a cui inviare i dati. |
| ID fonte | Inserisci l'identificativo univoco del file o dell'elemento da cui prelevare i dati. |
| ID di destinazione | Inserisci l'identificativo univoco del file o dell'elemento a cui inviare i dati. |
Nota: la richiesta deve contenere o un Tipo di sorgente + ID sorgente o un Tipo di destinazione + ID destinazione; la richiesta fallirà se una di queste coppie non è presente.
Output
| Output | Tipo di output |
|---|---|
| Connessioni | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco degli errori dei file
Per elencare gli errori associati a un file, ad esempio a causa di un'importazione, usa il comando Elenca errori del file.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-geterrors/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID file | Inserisci l'ID del file per il quale vuoi ottenere gli errori. |
Output
| Output | Tipo di output |
|---|---|
| Elenco degli errori | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco dei file
Per recuperare un elenco di file in una tabella Wdata e i relativi metadati, usa il comando Elenca file.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-getfiles/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'ID della tabella da cui prelevare i file. |
Output
| Output | Tipo di output |
|---|---|
| Elenco dei file | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco delle viste pivot
Per elencare le viste Wdata nel tuo workspace e recuperare i loro metadati, usa il comando Elenca viste pivot.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-listpivotviews/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Viste pivot | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco query
Per elencare le query Wdata nel tuo workspace e recuperare i loro metadati, usa il comando Elenca query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueries/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco dei risultati della query
Per elencare i risultati disponibili di una query Wdata, usa il comando Elenca risultati della query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-listqueryresults/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID della query | Inserisci l'ID della query da cui ottenere i risultati. |
Output
| Output | Tipo di output |
|---|---|
| Risultati della query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco di selezioni
Per una lista di tutti gli elenchi di valori per i parametri di query una multi-selezione nel tuo workspace e per recuperare i loro metadati, usa il comando Elenco di selezioni.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-listselectlists/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Elenco di selezioni | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco di fogli
Per elencare tutti i fogli di un foglio di calcolo e recuperarne i metadati, usa il comando Elenca fogli.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/getlegacysheets.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo di cui elencare i fogli. |
Output
| Output | Tipo di output |
|---|---|
| Fogli | JSON |
| Numero di fogli | Numero intero |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco tabelle
Per elencare tutte le tabelle Wdata presenti nel tuo workspace e recuperarne i metadati, usa il comando Elenca tabelle.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-gettables/
Proprietà
Nessuno
Output
| Output | Tipo di output |
|---|---|
| Elenco delle tabelle | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Elenco utenti
Per recuperare un elenco dettagliato degli utenti di un'organizzazione, usa il comando Elenca utenti. L'utente di integrazione assegnato deve avere il ruolo di amministratore org per eseguire questo comando.
Simile all'esportazione "Vista persone" dell'amministratore di un'organizzazione, i dettagli sono ordinati per nome e includono i nomi degli utenti:
- Nomi utente
- Indirizzi e-mail
- ID SAML
- Ultimi accessi
- Appartenenze workspace
- Licenze e ruoli
Chiamata API equivalente: https://developers.workiva.com/admin-v1/admin-getorgreportusers/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID dell'organizzazione | Inserisci l'identificativo univoco dell'organizzazione per cui elencare gli utenti. |
Output
| Output | Tipo di output |
|---|---|
| Report utenti | File |
| Conteggio dei record | Numero intero |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Sovrascrivi i dati del foglio
Per cancellare tutte le celle di un foglio e sostituirle con i valori forniti nel file, usa il comando Sovrascrivi i dati del foglio.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/updatesheet.html#
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo in cui sovrascrivere i dati del foglio. |
| ID/nome del foglio | Inserisci il nome o l'identificativo univoco del foglio in cui sovrascrivere i dati. |
| File di dati | Inserisci il file CSV contenente i dati con cui popolare il foglio. |
| Delimitatore | Inserisci il delimitatore utilizzato in File di dati. |
| Usa l'API della piattaforma | Per utilizzare il formato Inserito in dei valori delle celle del foglio di calcolo, seleziona questa casella. |
Output
| Output | Tipo di output |
|---|---|
| Riga scritta | Numero intero |
| Cellule scritte | Numero intero |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Pubblica il foglio di calcolo
Per pubblicare i link in un foglio di calcolo, usa il comando Pubblica foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-publish/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo da pubblicare. |
| Pubblicare tutti i collegamenti | Seleziona quali link del foglio di calcolo pubblicare:
|
Output
| Output | Tipo di output |
|---|---|
| Messaggio | Stringa |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna la connessione
Per aggiornare una connessione specifica in base al suo ID, usa il comando Aggiorna connessione.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshconnection/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID connessione | Inserisci l'identificativo univoco della connessione da aggiornare. |
| Usa i parametri della fonte precedente | Spunta questa casella per utilizzare i parametri di origine dell'esecuzione precedente; questo prevale su qualsiasi altro parametro di origine che hai specificato. Questo input sarà ignorato dall'endpoint "Aggiorna batch di connessioni". |
| Parametri della fonte* |
Inserisci i parametri da inviare alla fonte in caso di aggiornamento riuscito. (Questi parametri saranno ignorati se l'opzione "Usa i parametri della fonte precedente" è attivata) |
| Usa i parametri di destinazione precedenti | Spunta questa casella per utilizzare i parametri di destinazione dell'esecuzione precedente; questo prevale su qualsiasi altro parametro di destinazione che hai specificato. Questo input sarà ignorato dall'endpoint "Aggiorna batch di connessioni". |
| Parametri di destinazione* |
Inserisci i parametri da inviare alla destinazione in caso di aggiornamento riuscito. (Questi parametri saranno ignorati se l'opzione "Usa i parametri di destinazione precedenti" è attivata) |
Nota: i parametri multi-selezione non sono attualmente supportati.
Output
| Output | Tipo di output |
|---|---|
| Aggiorna stato | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna un gruppo di connessioni
Per aggiornare più connessioni contemporaneamente, usa il comando Aggiorna batch di connessioni.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-refreshbatch/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Connessioni |
Attiva o disattiva l'uso delle variabili. Quando è abilitato:
|
| ID connessione | Inserisci l'identificativo univoco della connessione da aggiornare. |
| Usa i parametri della fonte precedente | Spunta questa casella per utilizzare i parametri di origine dell'esecuzione precedente; questo prevale su qualsiasi altro parametro di origine che hai specificato. Questo input sarà ignorato dall'endpoint "Aggiorna batch di connessioni". |
| Parametri di origine |
Inserisci i parametri da inviare alla fonte in caso di aggiornamento riuscito. (Questi parametri saranno ignorati se l'opzione "Usa i parametri della fonte precedente" è attivata) |
| Usa i parametri di destinazione precedenti | Spunta questa casella per utilizzare i parametri di destinazione dell'esecuzione precedente; questo prevale su qualsiasi altro parametro di destinazione che hai specificato. Questo input sarà ignorato dall'endpoint "Aggiorna batch di connessioni". |
| Parametri di destinazione |
Inserisci i parametri da inviare alla destinazione in caso di aggiornamento riuscito. (Questi parametri saranno ignorati se l'opzione "Usa i parametri di destinazione precedenti" è attivata) |
Output
| Output | Tipo di output |
|---|---|
| Stato di aggiornamento del batch | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Rimuovi il bordo
Questo comando è disponibile solo attraverso l'API della piattaforma. Per rimuovere un bordo, utilizza l'endpoint Crea nuovo record.
Recupera un elenco di record
Per ottenere un elenco di record che corrispondono ai filtri forniti, usa il comando Recupera un elenco di record. È sempre necessario almeno un filtro.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-getrecords/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Espandi |
Restituisce le risorse correlate in linea con la risorsa principale. Opzioni:
|
| Filtro | Le proprietà per cui filtrare i risultati. |
Output
| Output | Tipo di output |
|---|---|
| Stato di aggiornamento del batch | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Recupera un elenco di tipi
Per ottenere un elenco dei tipi di record e dei loro attributi, usa il comando Recupera un elenco di tipi. Questo comando ti permette di sapere cosa aspettarti dal recupero dei record.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-gettypes/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Espandi |
Restituisce le risorse correlate in linea con la risorsa principale. Opzioni:
|
Output
| Output | Tipo di output |
|---|---|
| Stato di aggiornamento del batch | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Recupera un singolo record
Per recuperare un singolo record, usa il comando Recupera un elenco di record. L'identificatore unico è in genere un UUID, ma può variare.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-getrecordbyid/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Espandi |
Restituisce le risorse correlate in linea con la risorsa principale. Opzioni:
|
| ID del record | Inserisci l'identificativo univoco del record. |
Output
| Output | Tipo di output |
|---|---|
| Stato di aggiornamento del batch | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Recupera un singolo tipo
Per recuperare un singolo record, usa il comando Recupera un elenco di record. L'identificatore unico è in genere un UUID, ma può variare.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-gettypebyid/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| Espandi |
Restituisce le risorse correlate in linea con la risorsa principale. Opzioni:
|
| ID del record | Inserisci l'identificativo univoco del record. |
Output
| Output | Tipo di output |
|---|---|
| Stato di aggiornamento del batch | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Esegui la query
Per eseguire una query Wdata e recuperarne i risultati, usa il comando Esegui query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-runquery/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID della query | Inserisci l'ID della query da eseguire. |
| Parametri | Se la query ha dei parametri definiti, aggiungi una mappa dei loro nomi e valori. Nota: inserisci i valori di tutti i parametri di multiselezione in Parametri di multiselezione. |
| Esegui in modo asincrono | Per eseguire la query in modo asincrono e non aspettare che la query finisca per completare il comando, seleziona questa casella. |
| Parametri multiselezionati | Se la query ha definito più parametri di selezione, aggiungi il nome e i valori di ciascuno. |
Output
| Output | Tipo di output |
|---|---|
| Risultati della query | JSON |
Nota: l'output Risultati query include un ID, che può essere utilizzato per scaricare ed esportare i risultati.
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Esegui report
Per eseguire un report salvato nell'account del database SOX e audit interno della tua organizzazione e restituirne i risultati come file CSV, usa il comando Esegui report.
Chiamata API equivalente: https://developers.workiva.com/platform-v1/platform-getreportascsv/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID rapporto | Inserisci l'identificativo univoco del report che contiene il report salvato. |
| Contenuto di anteprima | Per includere un'anteprima dei risultati del report nel log del comando, seleziona questa casella. |
Output
| Output | Tipo di output |
|---|---|
| Report | File |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Importa bordo
Questo comando è disponibile solo attraverso l'API della piattaforma. Per impostare un bordo, utilizza l'endpoint Crea nuovo record.
Imposta le proprietà del record
Questo comando è disponibile solo attraverso l'API della piattaforma. Per impostare le proprietà del record, utilizza l'endpoint Crea nuovo record.
Disimporta il file dalla tabella
Per disimportare e rimuovere un file da una tabella Wdata, usa il comando Disimporta file dalla tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-unimportfile/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'identificativo univoco della tabella da cui rimuovere il file. |
| ID file | Inserisci l'identificativo univoco del file da rimuovere dalla tabella. |
Output
| Output | Tipo di output |
|---|---|
| Importazione di file | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna la vista pivot
Per aggiornare i metadati di una vista Wdata, usa il comando Aggiorna vista pivot.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatepivotview/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID | Inserisci l'ID della vista da aggiornare. |
| Nome | Inserisci il nuovo nome della vista. |
| ID della query | Inserisci l'ID della query da cui creare la vista. |
| ID del risultato della query | Inserisci l'ID del risultato della query da cui creare la vista. |
| Metadati aggiuntivi | Inserisci i metadati definiti dall'utente da allegare alla vista, come oggetto JSON (opzionale). |
Output
| Output | Tipo di output |
|---|---|
| Vista pivot | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna la definizione della query
Per aggiornare le proprietà di una query Wdata, usa il comando Aggiorna definizione query.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatequery/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID della query | Inserisci l'ID della query da aggiornare. |
| Nome | Inserisci il nuovo nome della query. |
| Descrizione | Inserisci la nuova descrizione della query. |
| ID risultato primario | Se specificato, inserisci l'ID del risultato predefinito da popolare con i risultati della query. |
| Testo della query | Inserisci la definizione della query con la sintassi di Presto SQL, come faresti nell'editor SQL della query. |
| Temporanea | Per generare la query solo temporaneamente in modo che non appaia nel workspace, seleziona questa casella. |
| Parametri | Inserisci i parametri necessari per eseguire la query. |
Output
| Output | Tipo di output |
|---|---|
| Query | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna l'elenco di selezione
Per aggiornare le proprietà o gli elementi di un elenco di valori per un parametro di query multi-selezione, usa il comando Aggiorna elenco di selezione.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-updateselectlist/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID | Inserisci l'ID dell'elenco selezionato da aggiornare. |
| Nome | Inserisci il nuovo nome dell'elenco di selezione. |
| Descrizione | Inserisci la nuova descrizione dell'elenco selezionato. |
| Tipo di valore | Seleziona il tipo di dati dei valori dell'elenco, ad esempio stringa o numero intero. |
| Valori | Inserisci i valori dell'elenco, compresi gli eventuali aggiornamenti. |
Output
| Output | Tipo di output |
|---|---|
| Aggiorna l'elenco di selezione | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna i metadati del foglio
Per aggiornare i metadati di un foglio in un foglio di calcolo, usa il comando Aggiorna metadati del foglio.
Chiamata API equivalente: https://developers.workiva.com/spreadsheets-v1/spreadsheets-updatesheet/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio in cui aggiornare i metadati. |
| ID/nome del foglio | Inserisci il nome o l'identificativo unico del foglio in cui aggiornare i metadati. |
| Nome | Inserisci il nuovo nome del foglio. |
| Indice dei fogli | Inserisci il nuovo indice del foglio nel foglio di calcolo. Per impostazione predefinita, i comandi aggiornano il foglio come foglio superiore. |
| ID foglio genitore | Inserisci l'ID del foglio genitore con cui creare il foglio. Per aggiungere al foglio di calcolo principale, lascia in bianco. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna i metadati del foglio di calcolo
Per aggiornare i metadati di un foglio di calcolo, usa il comando Aggiorna i metadati del foglio di calcolo.
Chiamata API equivalente: https://developers.workiva.com/2022-01-01/updatesheet.html
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio in cui aggiornare i metadati. |
| Nome | Inserisci il nuovo nome del foglio di calcolo. |
Output
Nessuno
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Aggiorna la tabella
Per aggiornare le colonne di una tabella Wdata, usa il comando Aggiorna tabella.
Chiamata API equivalente: https://developers.workiva.com/wdata-v1/wdata-updatetable/
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID tabella | Inserisci l'identificativo univoco della tabella da aggiornare. |
| Nome | Inserisci il nome della tabella da aggiornare. |
| Descrizione | Inserisci una descrizione della tabella da aggiornare. |
| Tipo | Seleziona se aggiornare una tabella Data- o fatto o Ricerca - o dimensioni |
| Colonne | Aggiungi le colonne con cui aggiornare la tabella. Per ogni colonna, inserisci il nome, il tipo di dati, l'alias e la descrizione. Per Modalità, lascia il valore predefinito di Nullable. |
Output
| Output | Tipo di output |
|---|---|
| Tabella | JSON |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |
Scrivi i dati del foglio
Per scrivere i dati di un set di dati CSV in una regione specifica di un foglio, usa il comando Scrivi dati sul foglio.
Proprietà
| Proprietà | Dettaglio |
|---|---|
| ID del foglio di calcolo | Inserisci l'identificativo univoco del foglio di calcolo con il foglio su cui scrivere i dati. |
| ID/nome del foglio | Inserisci l'identificativo univoco del foglio su cui scrivere i dati. |
| File di dati | Inserisci il file CSV con i dati da scrivere sul foglio. L'intervallo dei dati non deve superare la Regione. |
| Delimitatore | Inserisci il delimitatore utilizzato in File di dati. |
| Regione | Inserisci una rappresentazione A1 della cella o dell'intervallo di celle del foglio in cui scrivere i dati. Per avere un intervallo non delimitato in una o tutte le direzioni, lascia vuota la colonna o la riga corrispondente. |
| Usa async |
Per caricare i dati in modo asincrono, ad esempio per un set di dati di grandi dimensioni, seleziona questa casella. Nota: se utilizzi async, devi aggiungere il polling per determinare lo stato del lavoro. |
| Usa l'API della piattaforma |
Per utilizzare il formato inserito in dei valori delle celle della Regione, seleziona questa casella. Questo costringerà il comando a utilizzare i valori di aggiornamento in un endpoint di intervallo piuttosto che i dati di scrittura dell'API del foglio di calcolo in un endpoint di regione. Nota: questo comando verrà sempre eseguito in modo asincrono quando si utilizza l'API della piattaforma. Devi aggiungere il tuo sondaggio per determinare lo stato del lavoro. |
Output
| Output | Tipo di output |
|---|---|
| Righe scritte | Numero intero |
| Cellule scritte | Numero intero |
Codici di uscita
| Codice | Tipo | Dettaglio |
|---|---|---|
| 0 | Operazione completata | Operazione completata |
| 1 | Errore | Errore |