eraseActuals

Categoria	Inoltro dei dati
Descrizione	Cancella i dati numerici nei periodi di tempo e nei conti specificati di una versione importi effettivi.
Autorizzazioni necessarie per richiamare	Cancella dati
Parametri obbligatori su richiesta	Credenziali, EraseOptions

Questo metodo cancellerà i valori numerici da una versione importi effettivi per tutti i livelli dell'insieme di conti specificato per un determinato intervallo di tempo. Non verranno cancellate le formule (ad esempio formule condivise, formule cella, formule conto). Verranno eliminate le suddivisioni conti che diventano vuote a seguito del processo di cancellazione degli importi effettivi. Una suddivisione vuota non contiene dati, formule o note di cella. Se la cancellazione degli importi effettivi comporta l'eliminazione degli ultimi dati di una suddivisione, tale suddivisione verrà eliminata. Questa API lascerà invariate le suddivisioni se erano vuote prima di chiamare l'API.

Formato richiesta

Per cancellare i valori numerici e i nuovi suddivisioni vuoti per i periodi di tempo tra l'inizio e la fine da tutti i conti CoGe per tutti i livelli della versione degli importi effettivi predefinita:


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     accountType="GL"
     start="01/2013"     
     end="03/2013"
     includeCellNotes="false" />
</call>

Per cancellare valori numerici e note cella da un singolo foglio cubo per tutti i livelli di una specifica versione degli importi effettivi tra l'inizio e la fine specificati:


 <?xml version='1.0' encoding='UTF-8'?>
<call method="eraseActuals" callerName="a string that identifies your client application">
   <credentials login="sampleuser@company.com" password="my_password"/>
   <eraseOptions
     actualsVersionName="Actuals"
     accountType="CUBE"
     cubeSheetName="Sales Cube"
     start="01/2013"         
     end="03/2013"
     includeCellNotes="true" />
</call>

elemento credenziali
Nome tag		credenziali
Descrizione		Tutte le chiamate API devono contenere una singola chiamatacredenziali 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)

eraseOptions
Nome tag		eraseOptions
Descrizione		Specifica le opzioni da utilizzare per la cancellazione degli importi effettivi.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
actualsVersionName	N	Obbligatorio quando è presente più di una versione importi effettivi. Se questa istanza contiene solo il prodotto di pianificazione,EraseActuals cancellerà i dati dall'unica versione importi effettivi.	Importi effettivi
accountType	S	Specifica se il tipo di conto è la contabilità generale ("CoGe"), personalizzato ("PERSONALIZZATO") o foglio cubo ("CUBO").	CoGe
cubeSheetName	N	Obbligatorio seaccountType="CUBE". Specifica il nome del foglio cubo.	Cubo di vendita
inizio	S	Specifica il codice del periodo di tempo di inizio dell'intervallo di tempo degli importi effettivi. Il codice deve fare riferimento a un periodo di tempo nello strato temporale del conto. Se si specifica un foglio cubo, il codice deve fare riferimento a un periodo di tempo nello strato temporale del foglio cubo. Se si specifica un tipo di conto CoGe o personalizzato, il codice deve fare riferimento allo strato temporale predefinito. Per l'API v15+, il periodo di tempo specificato deve essere in linea con lo strato temporale del conto. Ad esempio, se il conto ha uno strato temporale Trimestre che inizia a gennaio, non è possibile selezionare febbraio come inizio.	01/2013
fine	S	Specifica il codice del periodo di tempo di fine dell'intervallo di tempo degli importi effettivi. Il codice deve fare riferimento a un periodo di tempo nello strato temporale del conto. Se si specifica un foglio cubo, il codice deve fare riferimento a un periodo di tempo nello strato temporale del foglio cubo. Se si specifica un tipo di conto CoGe o personalizzato, il codice deve fare riferimento allo strato temporale predefinito. Per l'API v15+, il periodo di tempo specificato deve essere in linea con lo strato temporale del conto. Ad esempio, se il conto ha uno strato temporale Trimestre che inizia a gennaio, non è possibile selezionare febbraio come fine.	03/2013
includeCellNotes	S	Se impostato su "vero", quindiEraseActuals cancellerà tutte le note della cella nella versione, nel tipo di conto e nell'intervallo di tempo selezionati, indipendentemente dal fatto che cancelli anche i dati dalla cella. Se "false", nessuna nota di cella verrà eliminata.	true
Contenuto dell'elemento
(nessuno)

Formato risposta


 <?xml version="1.0" encoding="UTF-8"?>
<response success="true">
   <messages>
     <message key="erase-actuals-success">Successfully erased actuals data.</message>
     <message key="erase-actuals-facts-deleted">4 facts deleted.</message>
     <message key="erase-actuals-notes-deleted">2 notes deleted.</message>
     <message key="erase-actuals-splits-deleted">1 splits deleted.</message>
   </messages>
</response>

elemento di risposta
Nome tag		risposta
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
successo	S	In entrambi i casivero ofalse, che indica se la chiamata API è riuscita o meno. Anche le chiamate riuscite possono contenere messaggi di avviso nella risposta.	vero
Contenuto dell'elemento
Un singolo facoltativoelemento messaggi

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.	warning-invalid-timespan-start
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.