createDimensionValue
Wird in API v20 + nicht unterstützt. Verwenden Sie updateDimensions.
Kategorie
| Änderung von Metadaten |
Beschreibung
| Erstellen Sie einen Dimensionswert. Bei Erfolg gibt die API Details für die Dimension und alle Dimensionswerte zurück, einschließlich des gerade erstellten Werts. |
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. Diese Methode gibt einen Fehler zurück, wenn unveröffentlichte Änderungen vorhanden sind.
Anforderungsformat
<?xml version='1.0' encoding='UTF-8'?> <call method="createDimensionValue" callerName="fred"> <credentials login="sampleuser@company.com" password="my_pwd" /> <dimensionValue dimensionId="10" name="New Dimension Value"> <attributes> <attribute attributeId="20" valueId="170" /> </attributes> </dimensionValue> </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) | |||
Element dimensionValue
| |||
Tag-Name
| dimensionValue | ||
Beschreibung
| Gibt einen zu erstellenden Dimensionswert an. | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
dimensionId | J | Die ID der Dimension. Entweder DimensionId oder ParentId muss angegeben werden | 34 |
parentId | N | Die ID des übergeordneten Dimensionswerts. Entweder DimensionId oder ParentId muss angegeben werden. | 220 |
Name | J | Der Name des Dimensionswerts. | NewDimensionValue |
shortName | N | Die Beschreibung des Dimensionswerts. | NewDimensionValue- ShortName |
Beschreibung | N | Die Beschreibung des Dimensionswerts. | Dies ist ein Wert von NewDimensionValue |
Inhalt des Elements
| |||
(Keine) | |||
Element „Attribute“.
| |||
Tag-Name
| Attribute | ||
Beschreibung
| Container für ein oder mehrere Dimensionsattributelemente | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Inhalt des Elements
| |||
Ein oder mehrere Attributelemente. | |||
Element „Attribute“.
| |||
Tag-Name
| Attribut | ||
Beschreibung
| Container für ein oder mehrere Dimensionsattributelemente | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
attributeID | J | Die ID des vom System generierten Dimensionsattributs. | 20 |
valueID | J | Die eindeutige ID des vom System generierten Dimensionsattributwerts. Wenn dieser Wert 0 ist, wird dieses Attribut aus dem Konto entfernt. | 170 |
Inhalt des Elements
| |||
(Keine) | |||
Antwortformat
Dies sind Beispiele für Antworten nach erfolgreicher und nicht erfolgreicher Erstellung eines Dimensionswerts.
Erfolgreiches Beispiel
<?xml version='1.0' encoding='UTF-8'?> <response success="true"> <output> <dimensions> <dimension id="6" name="Department" shortName="" autoCreate="0" listDimension="0" keepSorted="0" useOnLevels="1"> <dimensionValue id="7" name="Engr" description="Engineering" shortName=""> <dimensionValue id="52" name="QA" description="Quality Assurance" shortName="" /> <dimensionValue id="53" name="Dev" description="Development" shortName="" /></dimensionValue> </dimension> <dimension id="7" name="Education" shortName="" autoCreate="0" listDimension="1" keepSorted="0" useOnLevels="0"> <dimensionValue id="32" name="Graduate" description="Graduate degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="197" value="Tech1" /> </attributes> </dimensionValue> <dimensionValue id="33" name="Masters" description="Masters degree" shortName=""> <attributes> <attribute attributeId="21" name="Education Type" valueId="196" value="Management" /> </attributes> </dimensionValue> <dimensionValue id="34" name="Phd" description="Phd" shortName="" /> </dimension> </dimensions> </output> </response>
Fehlerbeispiel
<?xml version='1.0' encoding='UTF-8'?> <response success="false"> <messages> <message type="ERROR" key="invalid-attributevalueid" values="-50">Invalid attribute value id: "-50"</message> </messages> </response>
Dimensionen werden nach Name sortiert.
Antwortelement
| |||
Tag-Name
| -Antwort | ||
Attribute des Elements
| |||
Name des Attributs
| erforderlich?
| Wert
| Beispiel
|
Erfolg haben | J | Entweder wahr oder falsch, was angibt, ob der API-Aufruf erfolgreich war oder nicht. Selbst erfolgreiche Aufrufe können in ihrer Antwort Warnmeldungen enthalten. | wahr |
veraltet | N | Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden. | false |
Inhalt des Elements
| |||
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement. | |||
Ausgabeelement
| |||
Tag-Name
| Ausgabe | ||
Attribute des Elements
| |||
(Keine) | |||
Inhalt des Elements
| |||
Ein einzelnes Kontenelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein. | |||
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
| Beschreibung | ||
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 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. | Techl |
Inhalt des Elements
| |||
(Keine) | |||