exportRoles

Wird in API v25 und höher nicht unterstützt. Verwenden exportPermissionSets.

Kategorie	Abrufen von Metadaten
Beschreibung	Gibt Metadaten für die vollständige Liste aller Rollen in der Instanz zurück.
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 nur ein Credentials-Tag zur Identifizierung und Autorisierung des aufrufenden Benutzers. Nach der Verifizierung gibt die Methode ein XML-Dokument zurück, das den vollständigen Satz aller in der Instanz des Benutzers gefundenen Rollen beschreibt.

Anforderungsformat


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportRoles" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</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 eine Rolle mit den für die aufzurufende Methode erforderlichen Berechtigungen haben.	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 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)

Antwortformat


<?xml version='1.0' encoding='UTF-8'?>
<response success="true">
 <output>
   <roles>
     <role id="1" name="Standard" permissions="SHT,RPT,SCOREBOARD"/>
     <role id="2" name="Administrative" permissions="SHT,RPT,SCOREBOARD,SAL,MOD,IMP,EXP"/>
   </roles>
 </output>
</response>

Rollen und Berechtigungen werden nach Name sortiert.

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 und auf „true“ gesetzt ist, zeigt es an, dass die Version der Methode oder API, die aufgerufen wird, veraltet ist und von offiziell als veraltet markiert wird Adaptive Planning . 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.

Rollenelement
Tag-Name	Rollen
Beschreibung	Container für ein oder mehrere Rollenelemente.
Attribute des Elements
(Keine)
Inhalt des Elements
Ein oder mehrere Rollenelemente

Rollenelement
Tag-Name		Rolle
Beschreibung		Beschreibt eine einzelne Rolle, die in der Instanz verfügbar ist.
Attribute des Elements
Name des Attributs	erforderlich?	Wert	Beispiel
id	J	Die interne System-ID der Rolle. Hiermit wird die Rolle identifiziert, die einem Benutzer im API-Aufruf exportUsers zugewiesen ist.	1
Name	J	Der Name der Rolle, wie in der Rollenverwaltung angezeigt.	Standard
-Berechtigungen	J	Eine durch Kommas getrennte Liste von Codes für Berechtigungen, die dieser Rolle zugewiesen sind. Die Codes sind interne Abkürzungen wie „SHT“ für Tabellenblattzugriff und „RPT“ für Berichtszugriff.	SHT,RPT, SCORECARD
Inhalt des Elements
(Keine)