ricalcolareFoglio

Supportato nell'API v16 +

Categoria	Inoltro dei dati
Descrizione	Ricalcolare i fogli con la proprietà Ricalcola su richiesta.
Autorizzazioni necessarie per richiamare	Autorizzazione di modifica foglio
Parametri obbligatori su richiesta	Credenziali

La richiesta di questo metodo contiene un tag delle credenziali per identificare e autorizzare l'utente chiamante. L'utente deve disporre dell'autorizzazione "Autorizzazione modifica foglio" per eseguire il ricalcolo.

Formato richiesta


<?xml version='1.0' encoding='UTF-8'?>
<call method="recalculateSheet" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <version name="Default Structure"/>
   <sheet name="Expense Cube"/>
   <level name="Corporate Plan"/>
</call>

elemento version - Genera un errore se la versione non è specificata.

elemento foglio: se non viene specificato alcun elemento foglio, tutti i fogli con le opzioni di ricalcolo su richiesta vengono ricalcolati al primo livello in una determinata versione. In questo caso, il livello viene ignorato.

elemento livello

Se non viene specificato alcun livello, il foglio viene ricalcolato al primo livello in una determinata versione.

Se l'utente non ha accesso al livello specificato, viene generato un errore.

Il foglio viene ricalcolato per il livello e i relativi discendenti nella versione specificata.

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere una singola chiamata credenziali per identificare l'utente che richiama l'API. La chiamata API viene quindi eseguita come utente (qualsiasi audit trail o storico delle azioni nel sistema mostrerà che l'azione è stata eseguita dall'utente) e pertanto l'utente deve disporre delle autorizzazioni necessarie per eseguire l'azione affinché la chiamata API avere esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
accedere	S	Il nome di accesso dell'utente che richiama il metodo API. L'utente deve disporre delle autorizzazioni necessarie per richiamare il metodo.	sampleuser@company.com
password	S	La password dell'utente che richiama il metodo API.	my_password
impostazioni internazionali	N	Specificare le impostazioni internazionali da utilizzare per interpretare i numeri e le date in entrata e per formattare i numeri e le date in uscita (utilizzando il separatore delle migliaia, i nomi dei periodi di tempo e la formattazione della data appropriati). Le impostazioni internazionali vengono utilizzate anche per specificare la lingua in cui devono essere visualizzati i messaggi di sistema nella risposta. Se non viene specificato, viene utilizzato en_US (inglese americano).	fr_FR
instanceCode	N	Se l'utente specificato nelle credenziali ha accesso a più istanze di Adaptive Planning , questo attributo può essere utilizzato per specificare che l'utente intende accedere a un'istanza diversa da quella predefinita. Se non viene specificata, verrà utilizzata l'istanza predefinita dell'utente. Per determinare i codici di istanza disponibili, utilizzare l'API exportInstances.	MYINSTANCE1
Contenuto dell'elemento
(nessuno)

elemento versione
Nome tag		versione
Descrizione		Indica la versione da utilizzare per ricevere i dati richiesti. È necessario specificare una versione per ogni chiamata.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	N	Il nome della versione.	Struttura predefinita
ID	N	ID della versione L'ID viene considerato solo se il nome non è presente.	4
Contenuto dell'elemento
(nessuno)

elemento del foglio
Nome tag		foglio
Descrizione		Foglio definito da nome o ID
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	N	Il nome del foglio	Cubo di spesa
ID	N	ID del foglio L'ID viene considerato solo se il nome non è presente.	1
Contenuto dell'elemento
(nessuno)

elemento livello
Nome tag		level
Descrizione		Livello definito da nome o ID
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	N	Il nome del livello	Piano aziendale
ID	N	ID del livello Il livello viene considerato solo se il nome non è presente.	1
Contenuto dell'elemento
(nessuno)

Formato risposta


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
</response>

elemento di risposta
Nome tag		risposta
Descrizione		Livello definito da nome o ID
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	"True" o "false", che indica se la chiamata API è stata eseguita correttamente o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	vero
Contenuto dell'elemento
Un singolo elemento di messaggi facoltativo.

elemento messaggi
Nome tag		messaggi
Descrizione		Contenitore per uno o più elementi del messaggio
Attributi dell'elemento
(nessuno)
Contenuto dell'elemento
Uno o più elementi del messaggio

elemento messaggio
Nome tag		messaggio
Descrizione		Rappresenta un messaggio inviato dal sistema al chiamante. I messaggi vengono utilizzati per i messaggi di errore quando le richieste non hanno esito positivo, per i messaggi di avviso quando le richieste hanno esito positivo e per i messaggi di conferma in caso di esito positivo.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
chiave	N	Quando viene assegnata, una chiave è un modo per identificare un particolare messaggio o tipo di messaggio, utile ai fini della registrazione automatica degli errori e del ripristino nei programmi client. Le chiavi non cambiano nelle diverse impostazioni internazionali delle richieste, anche quando cambia la lingua del messaggio. Inoltre, è improbabile che le chiavi cambino in futuro a causa di rettifiche di testo o modifiche della terminologia.	invalid-attributevalueid
Contenuto dell'elemento
Il testo del messaggio. Questo testo è nella lingua delle impostazioni internazionali specificate nella richiesta (supponendo che le impostazioni internazionali siano supportate). Il testo può anche contenere informazioni variabili come il numero di righe elaborate o la colonna o il valore specifico che ha causato un errore. Un elemento di contesto facoltativo.