importDimensionMapping

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	Übermittlung von Metadaten
Beschreibung	Die importDimensionMapping-API kann zum Importieren abgeleiteter Dimensionswerte verwendet werden.
Zum Aufrufen sind Berechtigungen erforderlich
Auf Anforderung erforderliche Parameter	Zugangsdaten

Mit der importDimensionMapping-API können Sie die Mapping-Bedingungen importieren, die festlegen, dass die Mapping-Dimensionswerte automatisch in Zeilen von modellierten Tabellenblättern ausgefüllt werden. Mit ihm können Sie Mapping-Bedingungen erstellen, aktualisieren und löschen. Abgeleitete Dimensionswerte in Zeilen von modellierten Tabellenblättern unterstützen keine virtuellen Versionen.

Anforderungsformat

<?xml version='1.0' encoding='UTF-8'?>
<call method="importDimensionMapping" callerName="a string that identifies your client application">
  <credentials login="sampleuser@company.com" password="my_password"/>
  <version name="Budget 2017" id="7"/>
  <dimensions>
        <dimension id="345" name="Area">
            <mappingCriteria>
                <mappingCriterion id="121">
                    <mapTo dimensionValueId="877" dimensionValue="East"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" valueId="15" value="MA"/>
                </mappingCriterion>
                <mappingCriterion id="122">
                    <mapTo dimensionValueId="876" dimensionValue="West"/>
                    <dimension name="Level" valueId="1" value="HQ"/>
                    <dimension name="State" id="5">
                        <dimensionValue id="900" code="CA"/>
                        <dimensionValue id="901" code="CO"/>
                    </dimension>
                </mappingCriterion>
            </mappingCriteria>
        </dimension>
    </dimensions>
</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 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 API-Methode exportInstances , um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

Element „Version“.
Tag-Name		Version
Beschreibung		Gibt die Version an, für die Mappings importiert werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	Erforderlich, wenn keine ID angegeben wurde.	Der Name der Version.	Budget 2017
id	Erforderlich, wenn kein Name angegeben ist.	Die Versions-ID	7
Inhalt des Elements
Enthält ein oder mehrere Ebenenelemente.

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	Erforderlich, wenn keine ID angegeben wurde.	Der Name der Dimension, in die Mappings importiert werden sollen	Fläche
id	Erforderlich, wenn kein Name angegeben ist.	Die ID der Dimension, in die Mappings importiert werden sollen.	15
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
löschen	N	Geben Sie "Ja" ein, um alle Mapping-Bedingungen im Mapping-Kriterium zu löschen. Ein leerer Wert oder ein anderer Wert als "Ja" wird ignoriert und die Mapping-Bedingungen werden nicht gelöscht.	Ja
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
dimensionValue	Erforderlich, wenn dimensionValueId nicht angegeben ist.	Der Name des Dimensionswerts, mit dem dieses Mapping-Kriterium gemappt ist.	Fläche
dimensionValueId	Erforderlich, wenn dimensionValue nicht angegeben ist.	Der Name der Dimensionswert-ID, mit der dieses Mapping-Kriterium gemappt ist.	12
Inhalt des Elements
(Keine)

Element „Dimension“.
Tag-Name		Dimension
Beschreibung		Beschreibt eine der Dimensionen, aus der der Dimensionswert mapTo abgeleitet wird. Es ist mindestens ein Dimensionselement für die Dimension "Ebene" erforderlich, sowie ein Dimensionselement für eine benutzerdefinierte Dimension.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	Erforderlich, wenn keine ID angegeben wurde.	Der Name der Dimension	Branche
id	Erforderlich, wenn kein Name angegeben ist.	Die ID der Dimension
Wert	N	Der Name des Dimensionswerts. Erforderlich, es sei denn, dimensionValue ist vorhanden	Einzelhandel
valueId	N	Die ID des Dimensionswerts. Entweder this oder value ist erforderlich, es sei denn, DimensionValue- Elemente sind vorhanden
Inhalt des Elements
dimensionValue-Elemente

Element dimensionValue
Tag-Name		dimensionValue
Beschreibung		(Optional) Wenn für ein Dimensions- Tag mehr als ein Dimensionswert aufgelistet werden muss, kann anstelle des Wertattributs eine Reihe von DimensionValue -Tags verwendet werden.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Name	J	Der Name des Dimensionswerts	Einzelhandel
-Code Verwenden Sie in API v30 und höher Code anstelle des Namens.	Erforderlich, wenn keine ID angegeben wurde.	Der Code des Dimensionswerts	Einzelhandel
id	Erforderlich, wenn kein Code angegeben ist.	Die ID des Dimensionswerts	25
Inhalt des Elements
(Keine)

Beispiele:


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Mapping-Kriterium, um die Dimensionswerte HQ in der Ebenendimension und MA in der Dimension „Bundesland“ mit dem Dimensionswert „Ost“ in der Dimension „Bereich“ zu mappen. Zeilen, in denen beide Werte übereinstimmen, werden um „Ost“ erweitert. Da das Attribut "id" angegeben ist, ersetzt dieses Mapping-Kriterium ein vorhandenes Mapping-Kriterium durch diese ID.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion id="123">
            <mapTo dimensionValue="East"/>
            <dimension name="Level" value="HQ"/> 
            <dimension name="State" value="MA"/> 
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Mapping-Kriterium, um die Dimensionswerte HQ in der Ebenendimension und CA oder CO in der Dimension „Bundesland“ mit dem Dimensionswert „Ost“ in der Dimension „Bereich“ zu mappen. Zeilen, in denen beide Werte übereinstimmen, werden um „Ost“ erweitert.


<dimension name="Area">                      
    <mappingCriteria>
        <mappingCriterion>
            <mapTo dimensionValue="East"/>   
            <dimension name="Level" value="HQ"/> 
            <dimension name="State">         
                <dimensionValue code="CA"/>  
                <dimensionValue code="CO"/>
            </dimension>
        </mappingCriterion>
    </mappingCriteria>
</dimension>

Antwortformat

Erfolgreiche Antwort


<?xml version="1.0" encoding="UTF-8"?>
<response success="true"/>

Fehlerantwort


<?xml version="1.0" encoding="UTF-8"?>
<response success="false">
    <messages>
        <message>There are duplicate mapping conditions. Make all mappingCriterion conditions unique</message>
    </messages>
</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.

message-Element
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.

exportVersions

importGroups

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