Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2025-10-03
updateDimensions

updateDimensions

Wird unterstützt in API v17 +
Für einen Einzelanforderungsaufruf von
updateDimensions
 -Anforderungen sind auf die Aktualisierung von maximal 10.000 Dimensionswerten in einer hierarchischen Dimension oder von 40.000 Dimensionswerten in einer flachen Dimension beschränkt. Diese Grenzwerte gelten nicht für die Erstellung neuer Dimensionswerte in einer Anforderung.
Kategorie
Änderung von Metadaten
Beschreibung
Aktualisieren Sie einen Satz vorhandener Dimensionen und deren Dimensionswerte. Mehrere Dimensionen und mehrere Werte können in einem Aufruf aktualisiert werden. Bei Erfolg gibt die API Details zu den Dimensionen zurück, die gerade aktualisiert wurden.
Zum Aufrufen sind Berechtigungen erforderlich
Modell und Berechtigungen für jede Dimension
Auf Anforderung erforderliche Parameter
Zugangsdaten
Die Anforderung dieser Methode enthält ein Credentials-Tag, um den aufrufenden Benutzer zu identifizieren und zu autorisieren. Benutzer muss über das "Modell" verfügen Konzept: Berechtigungssätze und die erforderliche Berechtigung zum Verwalten der zu aktualisierenden Dimensionen.
Best Practice: Aufrufen exportDimensions um die Planning-Dimensions-IDs abzurufen, die für Ihre updateDimensions-Anforderung erforderlich sind. Es sollten keine Änderungen an den Planning-Dimensionen über die Planning-Benutzeroberfläche oder über APIs von anderen vorgenommen werden, bevor Sie Ihre updateDimensions-Anforderung übermitteln.
HTTP
Beschreibung
Method
Post
Content-Type
text/xml

Beispiel für Locken


curl -H "Content-Type: text/xml" -d @C:/temp/updateDimVal.xml -X POST https://api.adaptiveplanning.com/api/v17
updateDimVal.xml contents

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Modified Graduate degree" />
   </dimension>
</dimensions>
</call>

Beispiel für das Rollieren einer XML-Datei anhängen



curl -i -X POST -H "Content-Type: multipart/form-data" -F "request=<C:/temp/requestCreateNewDimVal.xml" -F "content=@C:/temp/createNewDimVal.xml" https://api.adaptiveplanning.com/api/v17
requestCreateNewDimVal.xml content


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
</call>
createNewDimVal.xml


<?xml version='1.0' encoding='UTF-8'?>
<dimensions>
  <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
    <dimensionValue id="" name="Graduate" description="Graduate degree" />
  </dimension>
</dimensions>
Bei großen Nutzlasten können Sie zusammengefasste XML-Dateien (gezippt) hochladen. Siehe: Massenaktualisierung von Metadaten.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
<dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
     <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Tech1" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="33" name="Masters" description="Masters degree" shortName="" allVersions="0">
         <attribute name="Education Type" value="Management" />
         <version name="Budget 2017" available="1" />
     </dimensionValue>
     <dimensionValue id="34" name="Phd" description="Phd" shortName="" />
   </dimension>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">            
     <dimensionValue id="521" name="United States" description="USA" shortName="">                
       <dimensionValue id="555" name="Alabama" description="1" shortName="">                    
         <dimensionValue id="579" name="205" description="1" shortName="">                        
           <dimensionValue id="4718" name="35004" description="33" shortName="">                            
             <properties>                                
               <property name="Latitude" value="33.6015" />                                
               <property name="Longitude" value="86.4895" />                            
             </properties>                        
           </dimensionValue>                        
           <dimensionValue id="4719" name="35005" description="" shortName="" />                    
         </dimensionValue>                    
         <properties>                        
           <property name="Latitude" value="" />                        
           <property name="Longitude" value="86.9023" />                    
         </properties>                
       </dimensionValue>            
     </dimensionValue>        
   </dimension>
