Passer au contenu principal
Documentation
Documentation
Adaptive Planning
Dernière mise à jour : 2024-03-08
Groupes

Groupes

Point de terminaison de l'URL

HTTPS://api.adaptiveplanning.com/api/rest/security/<version>/<tenant>/groups/{groupID}
Version : v1
Catégorie
Récupération des métadonnées
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
Accès administrateur > Utilisateurs
Paramètres obligatoires à la demande
Identifiants

VERB(S) HTTP pris en charge

Verbe HTTP
Ressource unique
Ressources de recouvrement
Description
GET
Prise en charge
Prise en charge
Récupère des groupes de Planning.

GET :

Demande :
/groups/{groupId}
Récupère la liste de tous les groupes et leurs utilisateurs/membres définis pour l'instance donnée.
Exemple d'URI de demande :
HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1
Exemple d'en-tête de demande :
Accepter la langue : en
Exemple de corps de demande
Paramètres de requête
Nom
Description
Obligatoire
groupId
Identifiant du groupe que vous voulez retourner individuellement
N
includeUsers
Pour déterminer s'il faut ou non renvoyer les utilisateurs des groupes appelés. L'option Inclure les utilisateurs est activée par défaut.
N
limit
Le nombre maximum d'objets dans une même réponse.
N
offset
Pour afficher un certain nombre de groupes par page. S'il y a plus de groupes que la limite, les groupes en trop seront projetés sur la page suivante. Pour accéder à une certaine page, vous devez indiquer une valeur de décalage.
N
instanceCode
Par défaut, elle renverra l'utilisateur de l'instance par défaut affecté. En indiquant une valeur, vous pouvez appeler les instances auxquelles votre utilisateur a accès, y compris les instances parents/enfants.
N
Exemple de réponse
Exemple de réponse
 
{
   "links": {
       "next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
       "previous": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
   },
   "total": 3,
   "groups": [
       {
           "id": 2,
           "name": "Admins",
           "groupType": "NATIVE",
           "users": [
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test@email.com"
               },
               {
                   "userGuid": "randomValue",
                   "wid": "",
                   "userName": "test2@email.com"
               },
           ]
       },
       {
           "id": 1,
           "name": "Corporate and Operations",
           "groupType": "NATIVE",
           "users": []
       },
       {
           "id": 3,
           "name": "Ops and Admins",
           "groupType": "NATIVE",
           "users": [],
           "groups": [
               {
                   "id": 2,
                   "name": "Admins",
                   "groupType": "NATIVE"
               },
               {
                   "id": 1,
                   "name": "Corporate and Operations",
                   "groupType": "NATIVE"
               }
           ]
       }
   ]
}
Élément de réponse
Nom du marqueur
réponse
Attributs de l'élément
Nom de l'attribut
Obligatoire ?
Valeur
Exemple
total
O
Nombre total de groupes.
3
groupe(s)
O
Informations sur le groupe de tous les groupes ou des groupes indiqués. Si un groupe fait partie d'un autre groupe, alors les groupes associés au groupe indiqué s'affichent également.
{
"id": 1,
"name": "Corporate and Operations",
"groupType": "NATIVE",
"users": []
}
groupType
O
Indique le type de groupe.
Externe
id
O
Identifiant associé du groupe.
1
nom
O
Nom du groupe.
"Admins"
utilisateur(s)
N
Si includeUsers = true ou includeUsers est la valeur par défaut, alors le guide, l'identifiant de Workday et le nom d'utilisateur de l'utilisateur sont associés. sinon elle n'est pas renvoyée.
"users": [
{
"userGuid": "randomValue",
"wid": "",
"userName": "test@example.com"
},
{
"userGuid": "randomValue",
"wid": "",
"userName": "test2@example.com"
}
liens
N
Lorsque la limite et/ou le décalage sont indiqués et que vous avez besoin de moyen pour accéder à différentes pages de groupes, vous pouvez utiliser des liens pour reculer et avancer.
"links": {
"next": "HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1",
"previous": "HTTPS://api.adaptiveinsights.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=0&limit=1"
}
next
N
Si une limite est fournie et qu'une page suivante est disponible, les liens "liens" apparaîtront avec "suivant".
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
précédent
N
Si la limite et le décalage sont indiqués et que vous vous trouvez au milieu d'une page précédente et d'une page suivante, "précédent" est disponible.
"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
Contenu de l'élément
Informations relatives aux éléments indiqués.
Réponses aux erreurs
Erreurs
Cause
Spécifiez des valeurs limites et de décalage valides pour les paramètres.
entrée non valide pour les valeurs de limite/de décalage
GroupAPI : pour getGroupByGroupId, groupe introuvable pour le code d'instance : {TENANT}
groupId n'existe pas pour le code de l'instance
Vous ne disposez pas de toutes les autorisations requises pour exécuter cette API : Gérer les groupes d'utilisateurs globaux.
les identifiants de l'utilisateur ne disposent pas des autorisations permettant d'appeler l'API
Identifiant non valide
les identifiants utilisés sont incorrects pour l'instance
HTTP 404 introuvable
Le paramètre groupId n'est pas valide