Zum Hauptinhalt wechseln
Dokumentation
Dokumentation
Adaptive Planning
Zuletzt aktualisiert: 2023-06-23
createLevel

createLevel

Wird in API v20 + nicht unterstützt. Verwenden Sie updateLevels.
Kategorie
Änderung von Metadaten
Beschreibung
Erstellen Sie eine Ebene. Bei erfolgreicher Ausführung gibt die API Details für die gerade erstellte Ebene zurück.
Zum Aufrufen sind Berechtigungen erforderlich
Organisationsstruktur
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 Organisationsstruktur verfügen, um die Ebene 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="createLevel" callerName="fred">
    <credentials login="sampleuser@company.com" password="my_pwd" />
    <level
       name="New Level Name"
       shortName="NewLvlName"
       parentId="2"
    >
         <attributes>
             <attribute attributeId="20" valueId="199" />
         </attributes>
     </level>
</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)
Ebenenelement
Tag-Name
level
Beschreibung
Gibt eine zu erstellende Ebene an.
Attribute des Elements
parentId
J
Die ID der Ebene, von der diese Ebene als untergeordnet erstellt werden soll.
34
Name
J
Der Name der Ebene. Der Name muss eindeutig sein.
Neuer Name der Ebene
shortName
N
Der Kurzname der Ebene.
NewLvName
proceed- WithWarnings
N
Gibt an, ob der Benutzer Warnmeldungen ignorieren und mit dem Erstellungsvorgang fortfahren möchte. 0 für „Nein“ und „1“ für „Ja“. Wenn Warnungen vorhanden sind und proceedWithWarnings = 0 gilt, wird die Ebene nicht erstellt. Setzen Sie proceedWithWarnings = 1, um die Ebene bei Warnungen zu erstellen.
1
Inhalt des Elements
Ein Element für optionale Attribute, wenn Sie ein oder mehrere Ebenenattribute festlegen möchten, die der Ebene zugeordnet sind.
Element „Attribute“.
Tag-Name
Attribute
Beschreibung
Container für ein oder mehrere Ebenenattributelemente.
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 Ebenenattributelement.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
attributeID
J
Die ID des vom System generierten Ebenenattributs.
20
valueID
J
Die eindeutige ID des vom System generierten Ebenenattributwerts. Wenn dieser Wert 0 ist, wird dieses Attribut aus dem Konto entfernt.
170
Inhalt des Elements
(Keine)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
   <output>
       <levels>
           <level="41" name="New Level Name" shortName="NewLvlName" currency="USD">
               <attribute attributeId="20" name="Regional Code" valueId="199" value="A-145" />
           </level>
       </levels>
   </output>
</response>
Ausgabeelement
Tag-Name
Ausgabe
Attribute des Elements
(Keine)
Inhalt des Elements
Ein einzelnes erforderliches Ebenenelement. Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.
Element „Ebenen“.
Tag-Name
Ebene(n)
Beschreibung
Container für das Element Ebenen.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
Inhalt des Elements
Ein oder mehrere Ebenenelemente. Wenn die Anforderung unzugängliche Ebenen enthält, gibt es nur ein Ebenenelement, das die oberste Ebene der Organisation darstellt.
Ebenenelement
Tag-Name
level
Beschreibung
Stellt eine einzelne Organisationsebene dar, die in der Antwort auf einen API-Aufruf exportLevels zurückgegeben wird.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
id
J
Die interne System-ID der Ebene.
7
Name
J
Der Name der Ebene, wie er in Berichten und Tabellenblättern angezeigt wird.
Entwicklung
Währung
J
Der Währungscode für die Währung, die dieser Ebene der Organisation zugewiesen ist. Die Währung ist eine der konfigurierten Währungen für die Instanz, die im Aufruf exportActiveCurrencies gefunden wurde.
INR
shortName
N
Die Abkürzung für die Ebene, falls vorhanden, wie in „Verwaltung der Organisation“ eingegeben.
Abw
availableStart
N
Das Startdatum für die Verfügbarkeit der Ebene für die Istzahlen-Version, das nur gilt, wenn die Istzahlen-Version in der Anforderung angegeben wird. Der Wert kann entweder ein bestimmter Monat im Format „MM/JJJJ“ sein oder der Sonderwert „START“, der den Versionsstart angibt.
01/2013
availableEnd
N
Das Enddatum für die Verfügbarkeit der Ebene für die Istzahlen-Version, das nur gilt, wenn die Istzahlen-Version in der Anforderung angegeben wird. Der Wert kann entweder ein bestimmter Monat im Format „MM/JJJJ“ sein oder der Sonderwert „END“, der das Versionsende angibt.
12/2013
isImportable
N
Gibt an, ob die zugeordnete Ebene in der angegebenen Version importierbar ist. "0" bedeutet, dass sie nicht importierbar ist und "1" bedeutet, dass sie importierbar ist. Eine Ebene ist importierbar, wenn mindestens ein Zeitfenster in der angegebenen Version importierbar ist. Das Attribut isImportable wird nur ausgegeben, wenn in der Anforderung versionName oder versionID angegeben ist.
Hinweis: isImportable gibt nur an, dass eine Ebene für den Import in der angegebenen Version verfügbar ist, und nicht, dass der Benutzer, der den API-Aufruf ausführt, die Berechtigung zum Importieren in die Version oder Ebene hat. Verwenden Sie exportVersions, um anzuzeigen, welche Versionen dem Benutzer für den Import zur Verfügung stehen.
1
workflowStatus
N
Gibt den Workflow-Status für die zugeordnete Ebene aus. I für „In Bearbeitung“, S für „Übermittelt“, R für „Abgelehnt“, A für „Genehmigt“ und L für „Gesperrt“. Wird nur in die Antwort aufgenommen, wenn Workflow für dieses Unternehmen aktiviert ist und in der Anforderung eine PlanversionName oder eine Versions-ID angegeben ist. Workflow ist für Istzahlen-Versionen nicht verfügbar.
I
isLinked
J
Gibt an, ob die Ebene eine verknüpfte Ebene ist. 0 für „Nein“ und „1“ für „Ja“.
1
isElimination
J
Gibt an, ob die Ebene eine Eliminierungsebene ist. 0 für „Nein“ und „1“ für „Ja“.
0
Inhalt des Elements
Ein verschachteltes Ebenenelement für jede direkt untergeordnete Ebene dieser Ebene. Ein Attributelement, wenn dieser Ebene mindestens ein Attribut zugeordnet ist.
Element „Attribute“.
Tag-Name
Attribute
Beschreibung
Container für ein oder mehrere Attributelemente.
Attribute des Elements
Name des Attributs
erforderlich?
Wert
Beispiel
(Keine)
Inhalt des Elements
Ein oder mehrere Attributelemente.
Attributelement
Tag-Name
Attribut
Beschreibung
Stellt ein einzelnes Attribut-Mapping für nicht leere Ebenen dar, dem eine Ebene zugeordnet ist.
Attribute des Elements
Name des Attributs
erforderlich
?
Wert
Beispiel
Name
J
Der Name des Ebenenattributs
Unternehmensrabatt
Wert
J
Der Wert des Ebenenattributs, das der Ebene zugeordnet ist.
Ja
attributeID
J
Die interne System-ID-Nummer des Ebenenattributs.
20
valueID
J
Die interne System-ID des Ebenenattributwerts.
188
Inhalt des Elements
(Keine)