</dimensions>
</call>
Die folgenden Bedingungen gelten für updateDimensions:
  • Dimensionen und Dimensionswerte werden beide über ihre interne ID-Nummer für die Aktualisierung identifiziert.
  • "Währung", eine Systemdimension, kann nicht über API aktualisiert werden.
  • Um neue Dimensionen und Dimensionswerte zu erstellen, geben Sie diesen eine leere oder fehlende ID-Eigenschaft.
    • In einer vorhandenen Dimension können Sie einen vorhandenen (nicht neuen) Dimensionswert unter einen neuen Dimensionswert verschieben. Dadurch wird der neue Wert dimensionValue erstellt und der vorhandene Wert dimensionValue wird darunter als untergeordneter Wert verschoben.
  • Alle für flache Dimensionen erstellten Dimensionswerte sind standardmäßig in allen Planversionen sichtbar. Um die Sichtbarkeit anzugeben, müssen Sie dies explizit angeben, indem Sie eine der folgenden Optionen verwenden:
    • Die
      allVersions
       Attribut in
      dimensionValue
       -Tag
    • Oder Sie stellen das untergeordnete Element bereit
      version
       Tags unter
      dimensionValue
       , um eine benutzerdefinierte Sichtbarkeit zu bieten
    updateDimensions aktualisiert nur die Versionsverfügbarkeit für Planversionen. Sie können die Versionsverfügbarkeit für Istzahlen-Versionen nicht aktualisieren, auch wenn allVersions = 1.

Anforderungsformat für das Erstellen eines neuen Dimensionswerts

Um einen neuen Dimensionswert zu erstellen, schließen Sie den übergeordneten Wert anhand der ID ein. Beispiel: Um einen neuen untergeordneten Wert hinzuzufügen
Engr
 Wert, der hat
id 7
können Sie Folgendes verwenden:

<?xml version='1.0' encoding='UTF-8'?>
<call method="updateDimensions" callerName="Steve C">
 <credentials login="sampleuser@company.com" password="my_password"/>
 <dimensions>
   <dimension id="7">
     <dimensionValue id="" name="Documentation" description="docs" shortName="" >
       <properties>                                
         <property name="OwnerID" value="58371998"/>                                                            
       </properties>        
     </dimensionValue>
   </dimension>
 </dimensions>  
</call>
Diese Methode ändert nichts am Wert
id 7
. Es wird ein neues untergeordnetes Element mit dem Namen erstellt
Docs
 für
id 7
. Alle nicht erwähnten untergeordneten Elemente werden an das Ende der untergeordneten Liste verschoben. Dies entspricht „Übergeordnetes Element festlegen“ für den neuen Wert, wird jedoch erreicht, indem dieses übergeordnete Element als Element eingeschlossen wird.

Anforderungsformat für das Erstellen eines neuen Dimensionswerts mit Code und Name

Um einen neuen Dimensionswert zu erstellen, schließen Sie den übergeordneten Wert anhand der ID ein. Um beispielsweise einen neuen untergeordneten Wert unter dem Wert Engr mit der ID 7 hinzuzufügen, können Sie Folgendes verwenden:
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="Steve C">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions displayNameEnabled="1">
   <dimension id="7">
      <dimensionValue id="" code ="Doc" name="Documentation" description="docs" shortName="">
         <properties>
            <property name="OwnerID" value="58371998" />      
         </properties>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Eingabeformat 1: Nutzlast enthält gesamten Dimensionsbaum

Die updateDimensions-API funktioniert am besten, wenn ein Aufrufer den neuen Baumstatus bereitstellen möchte, ohne sich um Änderungen sorgen zu müssen.
Die updateDimensions-API ermittelt Änderungen in der Dimensionsstruktur und nur die geänderten oder neuen Dimensionen/Dimensionswerte werden aktualisiert. Die
dimensions
 -Element enthält nur 1 direktes untergeordnetes Element
dimension
 oder
dimensionValue
 -Element.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Geography" property1="Latitude" property2="Longitude">
      <dimensionValue id="521" name="United States" description="USA" shortName="">
         <dimensionValue id="555" name="Alabama" description="1" shortName="">
            <dimensionValue id="579" name="205" description="1" shortName="">
               <dimensionValue id="4718" name="35004" description="33" shortName="">
                  <properties>
                     <property name="Latitude" value="33.6015" />
                     <property name="Longitude" value="86.4895" />
                  </properties>
               </dimensionValue>
               <dimensionValue id="4719" name="35005" description="" shortName="" />
            </dimensionValue>
            <properties>
               <property name="Latitude" value="" />
               <property name="Longitude" value="86.9023" />
            </properties>
         </dimensionValue>
      </dimensionValue>
   </dimension>
</dimensions>
</call>

