importGroups

Kategorie	Änderung von Metadaten
Beschreibung	Importieren Sie Benutzergruppen, die Sie im Kernsystem von Workday oder in einem externen System erstellt haben. Bei erfolgreicher Ausführung gibt die API die Details für die importierten Gruppen zurück. Sie können diese API nicht verwenden, um Benutzergruppen zu aktualisieren, die auf der Benutzeroberfläche von Adaptive Planning erstellt wurden.
Zum Aufrufen sind Berechtigungen erforderlich	Berechtigung Globale Benutzergruppen verwalten
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

„Administratorzugriff“

Globale Benutzergruppen verwalten verfügen,

um die Benutzergruppen zu importieren.

Anforderungsformat

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

Attribute abfragen

Name	Beschreibung	Erforderlich
dataSource	Quelle für die Benutzergruppendaten: WORKDAY. Die Quelle der Benutzergruppendaten ist Workday. Diese Gruppen können in Adaptive Planning nicht bearbeitet werden. EXTERN. Die Quelle der Benutzergruppendaten ist ein anderes System außerhalb von Workday. Auf der Seite „Allgemeines Setup“ kann Ihr Administrator die Bearbeitung von Gruppen mit einer Externen-Datenquelle aktivieren. Sie können diese Gruppen dann über die Benutzeroberfläche von Adaptive Planning aktualisieren. Siehe: Referenz: Allgemeines Setup.	J
-Modus	Modus für den API-Aufruf: REPLACE_ALL. Der Modus ersetzt alle Benutzergruppen in Ihrer Adaptive Planning-Instanz durch die Benutzergruppen, die Sie in der Nutzlast angeben. AKTUALISIEREN. Der Modus aktualisiert nur die Benutzergruppen, die Sie in der Nutzlast angeben.	J
userIdentifier	Die ID für die in den Benutzergruppen angegebenen Benutzer: Benutzername Der Benutzername für den angegebenen Benutzer. userGUID. Die globale Benutzer-ID für den angegebenen Benutzer. wid Die Workday-ID des angegebenen Benutzers.	J

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 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 zum Interpretieren von eingehenden Zahlen und Datumsangaben verwendet werden soll. Außerdem müssen Sie ausgehende Zahlen und Datumsangaben formatieren (mithilfe des entsprechenden Tausendertrennzeichens, der Zeitperiodennamen und der Datumsformatierung). Das Gebietsschema gibt auch die Sprache an, in der alle 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 angeben, 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

-Gruppenelement
Tag-Name		-Gruppe
Beschreibung		Gibt einen Satz von Benutzergruppen an, der erstellt oder aktualisiert werden soll.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
externalID	J	Die externe ID der Benutzergruppe.	user_group_1
Name	J	Der Name der Benutzergruppe.	Sicherheitsadministratoren
Inhalt des Elements
Element „Benutzer“.

-Benutzerelement
Tag-Name		Benutzer
Beschreibung		Gibt einen oder mehrere Benutzer an, die zur Benutzergruppe hinzugefügt werden sollen.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
userGUID	Y (vorausgesetzt, die vom API-Aufrufer angegebene Benutzer-ID ist userGUID)	Die globale ID des Benutzers.	B9ADBCB81AA2F9BAE040307F02092C2
userName	Y (vorausgesetzt, die vom API-Aufrufer angegebene Benutzer-ID ist userName)	Der Benutzername des Benutzers.	updateMail@company.com
wid	Y (vorausgesetzt, die vom API-Aufrufer angegebene Benutzer-ID ist wid)	Die Workday-ID des Benutzers.	A9ADBCB81AA2F9BAE040307F02092C2E
Inhalt des Elements
Im Falle eines ungültigen Benutzers (z. B. ungültig userGUID/UserName/WID) wird ein bestimmter ungültiger Benutzer übersprungen und die Anforderung wird für die Gruppe der restlichen gültigen Benutzer verarbeitet. Für die folgenden Szenarien mit Elementen von <user> wird jedoch die gesamte Gruppe in der Nutzlast abgelehnt. Fehlende Benutzer-ID: <user/> <user userName=""/> <user userName/userGUID/wid=" "/> Fehlermeldung; Benutzer-ID fehlt. Geben Sie einen gültigen Wert für userName/userGUID/WID für alle Benutzer an. WID ungültiges Format: Länge der Workday-ID kleiner oder größer als 32 Zeichen. Fehlermeldung: Geben Sie eine gültige Benutzer-ID für alle Benutzer an. userGUID ungültiges Format: userGUID ist kleiner oder größer als 32 Zeichen. userGUID ist nicht alphanumerisch. Fehlermeldung: Geben Sie eine gültige userGUID für alle Benutzer an.

Antwortformat

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </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. Auch erfolgreiche Aufrufe können Warnmeldungen in ihrer Antwort enthalten.	wahr
Inhalt des Elements
Je nachdem, ob Sie Create oder Update aufgerufen haben, ein einzelnes Ergebniselement mit den Statuselementen Created_UserGroup oder Updated_UserGroup.

imported_groups element
Tag-Name		imported_groups
Name des Attributs	erforderlich?	Wert	Beispiel
Gruppenerfolg	J	Der zurückgegebene Status „true“ oder „false“.	"true"
Nachricht	J	Statusmeldung.	"Benutzergruppe - Neue Benutzergruppe wurde erfolgreich erstellt". "Nutzlast teilweise erfolgreich bei der Verrechnung von Benutzerzugehörigkeiten. Versuchen Sie es erneut. Wenn das Problem weiterhin besteht, wenden Sie sich an den Support.“
Inhalt des Elements
Keine.