importGroups

Catégorie	Modification de métadonnées
Description	Importer les groupes d’utilisateurs que vous avez créés dans Workday Core ou dans un système externe. En cas d’importation réussie, l’API renvoie les détails des groupes que vous avez importés. Vous ne pouvez pas utiliser cette API pour mettre à jour des groupes d'utilisateurs créés dans l'interface utilisateur Adaptive Planning.
Autorisations obligatoires pour pouvoir être appelées	Autorisation Gérer les groupes d'utilisateurs globaux
Paramètres requis sur demande	Identifiants

La demande de cette méthode contient un marqueur d’identifiants pour désigner et autoriser l’utilisateur auteur de l’appel. L'utilisateur doit avoir l'autorisation

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 d'interrogation

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 tout autre système en dehors de Workday. À partir de la page Configuration générale, votre administrateur peut activer la modification de groupes avec une source de données EXTERNE. Vous pouvez ensuite mettre à jour ces groupes avec l'interface utilisateur Adaptive Planning. Voir : Référence : paramétrage général.	Y
mode	Le mode pour l’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 précisez dans les données utiles. METTEZ À JOUR. Le mode met uniquement à jour les groupes d’utilisateurs que vous précisez dans les données utiles.	Y
userIdentifier	Identifiant pour les utilisateurs précisés dans les groupes d’utilisateurs : userName. Le nom d’utilisateur pour l’utilisateur précisé. userGUID. Identifiant d'utilisateur global pour l'utilisateur indiqué. wid. L’identifiant Workday pour l’utilisateur précisé.	Y

é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 indique que cet utilisateur a effectué l’action. Par conséquent, l’utilisateur doit disposer des autorisations requises pour effectuer l’action pour que l’appel d’API réussisse.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
ouvrir une session	Y	Le nom d’ouverture de session 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. également, pour mettre en forme les nombres et les dates sortants (à l’aide du séparateur de milliers, des noms de période et du format de date appropriés). Les paramètres régionaux précisent également la langue dans laquelle tous les messages de système de la réponse doivent s’afficher. 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 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 est utilisée. Pour déterminer les codes d’instances disponibles, utilisez l’API exportInstances.	MYINSTANCE1
Contenu de l'élément
Aucun

élément de groupe
Nom du marqueur		groupe
Description		Indique un ensemble de groupes d’utilisateurs à créer ou à mettre à jour.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
externalID	Y	L'identifiant externe du groupe d'utilisateurs.	user_group_1
nom	Y	Le nom du groupe d’utilisateurs.	Administrateurs de la sécurité
Contenu de l'élément
Élément d'utilisateurs

élément utilisateur
Nom du marqueur		utilisateur
Description		Indique un ou plusieurs utilisateurs à ajouter au groupe d’utilisateurs.
Attributs de l'élément
Nom de l’attribut	Obligatoire?	Valeur	Exemple
userGUID	O (à condition que l’identifiant utilisateur précisé par l’appeleur d’API soit userGUID)	Identifiant global de l'utilisateur.	B9ADBCB81AA2F9BAE040307F02092C2
userName	O (à condition que l’identifiant d’utilisateur indiqué par l’appeleur d’API soit userName)	Le nom de l’utilisateur.	updateMail@company.com
Workday	O (à condition que l’identifiant utilisateur précisé par l’appeleur d’API soit widget)	L’identifiant Workday de l’utilisateur.	A9ADBCB81AA2F9BAE040307F02092C2E
Contenu de l'élément
En cas d’utilisateur non valide (c’est-à-dire userGUID/userName/wid non valide), l’utilisateur non valide sera omis et la demande sera traitée pour le groupe destiné aux autres utilisateurs valides. Toutefois, pour les scénarios liés à l'élément <user> suivants, l'ensemble du groupe 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. Identifiant Workday non valide : Longueur de l’identifiant Workday inférieure ou supérieure à 32 caractères. Message d'erreur : indiquez un userWID valide pour tous les utilisateurs. format userGUID non valide : Longueur de userGUID inférieure ou supérieure à 32 caractères. userGUID n'est pas alphanumérique. Message d'erreur : Indiquez un userGUID valide pour tous les utilisateurs.

Format de 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	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
Selon que vous avez fait l’appel de création ou de mise à jour, un seul élément de résultat avec des éléments de statut created_usergroup ou Updated_usergroup.

imported_groups element
Nom du marqueur		imported_groups
Nom de l’attribut	Obligatoire?	Valeur	Exemple
réussite du groupe	Y	Le statut retourné, Vrai ou Faux.	"true"
message	Y	Le message lié au statut.	"groupe d'utilisateurs - Le nouveau groupe d'utilisateurs a été créé' "Payload a partiellement réussi à effacer les adhésions des utilisateurs. Réessayez et si le problème persiste, contactez le service de soutien. »
Contenu de l'élément
Aucune.