updateAssociations

Adaptive Planning

updateAssociations

Kategorie	Änderung von Metadaten
Beschreibung	Beteiligung/Zuordnung für Entitäten aktualisieren (z. B. Ebene). Mehrere Zuordnungen mit mehreren Werten können in einem Aufruf aktualisiert werden. Bei erfolgreicher Ausführung gibt die API eine Erfolgsmeldung zurück. Wenn die API fehlschlägt, wird eine umfassende Liste der Fehler und deren Ursachen zurückgegeben.
Zum Aufrufen sind Berechtigungen erforderlich	Modellmanagement: Modellmodellmanagement: Organisationsstruktur: Alle Ebenen Administratorzugriff: Benutzer
Auf Anforderung erforderliche Parameter	Zugangsdaten

Siehe: Konzept: Zuordnungen und Zuordnungen importieren.

Die folgenden Bedingungen gelten für updateAssociations:

Jede Zuordnung hat eine Art, einen optionalen Vorgang und einen Satz von Dim-Wert-IDs (Entitäts-IDs).

Um eine neue Zuordnung zu erstellen, geben Sie die Entitäts-ID (z. B. Ebenen-ID), der die Eigentümerschaft zugewiesen werden soll, und die Liste der Benutzer-IDs (ID, WID oder Benutzername) an.

Wenn für eine Zuordnung dieselbe Entitäts-ID mehrmals erwähnt wird, wird die letzte verwendet.

Benutzer, die in der Anforderung angegeben, aber nicht im System vorhanden sind, werden ignoriert. Die verbleibenden gültigen Benutzer in der Anforderung werden verarbeitet und ihre Zuordnungsdetails werden aktualisiert.

Für benutzerdefinierte Dimensionszuordnungen sind Code, Name und Dim-ID erforderliche Felder.

Die Anforderung kann null oder nur eine Zuordnung zur Ebeneneigentümerschaft enthalten. Für alle anderen Ebenenzuordnungen sind die zusätzlichen Felder „Code“, „Name“ und „DimId“ erforderlich.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="updateAssociations" callerName="me">
<credentials login="sampleuser@greenco.com" password="my_pwd"/>
<associations>
  <association type="level" operation = "update">
   <dimValueIds>
     <dimValueId id = "2">
         <users>
             <id> 1, 2, 3 , 87654</id>
         </users>        
     </dimValueId>
     <dimValueId id = "24">
         <users>
             <WID>23,12</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
     <dimValueId id = "6">
         <users>
             <id> 1, 2, 3 </id>
             <username>johno@greenco.com, johnstevec@greenco.com</username>
             <WID> ABC, CSD </WID>
         </users>
     </dimValueId>
     <dimValueId id = "12">          
     </dimValueId>      
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD1" name="CustomDim1" operation="replaceAll" dimId="8">
   <dimValueIds>
     <dimValueId id = "86">
         <users>
             <id> 14, 45</id>
         </users>        
     </dimValueId>
     <dimValueId id = "92">
         <users>
             <id>20, 21</id>
             <WID>ABCD</WID>
             <username>stevec@grEENco.com</username>
         </users>
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="customdimension" code= "CD2" name="CustomDim2" operation="update" dimId="4">
   <dimValueIds>
     <dimValueId id = "16">
         <users>
             <id> 20, 21</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
 <association type="level" code= "TL2" name="TestLevels2" operation="update" dimId="-1">
   <dimValueIds>
     <dimValueId id = "1">
         <users>
             <id> 15</id>
         </users>        
     </dimValueId>
   </dimValueIds>
 </association>
</associations>
</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 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 „Zuordnungen“.
Tag-Name		Zuordnungen
Beschreibung		Pro Nutzlast ist nur eine Anforderung von Zuordnungselementen zulässig. Es enthält ein oder mehrere Zuordnungselemente.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel

Inhalt des Elements
Enthält ein oder mehrere Zuordnungselemente.

