exportInstanzen

Kategorie	Abrufen von Metadaten.
Beschreibung	Gibt Metadaten für die vollständige Liste aller Instanzen von zurück Adaptive Planning auf die dieser Benutzer Zugriff hat.
Zum Aufrufen sind Berechtigungen erforderlich	Keine (es müssen gültige Zugangsdaten für die Instanz sein)
Auf Anforderung erforderliche Parameter	Zugangsdaten

Die Anforderung dieser Methode enthält ein Tag mit Zugangsdaten, um den aufrufenden Benutzer zu identifizieren und zu autorisieren, und ein optionales Tag include, das angibt, welche Instanzen in die Antwort aufgenommen werden sollen. Sobald die Benutzerzugangsdaten verifiziert sind, gibt die Methode ein XML-Dokument zurück, das die in den Zugangsdaten angegebene Instanz beschreibt, oder den vollständigen Satz aller Instanzen, auf die dieser Benutzer Zugriff hat. Wenn das Feature „Multiple Instance“ nicht erworben wurde, gibt dieser Aufruf immer ein einzelnes Element für die Instanz zurück, zu der der Benutzer gehört.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportInstances" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
 <include accessibleInstances="true"/>
</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 verfügen, um die Aktion in Reihenfolge für die API auszuführen -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 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 nichts angegeben wird, wird die Standardinstanz des Benutzers verwendet. Verwenden Sie die exportInstances-API, um die verfügbaren Instanzcodes zu ermitteln.	MYINSTANCE1
Inhalt des Elements
(Keine)

Element einschließen
Tag-Name		einschließen
Beschreibung		Stellt eine Reihe von Kennzeichen dar, die angeben, welche Aspekte der Informationen zu den Instanzen in die Antwort aufgenommen oder daraus ausgeschlossen werden sollen. Dieses Element ist optional: Wenn es nicht vorhanden ist, ist der Standardwert für zugängliche Instanzen „false“.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
zugängliche Instanzen	N	Entweder wahr oder falsch. Ob die Antwort neben der in den Zugangsdaten angegebenen Einzelinstanz noch weitere Instanzen enthalten soll Wenn das Element oder sein Attribut nicht vorhanden ist, ist der Standardwert „false“. Wenn diese Option enthalten ist und auf „true“ gesetzt ist, sollte die API die Liste aller Instanzen zurückgeben, auf die der Benutzer Zugriff hat. Diese Instanzen werden nicht in einer verschachtelten oder übergeordneten Weise zurückgegeben. sie werden lediglich mit den Eigenschaften aufgelistet, wie in der API angezeigt. Die erste zurückgegebene Instanz ist immer die Standardinstanz für den Benutzer.	Falsch
Inhalt des Elements
(Keine)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
<output>
  <instances>
    <instance code="INSTANCE1" name="Globo Industries" sessionTimeout="60" calendarType="G" systemCurrency="USD" products="PLANNING,DISCOVERY" options="TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA" workdayTenantID="mytenant" workdayEnvironment="Prod" workdayUiUrl="www.myworkday.com/mytenant/d/home.html" workdayRestUrl="www.myworkday.com/ccx/service/" datasources="WORKDAY,GREAT PLAINS,INTACCT,SALESFORCE,NETSUITE" notificationType="NONE"/>
  </instances>
</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
veraltet	N	Wenn dieses Attribut im Antwort-Tag vorhanden ist und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet und offiziell veraltet ist. Auch wenn es zu diesem Zeitpunkt noch funktioniert, kann es sein, dass Sie in Kürze nicht mehr funktionieren. In der Regel ist dieses Attribut nicht vorhanden.	false
Inhalt des Elements
Ein einzelnes optionales Nachrichtenelement und genau ein erforderliches Ausgabeelement.

Ausgabeelement
Tag-Name	Ausgabe
Attribute des Elements
(Keine)
Inhalt des Elements
Ein einzelnes Kontenelement Dieser Ausgabe-Wraper ist ein Standard für alle API-Antworten und schließt die gültige Ausgabe jedes erfolgreichen API-Aufrufs ein.

Element "Instanzen"
Tag-Name	-Instanzen
Beschreibung	Container für ein oder mehrere Instanzelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein oder mehrere Instanzelemente.

Instanzelement
Tag-Name		-Instanz
Beschreibung		Beschreibt eine einzelne Instanz, auf die dieser Benutzer Zugriff hat, einschließlich einer Reihe von Attributen dieser Instanz.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
-Code	J	Der Instanzcode der Instanz. Dies kann verwendet werden, um eine alternative Instanz für einen API-Aufruf innerhalb des Elements "Zugangsdaten" anzugeben.	INSTANCE1
Name	J	Der Name der Instanz. Dies wird unter Verwaltung > Allgemeines Setup für diese Instanz konfiguriert.	Global Branchen
SessionTimeout	J	Timeout in Minuten der Benutzersitzung.	60
Systemwährung	J	Der ISO-Code für die Systemwährung.	USD
-Produkte	J	Kommagetrennte Liste der Produktnamen, die für die Instanz aktiviert sind.	PLANNING, CONSOLIDATION, DISCOVERY, INTEGRATION
Optionen	J	Kommagetrennte Liste der verschiedenen Module, die für die Instanz aktiviert sind.	TRANSACTIONS,MULTI_CURRENCY,DISCO_DISABLED,WORKDAY,PLANNING_VISUALIZE_DATA
-Datenquellen	J	Durch Kommas getrennte Liste der Datenquellen, die für die Instanz aktiviert sind.	WORKDAY, NETSUITE, SALESFORCE
workdayTenantID Verfügbar in API v20 und höher	N	Die Workday-Mandanten-ID oder der Mandantenname, der den Mandanten eindeutig identifiziert. Erfordert die Einrichtung von Adaptive Planning für Workday, die durch Provisionierung aktiviert wird.	mytenant
workdayEnvironment Verfügbar in API v20 und höher	N	Die Workday-Umgebung als Prod (Produktion), Sandbox (Sandbox) oder Impl (Implementierung). Erfordert die Einrichtung von Adaptive Planning für Workday, die durch Provisionierung aktiviert wird.	Prod
workdayUiUrl Verfügbar in API v20 und höher	N	Der Domänenname Workday UI URL für den Workday-Mandanten. Erfordert die Einrichtung von Adaptive Planning für Workday, die durch Provisionierung aktiviert wird.	www.myworkday.com/mytenant/d/home.html
workdayRestUrl Verfügbar in API v20 und höher	N	Der Domänenname REST URL für den Workday-Mandanten. Erfordert die Einrichtung von Adaptive Planning für Workday, die durch Provisionierung aktiviert wird.	www.myworkday.com/ccx/service/
notificationType Verfügbar in API v24 und höher	N	Die Benachrichtigungsart für den Workday-Mandanten. Erfordert die Einrichtung von Adaptive Planning für Workday, die durch Provisionierung aktiviert wird.	NONE
Inhalt des Elements
(Keine)