Groupes

Point de terminaison de l'adresse URL

VERB(s) HTTP pris en charge

OBTENIR :

Demande :

/groups/{groupId}

Récupère la liste de tous les groupes et de leurs utilisateurs/membres définis pour l’instance donnée.

URI de la demande exemple :

HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=globalsales&offset=2&limit=1

En-tête de demande d’exemple :

Accepter la langue : en

Corps de la demande d'exemple

Paramètres d'interrogation

Nom	Description	Obligatoire
groupId	Identifiant du groupe que vous voulez retourner individuellement	N
includeUsers	Pour déterminer s’il faut retourner ou non les utilisateurs des groupes appelés. Par défaut, l’inclusion d’utilisateurs est activée.	N
limit	Le nombre maximum d’objets dans une seule 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 supplémentaires incluront la page suivante. Pour accéder à une page précise, vous devez préciser une valeur de décalage.	N
instanceCode	Par défaut, il renverra l’utilisateur d’instance par défaut affecté. En fournissant une valeur, vous pouvez appeler les instances auxquelles votre utilisateur a accès, y compris les instances parents et 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	Y	Nombre total de groupes.	3
groupes	Y	Information sur les groupes de tous les groupes ou de certains groupes. Si un groupe fait partie d’un autre groupe, il affiche également les groupes associés au groupe indiqué.	{ "id": 1, "name": "Corporate and Operations", "groupType": "NATIVE", "users": [] }
groupType	Y	Affiche le type de groupe.	Externe
identifiant	Y	Identifiant associé du groupe.	1
nom	Y	Nom du groupe.	"Admins"
utilisateurs	N	Si la valeur de IncludeUsers = vrai ou de IncludeUsers est la valeur par défaut, elle est fournie avec le GUID, l’identifiant Workday et le nom d’utilisateur. sinon, il n’est pas retourné.	"users": [ { "userGuid": "randomValue", "wid": "", "userName": "test@example.com" }, { "userGuid": "randomValue", "wid": "", "userName": "test2@example.com" }
liens	N	Lorsque une limite et/ou un décalage sont fournis et que vous avez besoin d’un moyen pour passer d’une page à une autre dans un groupe, vous pouvez utiliser des liens pour passer d’un endroit à un autre.	"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 la limite est indiquée et qu’une page suivante est disponible, la mention « liens » s’affiche avec « prochain ».	"HTTPS://api.adaptiveplanning.com/api/rest/security/v1/default/groups?instanceCode=TENANT&offset=2&limit=1"
précédent	N	Si une limite et un décalage sont fournis et que vous êtes au milieu où une page précédente et une page plus tard sont disponibles, « 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
Information relative aux éléments indiqués.

Réponses aux erreurs

Erreurs	Cause
Spécifiez des valeurs de paramètres valides pour la limite et le décalage.	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 d'instance
Vous n'avez pas toutes les autorisations pour exécuter cette API : Manage Global User Groups.	les données d'identification de l'utilisateur ne disposent pas des autorisations appropriées pour évoquer un appel d'API
Identifiant non valide	les données d'identification utilisées ne sont pas valides pour l'instance
HTTP 404 introuvable	Le paramètre groupId n'est pas valide