exportDimensionMapping

Adaptive Planning

Workday Adaptive Planning-Dokumentation (Workday 2025R2)
Integration
Datenintegration verwalten
API-Dokumentation
Metadaten und Methoden zum Erstellen, Aktualisieren und Lesen von Daten

Zuletzt aktualisiert: 2023-06-23

Wird unterstützt in API v19 +

Kategorie	Abrufen von Metadaten
Beschreibung	Exportiert die abgeleiteten Kriterien für das Dimensions-Mapping für eine oder mehrere Dimensionen in eine bestimmte Version.
Zum Aufrufen sind Berechtigungen erforderlich
Auf Anforderung erforderliche Parameter	Zugangsdaten

Diese API wird verwendet, um eine Liste von Mapping-Kriterien für eine oder mehrere abgeleitete Dimensionen abzurufen. Für jede Dimension in der Anforderung werden mapTo-Werte und Dimensionswertbedingungen abgerufen.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <dimensions>
    <dimension name="Area">                       
    </dimension>
  </dimensions>
  <version name = "Budget 2017"/>
  <filters>
    <keyword value="Alameda" />
    <levels>
      <level code="HQ" includeDescendants="true" />
    </levels>
    <dimensionValues>
      <dimensionValue dimName="Geography" code="California" />
      <dimensionValue dimId="34" uncategorized="true" />
      <dimensionValue dimName="Region" code="Bay Area" uncategorized="true" />
      <dimensionValue dimId="19" id="78" />
    </dimensionValues>
    <attributes>
      <attribute id="1" uncategorized="true"/>
      <attribute name="attributeName1" value="attributeValue1"/>
      <attribute id="3" valueId="31" uncategorized="true"/>
    </attributes>
  </filters>
</call>

Element credentials
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 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. Ermitteln Sie die verfügbaren Instanzcodes mithilfe der API-Methode xref.	MYINSTANCE1
Inhalt des Elements
(Keine)

Element „Version“.
Tag-Name		Version
Beschreibung		Gibt an, aus welcher Version die modellierten Zeilen abgerufen werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der Version.	Budget 2017
Inhalt des Elements
(Keine)

Element „Dimensionen“.
Tag-Name		Dimensionen
Beschreibung		Container für eine Liste von <dimension>-Elementen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Dimensionselemente

Element „Dimension“.
Tag-Name		Dimension
Beschreibung		Beschreibt eine Dimension, für die Mappings importiert werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der Dimension, für die Mappings importiert werden sollen	Fläche
Inhalt des Elements
Ein mappenCriteria-Element

filtert Element
Tag-Name		Filter
Beschreibung		Enthält die Spezifikationen für die Filter, die bestimmen, welche Daten aus der angeforderten Version und Dimension(en) von der API abgerufen werden. Dieses Element gibt das Schlüsselwort, die Ebenen und die Dimensionswerte an, die in den entsprechenden Mapping-Kriterien enthalten sind.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Ein einzelnes optionales Element Schlüsselwort , ein einzelnes optionales Element Ebenen und ein optionales einzelnes Element DimensionValues .

Ebenen-Element
Tag-Name		Ebene(n)
Beschreibung		Container für Elemente mit null oder einer Ebene .
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Null oder ein Ebenenelement

Ebenenelement
Tag-Name		level
Beschreibung		Gibt eine Organisationsebene an, deren Daten in diesem API-Aufruf exportiert werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der zu exportierenden Ebene. Dieser Name ist in der Organisationsverwaltung angegeben.	Entwicklung
-Code Verwenden Sie in API v30 und höher Code anstelle des Namens.	Erforderlich, wenn keine ID angegeben wurde.	Der Code der zu exportierenden Ebene. Dieser Code wird in der Organisationsverwaltung angegeben.	Entwicklung
id	Erforderlich, wenn kein Code angegeben ist.	Die interne System-ID der zu exportierenden Ebene.	8
includeDescendants	J	Gibt an, ob der Export alle Nachfolger der angegebenen Ebene einschließen soll oder nicht. Wenn auf „true“ gesetzt, werden auch alle untergeordneten Ebenen exportiert, ebenso wie ihre untergeordneten Ebenen usw. Bei "false" wird diese Ebene allein exportiert.	Wahr
Inhalt von Element
(Keine)

Element dimensionValues
Tag-Name		dimensionValues
Beschreibung		Container für null oder mehr dimensionValue- Elemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt von Element
Null oder mehr dimensionValue- Elemente.