Eingabeformat 2: Nutzlast enthält Dimensionsunterbaumstruktur

Dieses Format unterstützt Anwendungsfälle, in denen Änderungen nur auf einen Teil der Dimensionsbaumstruktur beschränkt sind.
Die updateDimensions-API ermittelt Änderungen in der Dimensionsstruktur und nur die geänderten oder neuen Dimensionen/Dimensionswerte werden aktualisiert. Die
dimensions
 -Element enthält nur 1 direktes untergeordnetes Element
dimensionValue
 -Element.
Änderungen erfolgen beispielsweise in Alabama:
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName="">
      <dimensionValue id="579" name="205" description="1" shortName="">
         <dimensionValue id="4718" name="35004" description="33" shortName="">
            <properties>
               <property name="Latitude" value="33.6015" />
               <property name="Longitude" value="86.4895" />
            </properties>
         </dimensionValue>
         <dimensionValue id="4719" name="35005" description="" shortName="" />
      </dimensionValue>
   </dimensionValue>
</dimensions>
</call>
Für flache Dimensionen müssen Sie die übergeordnete Dimension angeben
dimension
 Tag unter
dimensions
 -Tag, gefolgt von mindestens einem Dimensionswert
dimensions
 -Element enthält nur 1 direktes untergeordnetes Element
dimension
 -Element.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimension id="16" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0">
      <dimensionValue id="521" name="Graduate" shortName="" description="Graduate degree" />
      <dimensionValue id="522" name="Masters" shortName="" description="Masters degree" />
   </dimension>
</dimensions>
</call>

Eingabeformat 3: Aktualisierung eines einzelnen Dimensionswerts

Dieses Format unterstützt Anwendungsfälle, in denen Änderungen auf nur einen Dimensionswert beschränkt sind.
Die
dimensions
 -Element enthält nur 1 direktes untergeordnetes Element
dimensionValue
 -Element.
Verwenden Sie beim Aktualisieren eines einzelnen Dimensionswerts nur das Eingabeformat 3. Eingabeformat 3 ist nicht das bevorzugte Format für die Aktualisierung mehrerer Dimensionswerte. Sie können keine neuen Dimensionen/Dimensionswerte mit diesem Format erstellen. Verwenden Sie das Eingabeformat 2 zum Hinzufügen neuer Dimensionen/Dimensionswerte.
<?xml version="1.0" encoding="UTF-8"?>
<call method="updateDimensions" callerName="a string that identifies your client application">
<credentials login="sampleuser@company.com" password="my_pwd" />
<dimensions>
   <dimensionValue id="555" name="Alabama" description="1" shortName=""/>
</dimensions>
</call>

Verarbeitung mehrerer Umbenennungen in einem einzigen updateDimensions-Aufruf

Zwischendurch können mehrere Umbenennungen derselben Entität in einem Remote-System stattfinden
updateDimensions
 -Anrufe. Die Namen von Entitäten im Remote-System können durch dieselben Entitäts-IDs ersetzt werden. Wann
updateDimensions
 -Aufrufe erfolgen nach dem Namenstausch
updateDimensions
 aufrufen verwaltet diese Änderungen, indem die IDs bei Namensänderungen verfolgt werden. Der Aufruf kann auch die Einführung einer neuen ID verarbeiten, die einen vorhandenen Namen verwendet.
Damit jedes der Beispiele erfolgreich ist, muss der vollständige Tausch der IDs mit den eindeutigen Werten erfolgen.
Beispiel 1: Ein einfacher Namenstausch im Remote-System.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             AA
Beispiel 2: Eine Sequenz von drei Umbenennungen im Remote-System.

ID     Unique Value   New Unique Value
1      AA             BB
2      BB             CC
3      CC             AA
Beispiel 3: Eine neue Entität, die einen vorhandenen eindeutigen Wert verwendet.

