updateDimension

Wird in API v20 + nicht unterstützt. Verwenden Sie updateDimensions.

Kategorie	Änderung von Metadaten
Beschreibung	Aktualisieren Sie eine Dimension. Bei erfolgreicher Ausführung gibt die API Details für die Dimension zurück, die gerade aktualisiert wurde.
Zum Aufrufen sind Berechtigungen erforderlich	Modell
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 über die Berechtigung "Modell" verfügen, um die Dimension zu erstellen.

Die folgenden Bedingungen gelten für diese API:

Diese Methode gibt einen Fehler zurück, wenn unveröffentlichte Änderungen vorhanden sind.

Sie können listDimension nicht deaktivieren, wenn Sie Dimensionsattribute definiert haben oder die Werte nicht in allen Versionen verfügbar sind.

Sie können listDimension nicht deaktivieren, wenn Sie hierarchische Dimensionswerte haben.

Sie können useOnLevels und listDimension nicht gleichzeitig aktivieren. (Es ist möglich, das eine und das andere mit demselben Befehl zu deaktivieren.)

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimension" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <dimension id="34"
       name="Updated Dimension Name"
     />
</call>

Element „Zugangsdaten“.
Tag-Name		-Zugangsdaten
Beschreibung		Alle API-Aufrufe müssen ein einzelnes Element mit den Zugangsdaten enthalten, 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 Monatsnamen und der 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)

Dimensionselement
Tag-Name		Dimension
Beschreibung		Gibt eine zu erstellende Dimension an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die ID der zu aktualisierenden Dimension.	34
Name	N	Der Name der Dimension. Der Name muss eindeutig sein.	NewDimensionName
shortName	N	Anzeigbarer Titel der Spalte, wie im Tabellenblatt angezeigt.	NewDimensionShortName
listDimension	N	„1“ bedeutet, dass es sich um eine Listendimension handelt, „0“ (oder nicht angegeben) bedeutet, dass dies nicht der Fall ist.	0
useOnLevels	N	„1“ bedeutet, dass diese Dimension auf Ebenen verwendet werden kann. „0“ (oder keine Angabe) bedeutet, dass dies nicht möglich ist.	0
autoCreate	N	„1“ bedeutet, dass Werte für diese Dimension über den Import erstellt werden können. „0“ (oder keine Angabe) bedeutet, dass dies nicht möglich ist.	0
keepSorted	N	„1“ bedeutet, dass Werte für diese Dimension immer alphabetisch sortiert werden. „0“ (oder keine Angabe) bedeutet, dass sie manuell sortiert werden können.	0
Inhalt des Elements
(Keine)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <dimensions>
           <dimension id="41" name="New Dimension Name" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0">
           </dimension>
       </dimensions>
   </output>
</response>

Element „Dimensionen“.
Tag-Name	Dimensionen
Beschreibung	Container für ein oder mehrere Dimensionselemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein oder mehrere Dimensionselemente.

Dimensionselement
Tag-Name		Dimension
Beschreibung		Stellt eine einzelne benutzerdefinierte Dimension dar, die in der Antwort auf einen exportDimensions-API-Aufruf zurückgegeben wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für die Dimension. Dies kann verwendet werden, um Dimensionen in anderen API-Aufrufen zu identifizieren, z. B. exportDimensionFamilies.	16
Name	J	Der Name der Dimension, wie er in Berichten und Tabellenblättern angezeigt wird.	Customer
shortName	N	Der Kurzname für die Dimension, falls vorhanden, wie in der Dimensionsverwaltung eingegeben	Kunde
autoCreate	J	1, wenn für die ausgewählte Dimension der Feldsatz „Datenimport erstellt automatisch Dimensionswerte“ gesetzt ist; Andernfalls 0.	0
listDimension	J	1, wenn die ausgewählte Dimension eine Listendimension ist; Andernfalls 0.	1
keepSorted	J	1, wenn die ausgewählte Dimension sortiert bleibt, andernfalls 0.	1
useOnLevels	J	1, wenn die ausgewählte Dimension auf Ebenen verwendet werden kann, andernfalls 0.	1
Inhalt des Elements
Null oder mehr dimensionValue-Elemente. Jedes eingeschlossene Element dimensionValue stellt einen „Root-Dimensionswert“ in der Dimension dar, einen Wert ohne übergeordneten Wert.

Element dimensionValue
Tag-Name		dimensionValue
Beschreibung		Stellt einen einzelnen Elementwert einer benutzerdefinierten Dimension dar, der in der Antwort auf einen exportDimensions-API-Aufruf zurückgegeben wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für diesen Elementwert der Dimension.	34
Name	J	Das Label für den Elementwert der Dimension, wie in Berichten angezeigt und in Formeln verwendet.	Ein Unternehmen
shortName	N	Der Kurzname für den Dimensionswert, falls vorhanden, wie in Dimensionsverwaltung eingegeben	A
Beschreibung	N	Die Beschreibung des Dimensionswerts, falls vorhanden, wie in Dimensionsverwaltung eingegeben	Ein Unternehmen
Inhalt des Elements
Null oder mehr optionale dimensionValue-Elemente. Jedes eingeschlossene Element dimensionValue stellt einen „untergeordneten Dimensionswert“ dieses Dimensionswerts dar, dessen Elemente implizit ein Rollup zu diesem Wert durchführen.

Element „Attribute“.
Tag-Name		Attribute
Beschreibung		Container für ein oder mehrere Dimensionsattributelemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Attributelemente.

Attributelement
Tag-Name		Attribut
Beschreibung		Container für ein Dimensionsattributelement.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
attributeID	J	Die ID des vom System generierten Dimensionsattributs.	20
Name	J	Der Name des Dimensionsattributs	Art der Ausbildung
valueID	J	Die eindeutige ID des vom System generierten Dimensionsattributwerts.	170
Wert	J	Der Wert des Dimensionsattributs.	Tech1
Inhalt des Elements
(Keine)