Element dimensionValue
Tag-Name		dimensionValue
Beschreibung		Gibt an, dass die exportierten Daten nur die Mapping-Kriterieneingaben enthalten sollen, die den übereinstimmenden angegebenen dimensionValue enthalten. Wenn sich mehr als ein Element "dimensionValue" im Element "dimensionValues" befindet, müssen die exportierten Mapping-Kriterieneinträge alle angegebenen Dimensionen/Werte enthalten. Beispiel: Wenn für eine Anforderung die Dimensionswerte "Region" = "East" und "Product" = "Product_A" angegeben sind, muss das Mapping-Kriterium "Region" East enthalten und "Product" Product_A enthalten, um exportiert zu werden. Beachten Sie außerdem, dass jeder Wert dimensionValue im Element dimensionValues zu einer anderen Dimension gehören muss. Beispielsweise wird eine Anforderung mit den Dimensionswerten Region = Ost und Region = West nicht akzeptiert. Falls die Dimensionen für den Eingabefilter nicht zu einer der angeforderten Dimensionen gehören, werden sie ignoriert.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
dimName	erforderlich, wenn uncategorizedOfDimension nicht angegeben ist	Der Name der Dimension, zu der der Dimensionswert gehört (siehe Namensattribut unten).	Region
Name	N	Der Name des zu exportierenden Dimensionswerts.	USA West
-Code Nur in API v30 und höher für Instanzen verfügbar, die den Anzeigenamen aktivieren.	Erforderlich, wenn keine ID angegeben wurde	Der Code des zu exportierenden Dimensionswerts.	USA West
Ohne Kategorie	N	Wenn diese Option auf „true“ gesetzt ist, enthalten die exportierten Daten das Mapping-Kriterium nur mit dem übereinstimmenden Dimensionswert und nicht mit den Werten seiner Nachfolger (falls vorhanden). Hat keine Auswirkungen auf Dimensionswerte ohne untergeordnete Elemente. Wenn nicht angegeben, wird standardmäßig „false“ verwendet.	wahr
dimId	erforderlich, wenn dimName nicht angegeben ist.	Die interne System-ID der Dimension, zu der der Dimensionswert (siehe Namensattribut oben) gehört.	15
uncategorizedOfDimension	N	Geben Sie uncategorizedOfDimension anstelle der Attribute dimName/uncategorized an . Wenn angegeben, sollte der Wert des Attributs eine interne System-ID-Nummer einer Dimension (nicht ein Dimensionswert) sein und der Filter gibt an, dass Daten in dieser Dimension vollständig ohne Kategorie sein müssen, damit sie mit dem Filter übereinstimmen. Die Attribute ohne Kategorie werden ignoriert und als wahr angenommen. Wird ignoriert, wenn dimName angegeben ist.	15
id	Erforderlich, wenn kein Code angegeben ist	Geben Sie die ID anstelle der Namensattribute an. Die interne System-ID des zu exportierenden Dimensionswerts. Muss anstelle der Namensattribute angegeben werden, um den Dimensionswert anzugeben. Informationen zu internen IDs finden Sie in der exportDimensions -API. Wird ignoriert, wenn der Name angegeben wird.	14
Inhalt von Element
(Keine)

Antwortformat


<response success="true">
 <output>
        <mappings>
            <version name="Budget 2017"/>
            <dimensions>
                <dimension name="Area">
                    <mappingCriteria>
                        <mappingCriterion id="121">
                            <mapTo dimensionValue="East"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State" value="MA"/>
                        </mappingCriterion>
                        <mappingCriterion id="122">
                            <mapTo dimensionValue="West"/>
                            <dimension name="Level" value="HQ"/>
                            <dimension name="State">
                                <dimensionValue name="CO"/>
                                <dimensionValue name="CA"/>
                            </dimension>
                        </mappingCriterion>
                    </mappingCriteria>
                </dimension>
            <dimensions/>
        </mappings>
    </output>
</response>

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
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement.

Element „Dimensionen“.
Tag-Name		Dimensionen
Beschreibung		Container für eine Liste von <dimension>-Elementen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
(Keine)
Inhalt des Elements
Dimensionselemente

Element „Dimension“.
Tag-Name		Dimension
Beschreibung		Beschreibt eine Dimension, für die Mappings importiert werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der Dimension, für die Mappings importiert werden sollen	Fläche
Inhalt des Elements
Ein mappenCriteria-Element