ID     Unique Value   New Unique Value
4                     AA
1      AA             BB
2      BB             Old BB
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
login
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 Adaptive Planning hat, kann dieses Attribut 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)
Element „Dimensionen“.
Tag-Name
Dimensionen
Beschreibung
Enthält eine oder mehrere Dimensionen oder Dimensionswerte.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
retainExistingOrder
Verfügbar in API v27 und höher
N
RetainExistingOrder = "1" gibt an, dass die updateDimensions API die Reihenfolge der Elemente in der XML-Nutzlast ignorieren soll und die vorhandene definierte Reihenfolge beibehalten wird.
RetainExistingOrder = "0" gibt an, dass die updateDimensions API die Reihenfolge der Elemente basierend auf der Tag-Position relativ zu anderen gleichgeordneten Elementen in der XML-Nutzlast aktualisieren soll.
Das Kennzeichen behältExistingOrder wird ignoriert, wenn für die Dimension das Kennzeichen behältSorted aktiviert ist.
Der Standardwert für retainExistingOrder ist "1".
1
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
displayNameEnabled=1 gibt an, dass updateDimensions die Eigenschaften des Anzeigenamens von berücksichtigen sollen
code
,
displayNameType
, und
description
 wenn Enable Anzeige Name für die Instanz EIN ist.
displayNameEnabled=0 gibt an, dass die updateDimensions API weiterhin den API-Vertrag vor v30 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die updateDimensions API ignoriert die Eigenschaften des Anzeigenamens
code
,
displayNameType
 und
