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 au niveau global pour l’ensemble de l’instance et les groupes définis par les utilisateurs.
Autorisations obligatoires pour pouvoir être appelées	Administration des utilisateurs
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 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 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). Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action afin que l’appel d’API puisse être exécuté 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 invoquer 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>
    <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	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
Contenu de l'élément
Un seul élément de message facultatif et un seul élément de sortie obligatoire.

élément de message
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 renvoyé par le système à l’appelant. Les messages sont utilisés pour envoyer des messages d’erreur lorsque les demandes échouent, pour envoyer des messages d’avertissement lorsque les demandes réussissent et pour les messages de confirmation lorsque les demandes réussissent.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
clé	N		Lorsqu’elle est fournie, une clé est un moyen de repérer un message ou un type de message particulier, ce qui est utile à des fins d’enregistrement automatique d’erreurs et de récupération 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 improbable que les clés changent à l’avenir en raison d’ajustements de formulation ou de changements de terminologie.
Contenu de l'élément
Le texte du message. Ce texte est dans la langue des paramètres régionaux indiqués dans la demande (en supposant que les paramètres régionaux sont pris en charge). Le texte peut également contenir des renseignements variables, tels que le nombre de rangées traitées, ou la colonne ou la valeur particulière qui a causé une erreur.

élément de sortie
Nom du marqueur	sortie
Attributs de l'élément
(aucun)
Contenu de l'élément
Un élément de groupe 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 de groupes
Nom du marqueur		groupes
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
Zéro ou plusieurs éléments de groupe.

élément de groupe
Nom du marqueur		groupe
Description		Représente un groupe unique retourné en réponse à un appel d'API exportGroups.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
identifiant	Y	Il s’agit du numéro d’identifiant de système interne pour le groupe d’utilisateurs.	2
nom	Y	Le nom du groupe d’utilisateurs.	Opérations et administrateurs
isGlobal	Y	Indique si le groupe d’utilisateurs est global dans l’ensemble de l’instance.	3
ownerId	Y	L’identifiant de système interne de l’utilisateur qui est propriétaire de ce groupe d’utilisateurs. Défini uniquement lorsque isGlobal="false".	5
Contenu de l'élément
(aucun)