eraseActuals

Kategorie	Datenübermittlung
Beschreibung	Löscht numerische Daten in den angegebenen Zeitperioden und Konten einer Istzahlen-Version.
Zum Aufrufen sind Berechtigungen erforderlich	Daten löschen
Auf Anforderung erforderliche Parameter	Credentials, EraseOptions

Diese Methode löscht numerische Werte aus einer Istzahlen-Version für alle Ebenen des angegebenen Kontensatzes für einen bestimmten Zeitrahmen. Es werden keine Formeln gelöscht (z. B. geteilte Formeln, Zellenformeln, Kontoformeln). Löscht die Kontosplits, die durch den Prozess zum Löschen der Istzahlen leer werden. Ein leerer Split ist ein Split, der keine Daten, Formeln oder Zellnotizen enthält. Wenn das Löschen von Istzahlen zum Löschen der letzten Daten aus einem Split führt, wird dieser Split gelöscht. Diese API lässt Splits unverändert, wenn sie vor dem Aufruf der API leer waren.

Anforderungsformat

So löschen Sie numerische Werte und neu leere Splits für die Zeitperioden zwischen dem Start- und dem Enddatum aus allen Hauptbuch-Konten für alle Ebenen der Standard-Istzahlen-Version:


 <?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>

So löschen Sie numerische Werte und Zellnotizen aus einem einzelnen Cube-Tabellenblatt für alle Ebenen einer bestimmten Istzahlen-Version zwischen dem angegebenen Start und Ende:


 <?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>

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen eine einzelne enthaltenElement credentials, um den Benutzer zu identifizieren, der die API aufruft. Der API-Aufruf wird dann als dieser Benutzer ausgeführt (jeder Audit-Trail oder jede Aktionshistorie im System zeigt, dass dieser Benutzer die Aktion ausgeführt hat). Daher muss der Benutzer über die erforderlichen Berechtigungen zum Ausführen der Aktion verfügen, damit der API-Aufruf ausgeführt werden kann erfolgreich ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
anmelden	J	Der Anmeldename des Benutzers, der die API-Methode aufruft. Dieser Benutzer muss über die erforderlichen Berechtigungen zum Aufrufen der Methode verfügen.	sampleuser@company.com
Kennwort	J	Das Kennwort des Benutzers, der die API-Methode aufruft.	my_password
Gebietsschema	N	Geben Sie das Gebietsschema an, das verwendet werden soll, um eingehende Zahlen und Datumsangaben zu interpretieren und ausgehende Zahlen und Datumsangaben zu formatieren (mit dem entsprechenden Tausendertrennzeichen, den entsprechenden Zeitperiodennamen und der entsprechenden Datumsformatierung). Das Gebietsschema wird auch verwendet, um die Sprache anzugeben, in der Systemmeldungen in der Antwort angezeigt werden sollen. Wenn nicht angegeben, wird en_US (amerikanisches Englisch) verwendet.	fr_FR
instanceCode	N	Wenn der in den Zugangsdaten angegebene Benutzer Zugriff auf mehr als eine Instanz von hat, Adaptive Planning : Dieses Attribut kann verwendet werden, um anzugeben, dass der Benutzer auf eine andere Instanz als seine Standardinstanz zugreifen möchte. Wenn nicht angegeben, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

