exportGroups

Catégorie	Metadata retrieval
Description	Renvoie la liste complète de tous les groupes définis pour l'instance donnée. Cela inclut les groupes définis de manière globale dans une instance entière et les groupes définis par les utilisateurs.
Autorisations requises pour appeler	Administrateur utilisateur
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient uniquement un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. Une fois vérifiée, la méthode renvoie un document XML décrivant l'ensemble complet de tous les groupes définis dans l'instance.

Format de demande


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

élément identifiants
Nom du marqueur		identifiants
Description		Tous les appels d'API doivent contenir un seul élément identifiants pour identifier l'utilisateur qui a appelé l'API. L'appel d'API est ensuite effectué en tant qu'utilisateur ( n'importe quelle piste d'audit ou historique d'actions dans le système indique que cet utilisateur a effectué l'action) et, par conséquent, l'utilisateur doit avoir les autorisations requises pour effectuer l'action afin que l'appel d'API s'appelle réussir.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
se connecter	O	Le nom de connexion de l'utilisateur appelant la méthode API. Cet utilisateur doit avoir les autorisations requises pour appeler la méthode.	sampleuser@company.com
mot de passe	O	Mot de passe de l'utilisateur appelant la méthode API.	my_password
paramètres régionaux	N	Indiquez les paramètres régionaux à utiliser pour interpréter les chiffres et les dates entrants, et pour formater les chiffres et les dates sortants (en utilisant le séparateur des milliers, les noms de mois et la mise en forme de date appropriés). Les paramètres régionaux sont également utilisés pour indiquer la langue dans laquelle doivent s'afficher les messages système figurant dans la réponse. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur spécifié dans les identifiants a accès à plusieurs instances de : Adaptive Planning , cet attribut peut être utilisé pour indiquer que l'utilisateur a l'intention d'accéder à une instance autre que son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur sera utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
(aucun)

Format de la réponse


<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
 <output>
    <groups>
       <group id="1" name="Corporate and Operations" isGlobal="true"/>
       <group id="2" name="Admins" isGlobal="true"/>
       <group id="3" name="Ops and Admins" isGlobal="true"/>
       <group id="4" name="My group" isGlobal="false" ownerId="3"/>
    </groups>
 </output>
</response>

élément de réponse
Nom du marqueur		réponse
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
réussite	O	Vrai ou faux, indiquant si l'appel d'API a réussi ou non. Même les appels traités avec succès peuvent contenir des messages d'avertissement dans leur réponse.	vrai
Contenu de l'élément
Un seul élément de messages facultatifs et exactement un élément de sortie obligatoire.

élément de messages
Nom du marqueur		messages
Description		Conteneur pour un ou plusieurs éléments de message.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
Un ou plusieurs éléments de message.

élément de message
Nom du marqueur		message
Description		Représente un message que le système renvoie à l'appelant. Les messages sont utilisés pour les messages d'erreur lorsque les demandes n'ont pas abouti, pour les messages d'avertissement lorsque les demandes ont abouti et pour les messages de confirmation lorsque les demandes ont abouti.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
clé	N		Lorsqu'elle est fournie, une clé permet d'identifier un message ou un type de message particulier, utile pour l'enregistrement et la récupération automatisés des erreurs dans les programmes clients. Les clés ne changent pas selon les paramètres régionaux des demandes, même lorsque la langue du message change. Il est également peu probable que les clés changent à l'avenir en raison d'ajustements du libellé ou de la terminologie.
Contenu de l'élément
Texte du message. Ce texte est exprimé dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux soient pris en charge). Le texte peut également contenir des informations variables telles que le nombre de lignes qui ont été traitées ou la colonne ou la valeur particulière qui a généré une erreur.

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

élément des groupes
Nom du marqueur		groupe(s)
Description		Conteneur pour un ou plusieurs éléments de groupe.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
(aucun)
Contenu de l'élément
0 ou plusieurs éléments du groupe.

élément du groupe
Nom du marqueur		groupe
Description		Représente un seul groupe renvoyé en réponse à un appel d'API exportGroups.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
id	O	Numéro d'identifiant système interne du groupe d'utilisateurs.	2
nom	O	Nom du groupe d'utilisateurs.	Opérateurs et administrateurs
isGlobal	O	Indique si le groupe d'utilisateurs est global sur l'instance.	3
ownerId	O	Identifiant système internes de l'utilisateur qui possède ce groupe. Défini uniquement lorsque isGlobal="false".	5
Contenu de l'élément
(aucun)