description
.
Der Standardwert für displayNameEnabled ist „0“.
Inhalt des Elements
Enthält eine oder mehrere Dimensionen oder Dimensionswerte.
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
-Code
Verfügbar in API v39 und höher.
Der Code der Dimension. Der Code muss eindeutig sein.
NewDimensionCode
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.
Alle Änderungen an den Komponenten eines Anzeigenamens ändern die Sortierreihenfolge der Elemente, auch wenn Sortierung beibehalten aktiviert ist.
0
displayNameType
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Steuert die Anzeige von Dimensionswerten. Mögliche Werte sind NAME, CODE, NAME_CODE oder CODE_NAME.
Der Standardwert ist NAME, wenn leer gelassen oder nicht angegeben wird.
Diese Eigenschaft ist nur verfügbar, wenn "Anzeigename aktivieren" für die Instanz auf EIN gesetzt ist.
"CODE_NAME"
Beschreibung
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Die Beschreibung der Dimension.
Diese Eigenschaft ist nur verfügbar, wenn "Anzeigename aktivieren" für die Instanz auf EIN gesetzt ist.
"Der Abstieg über Dim"
Eigenschaft1, Eigenschaft2, ...
N
Die Eigenschaften der Dimension, falls vorhanden, wie sie in der Dimensionsverwaltung eingegeben wurden. Jede Dimension kann bis zu fünf Eigenschaften haben.
"Barten"
Inhalt des Elements
Optionale dimensionValue-Elemente.
Element dimensionValue
Tag-Name
dimensionValue
Beschreibung
Gibt einen zu aktualisierenden Dimensionswert an.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
id
J
Die ID des Dimensionswerts.
34
-Code
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Der eindeutige Code des Dimensionswerts.
NewDimensionValue
Name
J
Der Name des Dimensionswerts. Wenn Anzeigename aktivieren für eine Instanz mit API v30 oder höher auf EIN gesetzt ist, lässt der Name doppelte Werte zu. Wenn Anzeigename aktivieren für eine Instanz auf AUS gesetzt ist, ist Code nicht verfügbar und der Name muss eindeutig sein.
Zeilenumbruchzeichen (
&#10;)
 zwischen Worten gefunden werden, werden bei der Nutzlastverarbeitung durch ein einzelnes Leerzeichen ersetzt.
Zeilenumbruchzeichen, die am Anfang oder Ende des Namens gefunden werden, werden ebenfalls durch einzelne Leerzeichen ersetzt. Diese Leerzeichen werden aufgrund des Entfernens von Leerzeichen während der Nutzlastverarbeitung nicht in der Benutzeroberfläche angezeigt.
NewDimensionValue
shortName
N
Der Kurzname des Dimensionswerts.
NewDimensionValueShortName
Beschreibung
N
Die Beschreibung des Dimensionswerts.
Dies ist ein Wert von NewDimensionValue
allVersions
N
„1“ bedeutet, dass der Dimensionswert in allen Planversionen verfügbar ist, „0“ bedeutet, dass dies nicht der Fall ist. Wenn allVersions fehlt, ist der Standardwert 1.
updateDimensions aktualisiert nur die Versionsverfügbarkeit für Planversionen. Sie können die Versionsverfügbarkeit für Istzahlen-Versionen nicht aktualisieren, auch wenn allVersions = 1.
Um eine bestimmte Versionsverfügbarkeit anzugeben, setzen Sie alleVersionen auf 0 und geben Sie die Verfügbarkeit des Dimensionswerts für jede Version an.
Beispiel: Angenommen, es gibt Versionen 2018a, 2018b, 2018c, 2018d. So nehmen Sie einen Dimensionswert nur in Version 2018b auf:
<dimensionValue .... allVersions="0"> <version name="2018a" verfügbar="0"> <version name="2018c" verfügbar="0"> <version name="2018d" verfügbar="0" >
Wenn im Beispiel oben allVersions="1" gilt, werden die untergeordneten Versionselemente ignoriert.
0
Inhalt des Elements
Kann das optionale Element „Properties“ enthalten.
Attributelement
Tag-Name
Attribut
Beschreibung
Container für ein Dimensionsattributelement. Erfordert einen bereits vorhandenen Attributnamen und -wert.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name des Dimensionsattributs
Standort
Wert
aktualisiert in API v34
J
Der Wert des Dimensionsattributs.
Wenn der Dimensionsimport automatisch Attributwerte erstellt in der Verwaltungsoberfläche des Dimensionsattributs aktiviert ist, wird jeder Attributwert, der noch nicht vorhanden ist, zu einem neuen Attributwert in der Root-Dimension.
Für API v32 und v33 ist dieses Attribut nur sinnvoll, wenn die Einstellung „Anzeigename“ für die Instanz auf „AUS“ gesetzt ist.
Für API v34 und höher:
  • Wird unterstützt, wenn die Einstellung Effektiver Anzeigename auf EIN gesetzt ist.
  • Das Vorhandensein von valueCode und valueName führt zu einem Fehler.
  • Wenn „Dimensionsimport erstellt automatisch Attributwerte“ in der Benutzeroberfläche der Attributverwaltung aktiviert ist, wird die Wertezeichenfolge zum Code und zum Namen, wenn der Wert noch nicht vorhanden ist.
Setzen Sie value="", um dieses Attribut-Tagging zu entfernen.
SFO
valueCode
Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren.
Wird in API v34 nicht unterstützt.
J
Der Code des Attributwerts für dieses Attribut.
Die Eingabe valueCode ist nur sinnvoll, wenn displayNameEnabled=1 und die Einstellung Anzeigename für die Instanz in API v32 und API v33 auf EIN gesetzt ist.
Setzen Sie valueCode="", um dieses Attribut-Tagging zu entfernen.
SFO
valueName
Nur in API v32 und API v33 für Instanzen verfügbar, die den Anzeigenamen aktivieren.
Wird in API v34 nicht unterstützt.
N
Der Name für einen neu automatisch erstellten Attributwert.
Das Attribut ist nur in folgenden Fällen sinnvoll:
  • valueCode enthält einen nicht vorhandenen Attributwert.
  • Die Einstellung "Anzeigename" ist für die Instanz EIN.
  • displayNameEnabled=1
  • API v32 und API v33 werden aufgerufen.
valueName wird ignoriert, wenn valueCode einen vorhandenen Attributwert enthält.
San Francisco
Inhalt des Elements
(Keine)
-Versionselement
Tag-Name
Version
Beschreibung
Gibt die Planversionsverfügbarkeit eines Dimensionswerts an. Erfordert eine bereits vorhandene Planversion. Die Versionsverfügbarkeit kann für virtuelle, ausgeblendete, Istzahlen-, gesperrte oder archivierte Versionen nicht geändert werden.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name der Version, wie er in der Versionsverwaltung angezeigt wird.
Budget 2015
verfügbar
J
Wenn 1, ist dieser Dimensionswert in dieser Version verfügbar.
1
Inhalt des Elements
Ein oder mehrere Versionselemente für jeden Dimensionswert.
Properties-Element
Wird unterstützt in API v22
Tag-Name
-Eigenschaften
Beschreibung
Optionales Element, das Eigenschaftselemente enthält.
Attribute des Elements
(Keine)
Inhalt des Elements
Enthält bis zu fünf Eigenschaftselemente.
Eigenschaftselement
Wird unterstützt in API v22
Tag-Name
-Eigenschaft
Beschreibung
Gibt eine zu aktualisierende benutzerdefinierte Eigenschaft an. Die Eigenschaftselementwerte dürfen nur numerische Zeichen enthalten.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name der Eigenschaft.
Breitengrad
Wert
J
Der Wert der Eigenschaft. Ein leerer Wert löscht den Eigenschaftswert für den Dimensionswert.
33.6015
Inhalt des Elements
(Keine)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<messages>
 <message type="INFO">Dimension was saved successfully.</message>
</messages>
<output>
 <dimensions>
   <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0" status="">
     <dimensionValue id="44" name="Documentation" description="docs" shortName="" status="created">
     </dimensionValue>
   </dimension>
   <dimension id="16" name="Geography" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="0" property1="Latitude" property2="Longitude" status="">                
     <dimensionValue id="521" name="United States" shortName="" description="USA" status="">                    
       <dimensionValue id="555" name="Alabama" shortName="" description="1" status="">                        
         <dimensionValue id="579" name="205" shortName="" description="1" status="">                            
           <dimensionValue id="4718" name="35004" shortName="" description="33" status="">                                
             <properties>                                    
               <property name="Latitude" value="33.6015" status="created" />                                    
               <property name="Longitude" value="86.4895" status="" />                                
             </properties>                            
           </dimensionValue>                            
           <dimensionValue id="4719" name="35005" shortName="" description="" status="" />                        
         </dimensionValue>                        
         <properties>                            
           <property name="Latitude" value="" status="deleted" />                            
           <property name="Longitude" value="86.9023" status="updated" />                        
         </properties>                    
       </dimensionValue>                
     </dimensionValue>            
   </dimension>
 </dimensions>
</output>
</response>
Element „Dimensionen“.
Tag-Name
Dimensionen
Beschreibung
Enthält eine oder mehrere Dimensionen oder Dimensionswerte.
Attribute des Elements
(Keine)
Inhalt des Elements
Enthält eine oder mehrere Dimensionen oder Dimensionswerte.
retainExistingOrder
N
Bei "0" sollte die updateDimensions API die Sortierreihenfolge basierend auf dem Inhalt der XML-Nutzlast aktualisieren.
Bei "1" sollte die updateDimensions API die vorhandene Sortierreihenfolge beibehalten.
1
displayNameEnabled
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
displayNameEnabled=1 gibt an, dass updateDimensions die Eigenschaften des Anzeigenamens von berücksichtigen sollen
code
,
displayNameType
, und
description
 wenn Enable Anzeige Name für die Instanz EIN ist.
displayNameEnabled=0 gibt an, dass die updateDimensions API weiterhin den API-Vertrag vor 2021.42 einhalten soll, auch wenn "Anzeigenamen aktivieren" für die Instanz auf EIN gesetzt ist. Die updateDimensions API ignoriert die Eigenschaften des Anzeigenamens
code
,
displayNameType
 und
description
.
Die Unterstützung für displayNameEnabled beginnt in 2021.42. Der Standardwert für displayNameEnabled ist „0“.
1
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
Für die Erstellung wird die neue ID bereitgestellt.
16
Name
J
Der Name der Dimension, wie er in Berichten und Tabellenblättern angezeigt wird.
Customer
-Code
Verfügbar in API v39 und höher.
N
Der Code der Dimension.
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
displayNameType
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Steuert die Anzeige von Dimensionswerten. Mögliche Werte sind NAME, CODE, NAME_CODE oder CODE_NAME.
Der Standardwert ist NAME, wenn leer gelassen oder nicht angegeben wird.
Diese Eigenschaft ist nur verfügbar, wenn "Anzeigename aktivieren" für die Instanz auf EIN gesetzt ist.
CODE_NAME
Beschreibung
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Die Beschreibung der Dimension.
Eigenschaft1,Eigenschaft2, ...
N
Die benutzerdefinierten Eigenschaften der Dimension.
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
Für die Erstellung wird die neue ID bereitgestellt.
16
-Code
Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Der eindeutige Code des Dimensionswerts.
Ein Unternehmen
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
status
J
Status des Dimensionswerts nach dem Aktualisieren Bei Warnungen und Fehlern enthält das Nachrichtenelement den Nachrichteninhalt. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück.
  • Fehler: In der Entität wurde ein Fehler gefunden
  • Warnung: In der Entität wurde eine Warnung gefunden
  • Erstellt: Die Entität wurde erfolgreich erstellt
  • Aktualisiert: Die Entität wurde erfolgreich aktualisiert
aktualisiert
Nachricht
N
Die Fehlermeldung für eine ungültige Eingabe dimensionValue.
Der Dimensionsname "ProductsFirst01234567890123456 ..." darf maximal 64 Zeichen lang sein
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.
Attributelement
Tag-Name
Attribut
Beschreibung
Container für ein Dimensionsattributelement.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name des Dimensionsattributs
Standort
Wert
aktualisiert in API v32
J
Der Wert des Dimensionsattributs.
Für API v32 und höher ist dieses Attribut nur sinnvoll, wenn die Einstellung „Anzeigename“ für die Instanz auf „AUS“ gesetzt ist.
San Francisco
valueCode
Nur in API v32 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
J
Der Code des Attributwerts für dieses Attribut.
Für API v32 und höher ist valueCode nur in folgenden Fällen sinnvoll:
  • Die Einstellung "Anzeigename" ist für die Instanz EIN.
  • displayNameEnabled=1
SFO
valueName
Nur in API v32 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.
N
Der Name für einen neu automatisch erstellten Attributwert.
Das Attribut ist nur in folgenden Fällen sinnvoll:
  • valueCode enthält einen nicht vorhandenen Attributwert.
  • Die Einstellung "Anzeigename" ist für die Instanz EIN.
  • displayNameEnabled=1value
Der Name wird ignoriert, wenn valueCode einen vorhandenen Attributwert enthält.
San Francisco
status
J
Status des Dimensionswerts nach dem Aktualisieren Bei Warnungen und Fehlern enthält das Nachrichtenelement den Nachrichteninhalt. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück.
  • Fehler: In der Entität wurde ein Fehler gefunden
  • Warnung: In der Entität wurde eine Warnung gefunden
  • Erstellt: Die Entität wurde erfolgreich erstellt
  • Aktualisiert: Die Entität wurde erfolgreich aktualisiert
aktualisiert
Nachricht
N
Die Fehlermeldung für eine ungültige Attributeingabe.
Inhalt des Elements
(Keine)
-Versionselement
Tag-Name
Version
Beschreibung
Gibt die Planversionsverfügbarkeit eines Dimensionswerts an.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Name
J
Der Name der Version, wie er in der Versionsverwaltung angezeigt wird.
Budget 2015
verfügbar
J
Wenn 1 vorhanden ist, ist dieser Dimensionswert in dieser Planversion verfügbar.
1
status
J
Status des Dimensionswerts nach dem Aktualisieren Bei Warnungen und Fehlern enthält das Nachrichtenelement den Nachrichteninhalt. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück.
  • Fehler: In der Entität wurde ein Fehler gefunden
  • Warnung: In der Entität wurde eine Warnung gefunden
  • Erstellt: Die Entität wurde erfolgreich erstellt
  • Aktualisiert: Die Entität wurde erfolgreich aktualisiert
aktualisiert
Nachricht
N
Die Fehlermeldung bei einer ungültigen Versionseingabe.
Inhalt des Elements
Ein oder mehrere Versionselemente für jeden Dimensionswert.
Properties-Element
Tag-Name
-Eigenschaften
Beschreibung
Enthält bis zu fünf Eigenschaftselemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Enthält bis zu fünf Eigenschaftselemente.
Eigenschaftselement
Tag-Name
-Eigenschaft
Beschreibung
Gibt eine zu aktualisierende benutzerdefinierte Eigenschaft an.
Attribute des Elements
Name des Attributs
Wert
Beispiel
Name
Der Name der Eigenschaft.
Breitengrad
Wert
Der Wert der Eigenschaft. Ein leerer Wert löscht den Eigenschaftswert für den Dimensionswert.
33.6015
Status
Status der Eigenschaft nach dem Aktualisieren Bei einem Fehler enthält das Nachrichtenelement den Inhalt der Fehlermeldung. Der Status "Aktualisiert" gibt keine Nachrichteninhalte zurück.
  • Fehler: In der Entität wurde ein Fehler gefunden
  • Erstellt: Die Entität wurde erfolgreich erstellt
  • Aktualisiert: Die Entität wurde erfolgreich aktualisiert
  • Nichts geändert: Ein leerer Status bedeutet, dass für die Entität nichts geändert wurde.
Meldung
Die Fehlermeldung für eine ungültige Eingabe für eine Eigenschaft.
Eigenschafts-Tag erfordert ein Namensattribut.