eraseData
Wird unterstützt in API v24 +.
Kategorie
| Datenübermittlung |
Beschreibung
| Löscht Plan- oder Istdaten in den angegebenen Zeitperioden für ein Konto mit optionalen Filtern für Ebenen und Konten. |
Zum Aufrufen sind Berechtigungen erforderlich
| Daten löschen |
Auf Anforderung erforderliche Parameter
| Credentials, EraseOptions |
Löscht numerische Werte aus einer Plan- oder Istzahlen-Version für den angegebenen Kontensatz für einen bestimmten Zeitrahmen. Es werden keine Formeln gelöscht (z. B. geteilte Formeln, Zellenformeln, Kontoformeln). Löscht die Kontosplits, die durch den Löschprozess leer werden. Ein leerer Split ist ein Split, der keine Daten, Formeln oder Zellnotizen enthält. Wenn das Löschen 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.
Die Methode „eraseData“ umfasst dieselben Funktionen wie „eraseActuals“, ermöglicht aber auch das Löschen von Plandaten und bietet zusätzliche Kontrolle über bestimmte Konto-Plan-Kombinationen, die als Ziel dienen. Zellnotizen, die den Kriterien entsprechen, werden ebenfalls gelöscht.
ist eine Superuser-Berechtigung, die das Löschen von Istzahlen oder Plandaten in Adaptive Planning ermöglicht, auch in gesperrten Ebenen. „Daten löschen“ überschreibt Zugriffsregeln und Beschränkungen der Ebeneneigentümerschaft. Sie können nur Daten aus berechneten Konten mit Überschreibung durch Dateneingabe löschen.
Diese API validiert die Zeitschicht in den ausgewählten Konten.
Löschen von Rollup-Konten
Die API „Daten löschen“ löscht keine Daten für Rollup-Konten. Nehmen Sie jedes Konto einzeln in Ihre Anforderung auf.
Löschen von Ebenen
Wenn Sie in Ihrer Anforderung eine übergeordnete Ebene übergeben, löscht die eraseData-API die Daten nur auf der übergeordneten Ebene und nicht auf den untergeordneten Ebenen. Sie müssen jede Ebene einzeln in die API-Anforderung aufnehmen.
Anforderungsformat
Anforderungen lehnen nicht erkannte Tags ab. Tags ermöglichen einen Abgleich ohne Berücksichtigung der Groß-/Kleinschreibung. Beispiel: <accounts>, <Accounts> und <ACCOUNTS> sind für das Element "Konten" zulässig.
Istzahlen für alle Ebenen der Standard-Istzahlen-Version löschen
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" instanceCode="MYINSTANCE" locale="en_US"/> <eraseOptions actualsVersionName="Actuals" 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>
Istdaten mit Filtern für Konten auf einer bestimmten Ebene löschen
In diesem Beispiel sind Istdaten in der Istzahlen-Version
ActualsSubVersion2013
für benutzerdefinierte Konten WAT_Input_Custom
und WAT_Test_Custom
auf der Ebene QA
wird gelöscht.<?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>
Plandaten mit einem Filter löschen, der aus bestimmten benutzerdefinierten Konten gelöscht werden soll
In diesem Beispiel die Plandaten in der Planversion
clone2013Budget
für benutzerdefinierte Konten SUM_TEXT
und LAST_NB
wird gelöscht.<?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>
Plandaten mit Filtern löschen, die aus bestimmten benutzerdefinierten Konten auf bestimmten Ebenen gelöscht werden sollen
In diesem Beispiel die Plandaten in der Planversion
clone2013Budget
für benutzerdefinierte Konten WA_SUM
und SUM_SUM
in den Ebenen Development
und Hosting
wird gelöscht.<?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>
Plandaten mit Filtern löschen, die aus einem bestimmten Cube-Konto auf einer bestimmten Ebene gelöscht werden sollen
In diesem Beispiel die Plandaten in der Planversion
10YearBudget
für Cube-Konto ExpenseCube.Units
in der Ebene WorldWide Sales
wird gelöscht.<?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>
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 oder Plandaten verwendet werden. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
actualsVersionName | N | Erforderlich für das Löschen von Istdaten. Gibt den Namen der Istzahlen-Version an, aus der Daten gelöscht werden sollen. Löscht keine Formeln (z. B. geteilte Formeln, Zellenformeln, Kontoformeln). | ActualsSubVersion2013 |
planVersionName | N | Erforderlich für das Löschen von Plandaten. Gibt den Namen der Planversion an, aus der Daten gelöscht werden sollen. Löscht keine Formeln (z. B. geteilte Formeln, Zellenformeln, Kontoformeln). | clone2013Budget |
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 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.
Die angegebene Zeitperiode muss 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 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.
Die angegebene Zeitperiode muss 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 „true“ festgelegt ist, löscht eraseData alle Zellnotizen in der ausgewählten Version, in der Kontoart und im ausgewählten Zeitbereich (und in Kombinationen auf Kontoebene, die mit den Filtern übereinstimmen, falls angegeben), unabhängig davon, ob auch die Daten aus dem gelöscht werden -Zelle. Bei "false" werden keine Zellnotizen gelöscht | wahr |
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | displayNameEnabled = true gibt an, dass eraseData die Eigenschaften des Anzeigenamens von berücksichtigen soll code wenn Enable Anzeige Name für die Instanz EIN ist.displayNameEnabled=false gibt an, dass die eraseData-API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die eraseData-API ignoriert die Eigenschaften des Anzeigenamens code .Der Standardwert für displayNameEnabled ist "false". | Wahr |
Inhalt des Elements
| |||
(Keine) | |||
Element „Filter“.
| |||
Tag-Name
| Filter | ||
Beschreibung
| Gibt die Konto- und Ebenenfilter an, die beim Löschen von Daten verwendet werden sollen. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Inhalt des Elements
| |||
Ein Account-Element, ein Levels-Element oder sowohl ein Account-Element als auch ein Levels-Element. | |||
Kontenelement
| |||
Tag-Name
| Konten | ||
Beschreibung
| Container für mindestens ein Kontoelement eines eraseData-Filters. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Inhalt des Elements
| |||
Mindestens ein Kontoelement. | |||
Element „Ebenen“.
| |||
Tag-Name
| Ebenen | ||
Beschreibung
| Container für ein oder mehrere Level-Elemente eines eraseData-Filters. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Inhalt des Elements
| |||
Mindestens ein Level-Element. | |||
Kontoelement
| |||
Tag-Name
| Konto | ||
Beschreibung
| Das Konto, aus dem Daten gelöscht werden, angegeben durch den Kontocode. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
-Code | J | Gibt den Kontocode für das Konto der zu löschenden Daten an. | WA_SUM |
Inhalt des Elements
| |||
(Keine) | |||
Ebenenelement
| |||
Tag-Name
| Ebene | ||
Beschreibung
| Die Ebene für die zu löschenden Kontodaten, angegeben durch den Namen der Ebene. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Namen | J | Gibt den Ebenennamen für die zu löschenden Kontodaten an. | Weltweiter Umsatz |
-Code
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren. | N | Der Code der Ebene.
Erforderlich, wenn "Anzeigename aktivieren" für eine Instanz aktiviert ist. | Weltweiter Umsatz |
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. | |||