eraseOptions element
Tag-Name		eraseOptions
Beschreibung		Gibt die Optionen an, die beim Löschen von Istzahlen verwendet werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
actualsVersionName	N	Erforderlich, wenn es mehr als eine Istzahlen-Version gibt. Wenn diese Instanz nur das Planning-Produkt enthält, dann„EraseActuals“ löscht Daten aus der einen und einzigen Istzahlen-Version.	Ist
accountType	J	Gibt an, ob die Kontoart "Hauptbuch" ist ("GL"), benutzerdefiniert ("benutzerdefiniert") oder Cube-Tabellenblatt ("CUBE").	Hauptbuch
cubeSheetName	N	Erforderlich, wennaccountType = "CUBE". Gibt den Namen des Cube-Tabellenblatts an.	Sales Cube
Anfang	J	Gibt den Code der Startzeitperiode des Istzahlen-Zeitbereichs an. Der Code muss sich auf eine Zeitperiode in der Zeitschicht des Kontos beziehen. Wenn Sie ein Cube-Tabellenblatt angeben, muss sich der Code auf eine Zeitperiode in der Zeitschicht des Cube-Tabellenblatts beziehen. Wenn Sie eine Hauptbuch- oder benutzerdefinierte Kontoart angeben, muss sich der Code auf die Standardzeitschicht beziehen. Bei API v15 und höher muss die angegebene Zeitperiode mit der Zeitschicht des Kontos übereinstimmen. Wenn das Konto beispielsweise eine Zeitschicht „Quartal“ hat, die im Januar beginnt, können Sie „Februar“ nicht als Start auswählen.	01/2013
Ende	J	Gibt den Code der Endzeitperiode des Istzahlen-Zeitbereichs an. Der Code muss sich auf eine Zeitperiode in der Zeitschicht des Kontos beziehen. Wenn Sie ein Cube-Tabellenblatt angeben, muss sich der Code auf eine Zeitperiode in der Zeitschicht des Cube-Tabellenblatts beziehen. Wenn Sie eine Hauptbuch- oder benutzerdefinierte Kontoart angeben, muss sich der Code auf die Standardzeitschicht beziehen. Bei API v15 und höher muss die angegebene Zeitperiode mit der Zeitschicht des Kontos übereinstimmen. Wenn das Konto beispielsweise eine Zeitschicht von Quartalen hat, die im Januar beginnen, können Sie Februar nicht als Ende auswählen.	03/2013
includeCellNotes	J	Wenn festgelegt auf "wahr", dann„EraseActuals“ löscht alle Zellnotizen in der ausgewählten Version, Kontoart und im ausgewählten Zeitbereich, unabhängig davon, ob auch die Daten aus der Zelle gelöscht werden. Wenn "falsch“, werden keine Zellnotizen gelöscht.	wahr
Inhalt des Elements
(Keine)

Antwortformat


 <?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>

Antwortelement
Tag-Name		-Antwort
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Beideswahr oderfalsch: Gibt an, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	true
Inhalt des Elements
Einzelne optionaleNachrichtenelement

Nachrichtenelement
Tag-Name		-Nachrichten
Beschreibung		Container für einen oder mehrere-Nachrichtenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Einen oder mehrere-Nachrichtenelemente.

Nachrichtenelement
Tag-Name		Nachricht
Beschreibung		Stellt eine Nachricht dar, die vom System an den Aufrufer zurückgesendet wird. Nachrichten werden für Fehlermeldungen verwendet, wenn Anforderungen nicht erfolgreich sind, als Warnmeldungen, wenn Anforderungen erfolgreich sind, und als Bestätigungsmeldungen bei Erfolgreich.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Schlüssel	N	Wenn ein Schlüssel angegeben wird, kann eine bestimmte Meldung oder eine bestimmte Meldungsart identifiziert werden. Dies ist für eine automatische Fehlerprotokollierung und Wiederherstellung in Client-Programmen hilfreich. Schlüssel ändern sich nicht unter verschiedenen Gebietsschemas von Anforderungen, auch wenn sich die Sprache der Nachricht ändert. Es ist auch fehlgeschlagen, dass sich Schlüssel in Zukunft aufgrund von Wording-Anpassungen oder Änderungen der Terminologie ändern.	warning-invalid-timespann-start
Inhalt des Elements
Der Text der Nachricht. Dieser Text ist in der Sprache des in der Anforderung angegebenen Gebietsschemas (vorausgesetzt, das Gebietsschema wird unterstützt). Der Text kann auch variable Informationen enthalten, z. B. die Anzahl der verarbeiteten Zeilen oder die bestimmte Spalte oder den Wert, die einen Fehler verursacht haben.