importGroups

Catégorie	Modification des métadonnées
Description	Importez les groupes d'utilisateurs que vous avez créés dans Workday Core ou dans un système externe. Si elle aboutit, l'API renvoie les informations des groupes que vous avez importés. Vous ne pouvez pas utiliser cette API pour mettre à jour les groupes d'utilisateurs créés dans l'interface utilisateur d'Adaptive Planning.
Autorisations requises pour appeler	Autorisation Gérer les groupes d'utilisateurs globaux
Paramètres obligatoires à la demande	Identifiants

La demande de ce mode contient un marqueur d'identifiant pour identifier et autoriser l'utilisateur appelant. L'utilisateur doit avoir l'autorisation

d'accès administrateur

Gérer les groupes d'utilisateurs globaux

pour importer les groupes d'utilisateurs.

Format de demande

<?xml version='1.0' encoding='UTF-8'?>
<call method="importGroups" callerName="a string that identifies your client application"
dataSource="WORKDAY/EXTERNAL" mode="REPLACE_ALL/UPDATE" userIdentifier="userName/userGUID/wid">
  <credentials login="sampleuser@company.com" password="my_pwd" />
    <groups>
        <group
          externalID="userGroup_ID_1"
          name="new user group"
           >
          <users>
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2E"
                  userName="user1"
                  wid="A9ADBCB81AA2F9BAE040307F02092C2E" />
              <user userGUID="B9ADBCB81AA2F9BAE040307F02092C2F"
                   userName="user3"
                   wid="A9ADBCB81AA2F9BAE040307F02092C2F" />
          </users>
        </group>
     </groups>
</call>

Attributs de requête

Nom	Description	Obligatoire
dataSource	La source des données des groupes d'utilisateurs : WORKDAY. La source des données des groupes d'utilisateurs est Workday. Ces groupes ne peuvent pas être modifiés dans Adaptive Planning. EXTERNAL. La source des données des groupes d'utilisateurs est n'importe quel autre système en dehors de Workday. Sur la page Paramétrage général, votre administrateur peut autoriser la modification de groupes disposant d'une source de données EXTERNAL. Vous pouvez ensuite mettre à jour ces groupes à l'aide de l'interface utilisateur d'Adaptive Planning. Voir Référence : paramétrage général.	O
mode	Le mode d'appel d'API : REPLACE_ALL. Le mode remplace tous les groupes d'utilisateurs de votre instance Adaptive Planning par les groupes d'utilisateurs que vous avez indiqués dans les données utiles. METTRE À JOUR. Le mode met uniquement à jour les groupes d'utilisateurs que vous avez indiqués dans les données utiles.	O
userIdentifier	L'identifiant des utilisateurs indiqués dans les groupes d'utilisateurs : userName. Nom d'utilisateur de l'utilisateur indiqué. userGUID. Le code utilisateur global de l'utilisateur indiqué. wid. Identifiant Workday pour l'utilisateur indiqué.	O

é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 alors effectué en tant qu'utilisateur. La piste d'audit ou l'historique des actions dans le système indique 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 s'effectue correctement.
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. Également pour mettre en forme les dates et les chiffres sortants (en utilisant le séparateur de milliers, les noms de période et la mise en forme de date appropriés). Les paramètres régionaux indiquent également la langue dans laquelle les messages système figurant dans la réponse doivent s'afficher. Si aucune option n'est indiquée, l'expression en_US (anglais américain) est utilisée.	fr_FR
instanceCode	N	Si l'utilisateur indiqué dans les identifiants a accès à plusieurs instances Adaptive Planning, cet attribut peut indiquer qu'il prévoit d'accéder à une instance différente de son instance par défaut. Si aucune option n'est indiquée, l'instance par défaut de l'utilisateur est utilisée. Pour déterminer les codes d'instance disponibles, utilisez l'API exportInstances.	MYINSTANCE1
Contenu de l'élément
Aucune

élément du groupe
Nom du marqueur		groupe
Description		Permet de spécifier un ensemble de groupes d'utilisateurs à créer ou mettre à jour.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
externalID	O	Identifiant externe du groupe d'utilisateurs.	user_group_1
nom	O	Nom du groupe d'utilisateurs.	Administrateurs de la sécurité
Contenu de l'élément
Élément Users

élément utilisateur
Nom du marqueur		utilisateur
Description		Indique un utilisateur ou des utilisateurs à ajouter au groupe d'utilisateurs.
Attributs de l'élément
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
userGUID	Y (pourvu que l'identifiant utilisateur spécifié par l'appelant API soit userGUID)	Identifiant global de l'utilisateur.	B9ADBCB81AA2F9BAE040307F02092C2
nom d'utilisateur	Y (pourvu que l'identifiant utilisateur spécifié par l'appelant API soit userName)	Le nom d'utilisateur.	updateMail@company.com
identifiant Workday	Y (l'identifiant utilisateur spécifié par l'appelant API est WID)	L'identifiant Workday de l'utilisateur.	A9ADBCB81AA2F9BAE040307F02092C2E
Contenu de l'élément
En cas d'utilisateur non valide (c.-à-d. userGUID/userName/wid non valide), un utilisateur spécifique non valide sera ignoré et la demande sera traitée pour le groupe pour le reste des utilisateurs valides. Toutefois, pour les scénarios associés à l'élément <user> suivants, le groupe entier sera rejeté dans les données utiles. Identifiant utilisateur manquant : <user/> <user userName=""/> <user userName/userGUID/wid=" "/> Message d'erreur L'identifiant utilisateur est manquant. Indiquez un userName/userGUID/wid valide pour tous les utilisateurs. Format d'identifiant Workday non valide : La longueur de l'identifiant Workday contient moins ou plus de 32 caractères. Message d'erreur : indiquez un userWID valide pour tous les utilisateurs. userGUID n'est pas valide : userGUID contient moins ou plus de 32 caractères. userGUID n'est pas alphanumérique. Message d'erreur : spécifiez un userGUID valide pour tous les utilisateurs.

Format de la réponse

<?xml version="1.0" encoding="UTF-8"?>
<response success="true">
  <output>
      <result>
          <imported_groups>
              <group success="true" externalID="ID_1" id="33" name="New Group 1" />
          </imported_groups>
      </result>
  </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
Selon que vous avez lancé l'appel de création ou de mise à jour, un seul élément de résultat avec des éléments de statut create_usergroup ou update_usergroup.

imported_groups element
Nom du marqueur		imported_groups
Nom de l'attribut	Obligatoire ?	Valeur	Exemple
réussite du groupe	O	Le statut renvoyé, vrai ou faux.	"true"
message	O	Le message de statut.	"le nouveau groupe d'utilisateurs a été créé avec succès." Les données utiles ont permis d'effacer en partie les affiliations des utilisateurs. Réessayez et si le problème persiste, contactez le support."
Contenu de l'élément
Aucune.