Tabellenblatt neu berechnen

Wird unterstützt in API v16 +

Kategorie	Datenübermittlung
Beschreibung	Tabellenblätter mit der Eigenschaft „Auf Anforderung neu berechnen“ neu berechnen.
Zum Aufrufen sind Berechtigungen erforderlich	Berechtigung Tabellenblatt bearbeiten
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält ein Credentials-Tag, um den aufrufenden Benutzer zu identifizieren und zu autorisieren. Der Benutzer muss für die Neuberechnung über die Berechtigung "Berechtigung für Tabellenblatt" verfügen.

Anforderungsformat


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

Versionselement – löst einen Fehler aus, wenn Version nicht angegeben ist.

Tabellenblattelement: Wenn kein Tabellenblattelement angegeben wird, werden alle Tabellenblätter mit Optionen für „On-Demand-Neuberechnung“ auf der obersten Ebene in der angegebenen Version neu berechnet. In diesem Fall wird die Ebene ignoriert.

Ebenenelement

Wenn keine Ebene angegeben wird, wird das Tabellenblatt in der obersten Ebene in der angegebenen Version neu berechnet.

Wenn der Benutzer keinen Zugriff auf die angegebene Ebene hat, wird ein Fehler ausgegeben.

Das Tabellenblatt wird für die Ebene und ihre Nachfolger in der angegebenen Version neu berechnet.

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen eine einzelne enthalten Element 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)

-Versionselement
Tag-Name		Version
Beschreibung		Gibt an, welche Version zum Empfangen der angeforderten Daten verwendet werden soll. Für jeden Aufruf muss eine Version angegeben werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Namen	N	Der Name der Version.	Standardstruktur
id	N	ID der Version. ID wird nur berücksichtigt, wenn der Name nicht vorhanden ist.	4
Inhalt des Elements
(Keine)

Tabellenblattelement
Tag-Name		Tabellenblatt
Beschreibung		Tabellenblatt, das durch Name oder ID definiert ist
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Namen	N	Der Name des Tabellenblatts	Spesen Cube
id	N	ID des Tabellenblatts. ID wird nur berücksichtigt, wenn der Name nicht vorhanden ist.	1
Inhalt des Elements
(Keine)

Ebenenelement
Tag-Name		level
Beschreibung		Ebene, die durch Name oder ID definiert ist
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Namen	N	Der Name der Ebene	Unternehmensplan
id	N	ID der Ebene. Die Ebene wird nur berücksichtigt, wenn der Name nicht vorhanden ist.	1
Inhalt des Elements
(Keine)

Antwortformat


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

Antwortelement
Tag-Name		-Antwort
Beschreibung		Ebene, die durch Name oder ID definiert ist
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder „true“ oder „false“, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten.	true
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement.

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.	invalid-attributevalueid
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. Ein optionales Kontextelement.