eraseData

Adaptive Planning

Novità (Workday 2025R2)

Ultimo aggiornamento: 2024-08-16

eraseData

Supportato nell'API v24 +.

Categoria	Inoltro dei dati
Descrizione	Cancella i dati del piano o degli importi effettivi nei periodi di tempo specificati per un conto con filtri facoltativi per livelli e conti.
Autorizzazioni necessarie per richiamare	Cancella dati
Parametri obbligatori su richiesta	Credenziali, EraseOptions

Cancella i valori numerici da una versione pianificata o dagli importi effettivi per l'insieme di conti specificato per un determinato intervallo di tempo. Non verranno cancellate le formule (ad esempio formule condivise, formule cella, formule conto). Elimina i frazionamenti conti che diventano vuoti a seguito del processo di cancellazione. Una suddivisione vuota è una suddivisione che non contiene dati, formule o note di cella. Se la cancellazione comporta l'eliminazione degli ultimi dati di una suddivisione, tale suddivisione verrà eliminata. Questa API lascia invariate le suddivisioni se erano vuote prima di chiamare l'API.

Il metodo eraseData offre le stesse funzionalità di eraseActuals, ma include anche la possibilità di cancellare i dati del piano, con un controllo aggiuntivo su specifiche combinazioni conto-piano che sono obiettivi. Verranno eliminate anche le note della cella che corrispondono ai criteri.

Import Capabilities

Erase Data

è un'autorizzazione superutente che consente di cancellare gli importi effettivi o i dati del piano in Adaptive Planning, anche nei livelli bloccati. Cancella dati sostituisce le regole di accesso e le limitazioni alla proprietà dei livelli. È possibile eliminare solo i dati dai conti calcolati con valori sostitutivi di immissione dati.

Questa API convalida lo strato temporale dei conti scelti.

Cancellazione conti di rollup

L'API Erase Data non cancella i dati per i conti di rollup. Includere ogni conto singolarmente nella richiesta.

Cancellazione livelli

Se si supera un livello padre nella richiesta, l'API eraseData cancella solo i dati al livello padre e non ai livelli figlio. È necessario includere ogni livello singolarmente nella richiesta API.

Formato richiesta

Le richieste rifiutano i tag non riconosciuti. I tag consentono la corrispondenza senza distinzione tra maiuscole e minuscole. Esempio: <conti>, <Conti> e <ACCOUNTS> sono accettabili per l'elemento Conti.

Cancella importi effettivi per tutti i livelli della versione importi effettivi predefinita

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" instanceCode="MYINSTANCE" locale="en_US"/>
<eraseOptions actualsVersionName="Actuals" 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>

Cancellare i dati degli importi effettivi con i filtri per i conti di un livello specifico

Per questo esempio, i dati degli importi effettivi nella versione importi effettivi

ActualsSubVersion2013

per i conti personalizzati

WAT_Input_Custom

WAT_Test_Custom

nel livello

verrà eliminato.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE" locale="en_US" />
<eraseOptions actualsVersionName="ActualsSubVersion2013" accountType="CUSTOM" start="01/2010" end="11/2010" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WAT_Input_Custom"/>
    <Account code="WAT_Test_Custom"/>
  </Accounts>
  <Levels>
    <Level name="QA"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Cancellare i dati del piano con un filtro da eliminare da conti personalizzati specifici

Per questo esempio, i dati del piano nella versione del piano

clone2013Budget

per i conti personalizzati

SUM_TEXT

LAST_NB

verrà eliminato.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="SUM_TEXT"/>
    <Account code="LAST_NB"/>
  </Accounts>
</filters>
</eraseOptions>
</call>

Cancellare i dati del piano con filtri da eliminare da conti personalizzati specifici in livelli specifici

Per questo esempio, i dati del piano nella versione del piano

clone2013Budget

per i conti personalizzati

WA_SUM

SUM_SUM

sui livelli

Development

Hosting

verrà eliminato.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US"/>
<eraseOptions planVersionName="clone2013Budget" accountType="CUSTOM" start="01/2010" end="12/2013" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="WA_SUM"/>
    <Account code="SUM_SUM"/>
  </Accounts>
  <Levels>
    <Level name="Development"/>
    <Level name="Hosting"/>
  </Levels>
</filters>
</eraseOptions>
</call>

Cancellare i dati del piano con filtri da eliminare da un conto cubo specifico a un livello specifico

Per questo esempio, i dati del piano nella versione del piano

10YearBudget

per il conto cubo