Zuordnungselement
Tag-Name		Zuordnung
Beschreibung		Gibt die Zuordnung an, die für die Liste der Entitäten erstellt/aktualisiert werden soll.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
type	y	Die Art der Entität, für die die Zuordnung erstellt/aktualisiert werden soll. Er kann nur die folgenden Werte annehmen: level customdimension	level
Vorgang	N	Der Betriebsmodus für diese Zuordnung. Kann nur die folgenden Werte annehmen - (update oder ersetzenAlle) Bei Operation = "replaceAll" werden alle vorhandenen Beteiligungseinträge für diese Zuordnungsart gelöscht und nur die in der Anforderung genannten Beteiligungsdetails gespeichert. Bei Operation = "update" werden nur die in der Anforderung genannten Entitäts-IDs (z. B. Ebenen-IDs) aktualisiert. Wenn der Vorgang nicht erwähnt wird, wird standardmäßig das Verhalten „Aktualisieren“ verwendet.	aktualisieren
-Code	Bedingt	Der Code der Zuordnung, die erstellt/aktualisiert werden soll. Der einzige Fall, in dem dies nicht erforderlich ist, ist die Ebeneneigentümerschaft. In allen anderen Fällen erforderlich.	TL1
Name	Bedingt	Der Name der Zuordnung, die erstellt/aktualisiert werden soll. Der einzige Fall, in dem dies nicht erforderlich ist, ist die Ebeneneigentümerschaft. In allen anderen Fällen erforderlich.	TestLevels1
dimId	Bedingt	Die ID, für deren dimValueIds die Beteiligungsdetails aktualisiert werden sollen. Erforderlich bei benutzerdefinierter Dimension.	12
Inhalt des Elements
Enthält ein dimValueIds-Element.

Element dimValueIds
Tag-Name		dimValueIds
Beschreibung		Gibt die Liste von dimValueId an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel

Inhalt des Elements
Enthält ein oder mehrere dimValueId-Elemente.

dimValue-Element
Tag-Name		dimValueId
Beschreibung		Gibt an
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID-Nummer für die Entität.	23
Inhalt des Elements
Enthält höchstens ein Benutzerelement. Wenn das Element „Benutzer“ nicht erwähnt wird, wird die gesamte vorhandene Eigentümerschaft für „dmiValueId“ entfernt.

Element „Benutzer“.
Tag-Name		Benutzer(n)
Beschreibung		Gibt die Benutzer-IDs in den Elementen id, WID oder username an.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel

Inhalt des Elements
Enthält die Liste der durch Kommas getrennten Benutzer-IDs. Im System nicht vorhandene Benutzer werden ignoriert/übersprungen. Wenn keine der Benutzer-IDs erwähnt wird, wird die gesamte vorhandene Eigentümerschaft für die Entität (dimValueId) entfernt. Wenn dasselbe ID-Tag mehrmals in einem bestimmten Benutzer-Tag angegeben wird, gibt der Aufruf eine Fehlerbedingung zurück. <id> 1, 2, 3 : Dies gibt an, dass die Eigentümerschaft für Benutzer mit den IDs 1, 2 und 3 zugewiesen werden soll. <username>nach oben <WID> ABC, CSD <WID>: Dies gibt an, dass die Eigentümerschaft für Benutzer mit der Workday-ID ABC und CSD vergeben werden soll.

Antwortformat


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <messages>
     <message type="INFO">Associations were saved successfully.</message>
 </messages>
</response>

Antwortelement
Tag-Name		-Antwort
Beschreibung		Gibt an
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
Erfolg haben	J	Entweder „true“ oder „false“, was angibt, ob der API-Aufruf erfolgreich war oder nicht.	wahr
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement.

Nachrichtenelement
Tag-Name		-Nachrichten
Beschreibung		Container für ein oder mehrere Nachrichtenelemente
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel

Inhalt des Elements
Enthält 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 waren, und für Bestätigungsmeldungen bei erfolgreichen Anforderungen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
type	N	Gibt die Art der Nachricht an.	INFO FEHLER WARNUNG
Inhalt des Elements

Beschreibungen der Fehlermeldungen

Art	Meldung	Beispiel/Beschreibung
Fehler	Fehler: Element "Y" unvollständig; fehlt erforderliches Element "Y"	In der Anforderung fehlt das erforderliche Element - z. B. Zuordnung dimValue-ID
Fehler	Wert des Attributs "Art" ist ungültig; muss gleich "Ebene" sein	Der Zuordnung ist eine falsche Art zugeordnet.
Fehler	DimValue-ID darf höchstens ein Benutzerelement haben.	Die dimValue-ID darf höchstens ein Benutzerelement haben.
Warnung	Benutzer-ID -5 nicht im System vorhanden. WID -98A nicht im System vorhanden. Benutzername-ID stevec@comp ist nicht im System vorhanden.	Die Werte für die Benutzer-ID sind falsch. Sie wurden übersprungen und die verbleibenden gültigen Benutzer wurden verarbeitet.
Fehler	DimValue-ID -123 ist nicht im System vorhanden.	Die Dim-Wert-ID ist falsch.