Skip to content

Commit 7b513c2

Browse files
PowershellScriptsPowershellScripts
authored
Update vivagraphapi.md
1 parent 93f8a67 commit 7b513c2

File tree

1 file changed

+64
-9
lines changed

1 file changed

+64
-9
lines changed

‎articles/en/Viva/vivagraphapi.md

Lines changed: 64 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,12 @@ date: '2024-06-02'
1616

1717
<h1>Get all communities</h1>
1818

19+
1920
| Method | Url |
2021
|---|---|
2122
|GET| https://graph.microsoft.com/beta/employeeexperience/communities |
2223

23-
In order to get all communities using Graph API, use the GET method with the following url: https://graph.microsoft.com/beta/employeeexperience/communities
24+
In order to get all Viva Engage communities using Graph API, use the GET method with the following url: https://graph.microsoft.com/beta/employeeexperience/communities
2425

2526
<img src="/articles/images/VivaGraphAPI.PNG">
2627

@@ -30,30 +31,42 @@ In order to get all communities using Graph API, use the GET method with the fol
3031

3132
a) by id
3233

34+
3335
| Method | Url |
3436
|---|---|
3537
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID |
3638

37-
In order to get a specific community, use its ID. In the case of the sample tenant used in Graph Explorer, it's eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxMjczMDI1MyJ9. Use the GET method with the following url: https://graph.microsoft.com/beta/employeeexperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxMjczMDI1MyJ9
39+
40+
In order to get a specific Viva Engage community, use its ID. In the case of the sample tenant used in Graph Explorer, it's eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxMjczMDI1MyJ9. Use the GET method with the following url: https://graph.microsoft.com/beta/employeeexperience/communities/eyJfdHlwZSI6Ikdyb3VwIiwiaWQiOiIxMjczMDI1MyJ9
3841

3942
<img src="/articles/images/VivaGraphAPI2.PNG">
4043

4144

4245
b) by name
4346

44-
Use $filter to filter for your Viva Engage community's name. The API call fetches details about a community named "Our first Community" and returns data such as community ID, display name, description, and other related properties.
47+
| Method | Url |
48+
|---|---|
49+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities?$filter=displayName eq 'Marketing' |
50+
4551

46-
<img src="/articles/images/VivaGraphAPI3.PNG">
52+
Use **$filter** to filter for your Viva Engage community's name. The API call fetches details about a community named "Marketing" and returns data such as community ID, display name, description, and other related properties.
4753

48-
c) by property
54+
<img src="/articles/images/VivaGraphAPI3.PNG">
4955

5056

5157

5258
See the full documentation for this GET request [here](https://learn.microsoft.com/en-us/graph/api/community-get?view=graph-rest-beta&tabs=http).
5359

60+
<br/><br/>
5461

5562
<h1>Get community owners</h1>
5663

64+
| Method | Url |
65+
|---|---|
66+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID/owners |
67+
68+
69+
5770
Using GET Method and Url https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID/owners?$select=displayName you can also retrieve the owners of the community.
5871

5972
<img src="/articles/images/VivaGraphAPIOwners.PNG">
@@ -64,6 +77,21 @@ and select the properties of the owners that interest you:
6477
<img src="/articles/images/VivaGraphAPIOwners2.PNG">
6578

6679

80+
<br/><br/>
81+
82+
<h1>Get associated group</h1>
83+
84+
| Method | Url |
85+
|---|---|
86+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID/group |
87+
88+
89+
90+
Get the Microsoft 365 group associated with the Viva Engage community. The M365 group is crucial for the management of the community. You can manage community operations through the associated Microsoft 365 group by adding or removing members, managing ownership, deleting or renaming the group, and updating its description.
91+
92+
93+
<img src="/articles/images/VivaGraphAPIgroup.PNG">
94+
6795
<br/><br/>
6896

6997
<h1>community resource type</h1>
@@ -87,7 +115,7 @@ privacy | communityPrivacy | Defines the privacy level of the community. The pos
87115
|---|---|
88116
|POST| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID |
89117

90-
Every Viva Engage community is associated with a Microsoft 365 group, but the group doesn't have the same ID as the community.
118+
Mind that every Viva Engage community is associated with a Microsoft 365 group, but the group doesn't have the same ID as the community.
91119

92120
<img src="/articles/images/VivaGraphAPI3.PNG">
93121

@@ -112,9 +140,12 @@ For Viva Engage networks in native mode, creating a new Viva Engage community al
112140

113141
| Method | Url | Description |
114142
|---|---|---|
115-
|GET| https://graph.microsoft.com/beta/employeeexperience/communities | Get all communities |
116-
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID | Get specific community|
117-
|POST| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID | Create a community|
143+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities | Gets all communities |
144+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID | Gets specific community|
145+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities?$filter=displayName eq 'Marketing' | Gets community by name |
146+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID/owners | Gets community owners |
147+
|GET| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID/group | Gets associated M365 group |
148+
|POST| https://graph.microsoft.com/beta/employeeexperience/communities/COMMUNITYID | Creates a community|
118149

119150

120151
<br/><br/>
@@ -123,3 +154,27 @@ For Viva Engage networks in native mode, creating a new Viva Engage community al
123154

124155
[Introducing the Community Creation API for Viva Engage on Microsoft Graph Beta ](https://techcommunity.microsoft.com/t5/viva-engage-blog/introducing-the-community-creation-api-for-viva-engage-on/ba-p/4011966
125156
)
157+
158+
159+
160+
161+
162+
<!-- Default Statcounter code for Viva Graph API
163+
https://powershellscripts.github.io/articles/en/Viva/vivagraphapi/
164+
-->
165+
<script type="text/javascript">
166+
var sc_project=13006360;
167+
var sc_invisible=0;
168+
var sc_security="8e4900b1";
169+
var scJsHost = "https://";
170+
document.write("<sc"+"ript type='text/javascript' src='" +
171+
scJsHost+
172+
"statcounter.com/counter/counter.js'></"+"script>");
173+
</script>
174+
<noscript><div class="statcounter"><a title="Web Analytics"
175+
href="https://statcounter.com/" target="_blank"><img
176+
class="statcounter"
177+
src="https://c.statcounter.com/13006360/0/8e4900b1/0/"
178+
alt="Web Analytics"
179+
referrerPolicy="no-referrer-when-downgrade"></a></div></noscript>
180+
<!-- End of Statcounter Code -->

0 commit comments

Comments
 (0)