exportPermissionSets

Catégorie	Metadata retrieval
Description	Renvoie les métadonnées pour la liste complète de tous les ensembles d’autorisations de l’instance.
Autorisations obligatoires pour pouvoir être appelées	Aucun (doit être un identifiant valide pour l’instance)
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient uniquement un marqueur d’identification pour désigner et autoriser l’utilisateur qui est auteur de l’appel. Une fois vérifiée, la méthode renvoie un document XML décrivant l’ensemble d’autorisations trouvé dans l’instance de l’utilisateur.

Format de demande


<?xml version='1.0' encoding='UTF-8'?>
<call method="exportPermissionSets" callerName="a string that identifies your client application">
 <credentials login="sampleuser@company.com" password="my_pwd"/>
</call>

élément de données d'identification
Nom du marqueur		données d'identification
Description		Tous les appels d’API doivent contenir un élément d’identification unique pour identifier l’utilisateur qui invoque l’API. L’appel d’API est alors effectué en tant que cet utilisateur (toute piste d’audit ou tout historique des actions dans le système indiquera que cet utilisateur a effectué l’action), et par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action dans l’ordre pour l’API. appel pour réussir.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
ouvrir une session	Y	Le nom de connexion de l’utilisateur qui invoque la méthode API. Cet utilisateur doit disposer des autorisations requises pour appeler la méthode	sampleuser@company.com
mot de passe	Y	Le mot de passe de l’utilisateur qui invoque la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les numéros et les dates entrants et pour mettre en forme les numéros et les dates sortants (à l’aide du séparateur des milliers, des noms de mois et du format de date appropriés). Les paramètres régionaux sont également utilisés pour préciser la langue dans laquelle tous les messages de système de la réponse doivent être affichés. Si cette valeur n’est pas précisée, la valeur en_US (rubrique en anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l’utilisateur indiqué dans les données d’identification a accès à plusieurs instances de Adaptive Planning , cet attribut peut être utilisé pour préciser que l’utilisateur a l’intention d’accéder à une instance autre que celle par défaut. Si elle n’est pas précisée, l’instance par défaut de l’utilisateur sera utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de réponse


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

Les ensembles d’autorisations et les autorisations sont classés par nom.

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite	Y	Vrai ou faux, indiquant si l’appel d’API a réussi ou non. Même les appels réussis peuvent contenir des messages d’avertissement dans leur réponse.	vrai
obsolète	N	S’il est présent dans le marqueur de réponse et défini à Vrai, cet attribut indique que la version de la méthode ou de l’API qui est appelée est obsolète et est officiellement dépréciée par Adaptive Planning . Bien qu’elle continue de fonctionner pour le moment, elle pourrait cesser de fonctionner sous peu. En général, cet attribut n’est pas présent.	faux
Contenu de l'élément
Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un élément de comptes unique. Ce filtre de sortie est standard sur toutes les réponses d’API et enveloppe la sortie valide de tout appel d’API réussi.

Élément permission_sets
Nom du marqueur	permission_sets
Description	Conteneur pour un ou plusieurs éléments de l'ensemble d'autorisations.
Attributs de l'élément
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de l’ensemble d’autorisations.

élément permission_set
Nom du marqueur		permission_set
Description		Décrit un ensemble d’autorisations unique disponible dans l’instance.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Le numéro d’identifiant de système interne pour l’ensemble d’autorisations. Cela permet de désigner l’ensemble d’autorisations affecté à un utilisateur dans l’appel d’API exportUsers.	1
nom	Y	Nom de l’ensemble d’autorisations, tel qu’il apparaît dans Administration de l’ensemble d’autorisations	Standard
autorisations	Y	Une liste de codes séparés par des virgules pour les autorisations affectées à cet ensemble d’autorisations. Les codes sont des abréviations internes telles que « SWT » pour l’accès à la feuille et « RPT » pour l’accès au rapport.	SST,RPT,TABLE DE SCORES
Contenu de l'élément
(aucun)