Skip to content

Commit cfc8756

Browse files
updated export-amr-api.md
Content fix: correcting info on IncludeSecurity, plus issues regarding performance.
1 parent 9f7603c commit cfc8756

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

docs/apis/export-amr-api.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -116,17 +116,20 @@ If set, this indicates all the files and list item version history is to be incl
116116
IncludeSecurity{ get; set; }
117117
```
118118

119-
This flag indicates whether to include all user or group information from a site. By default, it assumes the security is not set, hence no user or group information is provided.
119+
This flag indicates whether to include all user or group information from a site. By default, users and groups that are part of the object metadata will be returned, such as author or modifier.
120120

121121
If you use this flag, all users in the site collection will be included. If you are issuing AMR calls for different document libraries that are under the same site collection, the same set of users will be included each time, unless there has been a change.
122122

123-
For large number of objects in a document library, it is faster to do the following two calls for reading the security setting and its child folders:
123+
>[!Important]
124+
>Using this option can result in very slow performance. Use it only as described in the steps below.
125+
126+
If you have a large number of objects in a document library, it is faster to do the following two calls to read the security setting and its child folders:
124127

125128
1. To get user/group info, call the AMR job on the top root folder with security on using this setting:
126129
("IncludeSecurity=true" & "IncludeDirectDescendantsOnly=true").
127130
</br>
128-
2. For the rest of the structure, call the AMR job with the security off with this setting:
129-
("IncludeSecurity=false" & "IncludeDirectDescendantsOnly=false")
131+
2. For the rest of the structure, call the AMR job with the security off:
132+
"IncludeSecurity=false"
130133

131134

132135
```c#

0 commit comments

Comments
 (0)