Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Obtenha uma lista dos objetos da comunidade do Viva Engage e suas propriedades.
Essa API está disponível nas seguintes implantações de nuvem nacional.
| Serviço global | Governo dos EUA L4 | US Government L5 (DOD) | China operada pela 21Vianet |
|---|---|---|---|
| ✅ | ❌ | ❌ | ❌ |
Permissões
Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
| Tipo de permissão | Permissões menos privilegiadas | Permissões com privilégios mais elevados |
|---|---|---|
| Delegado (conta corporativa ou de estudante) | Community.Read.All | Community.ReadWrite.All |
| Delegado (conta pessoal da Microsoft) | Sem suporte. | Sem suporte. |
| Application | Community.Read.All | Community.ReadWrite.All |
Solicitação HTTP
GET /employeeExperience/communities
Parâmetros de consulta opcionais
Esse método dá suporte aos $topparâmetros de consulta , $selecte $expand OData para ajudar a personalizar a resposta. Ele também dá suporte ao $orderby parâmetro da propriedade displayName .
Cabeçalhos de solicitação
| Nome | Descrição |
|---|---|
| Autorização | {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização. |
Corpo da solicitação
Não forneça um corpo de solicitação para esse método.
Resposta
Se for bem-sucedido, esse método retornará um 200 OK código de resposta e uma coleção de objetos da comunidade no corpo da resposta.
Exemplos
Exemplo 1: Obter uma lista de comunidades
O exemplo a seguir mostra como obter uma lista de comunidades do Viva Engage.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/employeeExperience/communities
Resposta
O exemplo a seguir mostra a resposta.
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#employeeExperience/communities",
"value": [
{
"id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTAzMzYyMTIyMTAifQ",
"displayName": "All Company",
"description": "This is the default group for everyone in the network",
"privacy": "public",
"groupId": "195d9ecd-f80e-4bab-af95-176eba253dff"
},
{
"id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTAzNDY2Mzc2OTYifQ",
"displayName": "TestCommunity5",
"description": "Test community created via API",
"privacy": "public",
"groupId": "0bed8b86-5026-4a93-ac7d-56750cc099aa"
}
]
}
Exemplo 2: Obter uma lista de comunidades com paginação
O exemplo a seguir mostra como obter uma lista de comunidades do Viva Engage usando o $top parâmetro de consulta para definir o tamanho da página de resultados.
Solicitação
O exemplo a seguir mostra uma solicitação.
GET https://graph.microsoft.com/beta/employeeExperience/communities?$top=2
Resposta
Se o número de comunidades exceder 20 ou você usar o $top parâmetro de consulta para definir o tamanho da página dos resultados, várias solicitações de consulta poderão ser necessárias para recuperar todos os resultados. Nesse cenário, a API continua a retornar uma referência à próxima página de resultados na propriedade @odata.nextLink a cada resposta até que não haja mais páginas a serem recuperadas.
O exemplo a seguir mostra a resposta que inclui a propriedade @odata.nextLink .
Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.
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": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTAzMzYyMTIyMTAifQ",
"displayName": "All Company",
"description": "This is the default group for everyone in the network",
"privacy": "public",
"groupId": "195d9ecd-f80e-4bab-af95-176eba253dff"
},
{
"id": "eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxOTAzNDY2Mzc2OTYifQ",
"displayName": "TestCommunity5",
"description": "Test community created via API",
"privacy": "public",
"groupId": "0bed8b86-5026-4a93-ac7d-56750cc099aa"
}
]
}