Répertorier les communautés

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez la liste des objets de la communauté Viva Engage et de leurs propriétés.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global Gouvernement des États-Unis L4 Us Government L5 (DOD) Chine gérée par 21Vianet

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation Autorisations avec privilèges minimum Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire) Community.Read.All Community.ReadWrite.All
Déléguée (compte Microsoft personnel) Non prise en charge. Non prise en charge.
Application Community.Read.All Community.ReadWrite.All

Requête HTTP

GET /employeeExperience/communities

Paramètres facultatifs de la requête

Cette méthode prend en charge les $topparamètres de requête OData , $selectet $expand pour vous aider à personnaliser la réponse. Il prend également en charge le $orderby paramètre de la propriété displayName .

En-têtes de demande

Nom Description
Autorisation Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

Corps de la demande

N’indiquez pas le corps de la demande pour cette méthode.

Réponse

Si elle réussit, cette méthode renvoie un 200 OK code de réponse et une collection d’objets de communauté dans le corps de la réponse.

Exemples

Exemple 1 : Obtenir la liste des communautés

L’exemple suivant montre comment obtenir la liste des communautés Viva Engage.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/employeeExperience/communities

Réponse

L’exemple suivant illustre la réponse.

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#employeeExperience/communities",
    "value": [
        {
            "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTEzMjYyODk5MjAifQ",
            "displayName": "All Company",
            "description": "This is the default group for everyone in the network",
            "privacy": "public",
            "groupId": "195d9ecd-f80e-4bab-af95-176eba253dfa"
        },
        {
            "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTE0NzY2Mzc2OTYifQ",
            "displayName": "TestCommunity5",
            "description": "Test community created via API",
            "privacy": "public",
            "groupId": "0bed8b86-5026-4a93-ac7d-56750cc099f1"
        }
    ]
}

Exemple 2 : Obtenir la liste des communautés avec pagination

L’exemple suivant montre comment obtenir une liste des communautés Viva Engage à l’aide du $top paramètre de requête pour définir la taille de page des résultats.

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/employeeExperience/communities?$top=2

Réponse

Si le nombre de communautés dépasse 20 ou si vous utilisez le $top paramètre de requête pour définir la taille de page des résultats, plusieurs demandes de requête peuvent être nécessaires pour récupérer tous les résultats. Dans ce scénario, l’API continue de retourner une référence à la page de résultats suivante dans la propriété @odata.nextLink avec chaque réponse jusqu’à ce qu’il ne reste plus de pages à récupérer.

L’exemple suivant montre la réponse qui inclut la propriété @odata.nextLink .

Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.

HTTP/1.1 200 OK
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#employeeExperience/communities",
    "@odata.nextLink": "https://graph.microsoft.com/beta/employeeExperience/communities?$skiptoken=UVWlYzI7VjE7MTE2NDUzNDU3OTIwOzIwO0RlbW8tdGVzdC01OztEaXNwbGF5TmFtZTtmYWXYZTs",
    "value": [
        {
            "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTEzMjYyODk5MjAifQ",
            "displayName": "All Company",
            "description": "This is the default group for everyone in the network",
            "privacy": "public",
            "groupId": "195d9ecd-f80e-4bab-af95-176eba253dfa"
        },
        {
            "id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTE0NzY2Mzc2OTYifQ",
            "displayName": "TestCommunity5",
            "description": "Test community created via API",
            "privacy": "public",
            "groupId": "0bed8b86-5026-4a93-ac7d-56750cc099f1"
        }
    ]
}