mappingCriteria Element
Tag-Name		mappingCriteria
Beschreibung – Beschreibung		Container für eine Liste von <mappingCriterion>-Elementen
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	N	Wenn eine ID angegeben wird, wird ein vorhandenes Mapping-Kriterium mit dieser ID aktualisiert. Wenn keine ID angegeben wird, wird der Dimension ein neues Mapping-Kriterium hinzugefügt.	12
Inhalt des Elements
mappenKriteriumselemente für jeden Dimensionswert für die abgeleitete Dimension.

mappingCriterion Element
Tag-Name		mappingCriterion
Beschreibung – Beschreibung		Beschreibt die einzelnen Dimensionen und Dimensionswerte, die bestimmen, ob mit einem Dimensionswert gemappt wird. Es muss eine Gruppe von mapTo- , dimension- und dimensionValue -Tags folgen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	N	Wenn eine ID angegeben wird, wird ein vorhandenes Mapping-Kriterium mit dieser ID aktualisiert. Wenn keine ID angegeben wird, wird der Dimension ein neues Mapping-Kriterium hinzugefügt.	12
Inhalt des Elements
Enthält ein mapTo-Element und bis zu sechs Dimensionselemente.

mapTo-Element
Tag-Name		mapTo
Beschreibung		Gibt den Dimensionswert an, der basierend auf den Mapping-Kriterien abgeleitet wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
dimensionValueId	J	Die ID des Dimensionswerts, mit dem dieses Mapping-Kriterium gemappt ist.	11
dimensionValue	J	Der Name des Dimensionswerts, mit dem dieses Mapping-Kriterium gemappt ist.	Kalifornien
dimensionValueCode	J	Der Code des Dimensionswerts, mit dem dieses Mapping-Kriterium gemappt ist.	CA
dimensionValueDisplayName	J	Der Anzeigename des Dimensionswerts, mit dem dieses Mapping-Kriterium gemappt ist.	Kalifornien
Inhalt des Elements
(Keine)

Element „Dimension“.
Tag-Name		Dimension
Beschreibung		Beschreibt eine der Dimensionen, aus der der Dimensionswert mapTo abgeleitet wird.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name der Dimension	Fläche
ValueId	N	Die ID des Dimensionswerts. Erforderlich, es sei denn, DimensionValue-Elemente sind vorhanden.	282
Wert	N	Der Name des Dimensionswerts. Erforderlich, es sei denn, DimensionValue-Elemente sind vorhanden	West
valueCode	N	Der Code des Dimensionswerts. Erforderlich, es sei denn, DimensionValue-Elemente sind vorhanden.	Wir
valueDisplayName	N	Der Anzeigename des Dimensionswerts. Erforderlich, es sei denn, DimensionValue-Elemente sind vorhanden.	West
Inhalt des Elements
(Keine)

Element dimensionValue
Tag-Name		dimensionValue
Beschreibung		(Optional) Wenn für ein Dimensions- Tag mehr als ein Dimensionswert aufgelistet werden muss, kann anstelle des Namensattributs eine Reihe von DimensionValue -Tags verwendet werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die ID des Dimensionswerts	10
Name	J	Der Name des Dimensionswerts	Colorado
-Code	J	Der Code des Dimensionswerts	CO
displayName	J	Der Anzeigename des Dimensionswerts	Colorado
Inhalt des Elements
(Keine)

Nachrichtenelement
Tag-Name	-Nachrichten
Beschreibung	Container für ein oder mehrere Nachrichtenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein 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.

exportLokales

exportModeledSheet

War dies hilfreich?

Was erfordert unsere Aufmerksamkeit? Zutreffend Beantwortet meine Frage Leicht zu finden Leicht zu verstehen Hilft mir bei der Bearbeitung meiner Aufgabe Vollständig und mit Details

Was erfordert unsere Aufmerksamkeit? Nicht zutreffend Beantwortet nicht meine Frage Nicht leicht zu finden Nicht leicht zu verstehen Hilft mir nicht bei der Bearbeitung meiner Aufgabe Unvollständig oder ohne Details

Beschreiben Sie uns Ihre Aufgabe. Welche zusätzlichen Informationen könnten diesen Inhalt verbessern? Möchten Sie weitere Details teilen?

Vollständiger Name

E-Mail

Workday nutzt Ihren Namen und Ihre E-Mail-Adresse, um Ihnen Antworten zu Ihrem Feedback zu geben. Ihre Daten werden entsprechend unserer Datenschutzerklärung behandelt.

Vielen Dank für Ihr Feedback