ExpenseCube.Units

nel livello

WorldWide Sales

verrà eliminato.


<?xml version="1.0" encoding="UTF-8"?>
<call method="eraseData" callerName="test caller api name">
<credentials login="sampleuser@company.com" password="my_password" instanceCode="MYINSTANCE1" locale="en_US" />
<eraseOptions planVersionName="10YearBudget" accountType="CUBE" cubeSheetName="Expense Cube" start="01/2010" end="12/2017" includeCellNotes="true">
<filters>
  <Accounts>
    <Account code="ExpenseCube.Units" />
  </Accounts>
  <Levels>
    <Level name="WorldWide Sales" />
  </Levels>
</filters>
</eraseOptions>
</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 utilizzate per la cancellazione degli importi effettivi o dei dati del piano.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
actualsVersionName	N	Obbligatorio per cancellare i dati degli importi effettivi. Specifica il nome della versione importi effettivi da cui cancellare i dati. Non cancella le formule (ad esempio formule condivise, formule cella, formule conto).	ActualsSubVersion2013
planVersionName	N	Obbligatorio per cancellare i dati del piano. Specifica il nome della versione pianificata da cui cancellare i dati. Non cancella le formule (ad esempio formule condivise, formule cella, formule conto).	clone2013Budget
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. 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. 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. 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. 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 "true", eraseData cancella tutte le note della cella nella versione, nel tipo di conto e nell'intervallo di tempo selezionati (e le combinazioni a livello di conto corrispondenti ai filtri, se specificati), indipendentemente dal fatto che cancelli anche i dati dal cella Se è "false", nessuna nota di cella verrà eliminata	true
displayNameEnabled Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	displayNameEnabled=true indica che eraseData deve rispettare le proprietà del nome visualizzato di code quando Abilita nome visualizzato è attivo per l'istanza. displayNameEnabled=false indica che l'API eraseData deve continuare a seguire il contratto API precedente alla versione 30 anche quando l'opzione Abilita nome visualizzato è attiva per l'istanza. L'API eraseData ignora le proprietà del nome visualizzato code . Il valore predefinito per displayNameEnabled è "false".	Vero
Contenuto dell'elemento
(nessuno)

elemento filtri
Nome tag		Filtri
Descrizione		Specifica i filtri del conto e del livello da utilizzare durante la cancellazione dei dati.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Contenuto dell'elemento
Un elemento Conti, un elemento Livelli o sia un elemento Conti sia un elemento Livelli.

Elemento Conti
Nome tag		Conti
Descrizione		Contenitore per uno o più elementi del conto di un filtro EraseData.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Contenuto dell'elemento
Uno o più elementi Conto.

Elemento Livelli
Nome tag		Livelli
Descrizione		Contenitore per uno o più elementi Level di un filtro EraseData.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
Contenuto dell'elemento
Uno o più elementi Livello.

Elemento Conto
Nome tag		Account
Descrizione		Il conto da cui verranno cancellati i dati, specificato dal codice conto.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
codice	S	Specifica il codice conto per il conto dei dati da cancellare.	WA_SUM
Contenuto dell'elemento
(nessuno)

Elemento livello
Nome tag		Level
Descrizione		Il livello per i dati del conto da cancellare, specificato da Nome livello.
Attributi dell'elemento
Nome attributo	Obbligatorio?	Valore	Esempio
nome	S	Specifica il nome del livello per i dati del conto da cancellare.	Vendite a livello mondiale
codice Disponibile solo nell'API v30+ per le istanze che abilitano il nome visualizzato.	N	Il codice del livello. Obbligatorio quando l'abilitazione del nome visualizzato è abilitata per un'istanza.	Vendite nel mondo
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.

Questo contenuto è stato utile?

Che cosa richiede la nostra attenzione? Preciso Risponde alla mia domanda Facile da trovare Di facile comprensione Utile per completare l'attività Completo di dettagli

Che cosa richiede la nostra attenzione? Impreciso Non risponde alla mia domanda Non facile da trovare Di non facile comprensione Non utile per completare l'attività Incompleto o senza dettagli

Indica l'attività che stai eseguendo. Quali informazioni aggiuntive potrebbero migliorare questo contenuto? Hai altri dettagli da condividere?

Nome completo

E-mail

Workday utilizzerà il vostro nome e la vostra e-mail per fornirvi le risposte relative al vostro feedback. I vostri dati saranno trattati in conformità con la nostra Informativa sulla privacy.

Grazie per il feedback