You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
| fail |Default behavior is to report the failure. |
47
-
| replace |Overwrite existing item at the target site. |
48
-
| rename |Rename the item. |
46
+
| fail |The entire operation fails when a conflict occurs. This behavior is the default if no option is specified.|
47
+
| replace |The preexisting file item is deleted and replaced with the new item when a conflict occurs. This option is only supported for file items. The new item has the same name as the old one. The old item's history is deleted.|
48
+
| rename |Appends the lowest integer that guarantees uniqueness to the name of the new file or folder and completes the operation.|
49
49
50
+
If you specify `@microsoft.graph.conflictBehavior=replace` for a source folder item, this API returns a `202 Accepted` response. In this case, querying the monitoring url reports a `nameAlreadyExists` error. If you specify this parameter with the `childrenOnly` parameter, a nameAlreadyExists error occurs if there are any folder items in the source item's children.
50
51
51
52
>[!NOTE]
52
53
>The `conflictBehavior` parameter isn't supported for OneDrive Consumer.
@@ -60,14 +61,17 @@ In the request body, provide a JSON object with the following parameters.
60
61
| parentReference |[ItemReference](../resources/itemreference.md)| Optional. Reference to the parent item the copy is created in. |
61
62
| name | string | Optional. The new name for the copy. If this information isn't provided, the same name is used as the original. |
62
63
| childrenOnly | Boolean | Optional. If set to `true`, the children of the **driveItem** are copied but not the **driveItem** itself. The default value is `false`. Valid _only_ on folder items. |
63
-
| includeAllVersionHistory | Boolean | Optional. If set to `true`, source files version history (major versions and minor versions, if any) should be copied to the destination, within the target version setting limit. If `false`, only the latest major version is copied to the destination. The default value is `false`. |
64
+
| includeAllVersionHistory | Boolean | Optional. If set to `true`, source files version history (major versions and minor versions, if any) should be copied to the destination, within the target version setting limit. If `false`, only the latest major version is copied to the destination. The default value is `false`. |
64
65
65
66
66
67
>[!NOTE]
67
68
>The `parentReference` parameter should include the `driveId` and `id` parameters for the target folder.
68
69
>
69
70
>In a single request, the `childrenOnly` option copies 150 children items, and for the grandchildren items the SharePoint limit applies. For more information, see [SharePoint limitation](/office365/servicedescriptions/sharepoint-online-service-description/sharepoint-online-limits#moving-and-copying-across-sites)
70
71
72
+
> If you use the `@microsoft.graph.conflictBehavior` query parameter with the `childrenOnly` parameter, then every child in the operation will be subject to the `@microsoft.graph.conflictBehavior` specified.
73
+
74
+
71
75
## Response
72
76
73
77
The response returns details about how to [monitor the progress](/graph/long-running-actions-overview) of the copy, upon accepting the request. The response indicates whether the copy operation was accepted or rejected - for example, if the destination filename is already in use.
@@ -76,7 +80,7 @@ The response returns details about how to [monitor the progress](/graph/long-run
76
80
77
81
### Example 1: Copy a file to a folder
78
82
79
-
The following example copies a file identified by `{item-id}` into a folder identified with a`driveId` and `id`value.
83
+
The following example copies a file identified by `{item-id}` into a folder identified by the`driveId` and `id`values.
80
84
The new copy of the file is named `contoso plan (copy).txt`.
Monitoring is important because the copy operation with childrenOnly occurs across multiple operations.
210
213
211
-
### Example 3: Copy the children in a folder with name conflict
214
+
The `Location` field of the response contains a monitoring URL that you can use to check the progress of the copy operation. Because copy operations happen asynchronously and can finish after an unspecified amount of time, you can use this URL repeatedly to track its status.
212
215
213
-
The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value.
214
-
The destination already has the same name found at the source. The operation is accepted but it encounters a failure during processing.
216
+
To receive a status report similar to the one in the following example, GET the URL in the `Location` field of the response.
### Example 3: Failure to copy a file item to a folder with a preexisting item with the same name
232
+
233
+
The following example attempts to copy a file item identified by `{item-id}` into a folder identified by the `driveId` and `id` property values. In this example, the destination already has a file with the same name. However, because the request doesn't specify a `@microsoft.graph.conflictBehavior` query parameter value of either `replace` or `rename`, the operation is accepted but fails during processing.
The following example shows an example status report obtained by visiting the URL in the value of the `Location` field in the response to the initial request.
277
296
```http
278
297
{
279
298
"id": "46cf980a-28e1-4623-b8d0-11fc5278efe6",
@@ -286,13 +305,13 @@ Follow the monitor url.
286
305
}
287
306
}
288
307
```
289
-
To resolve this error, use the optional query parameter [@microsoft.graph.conflictBehavior](#optional-query-parameters).
290
308
291
-
### Example 4: Copy the children in a folder with name conflict setting conflictBehavior
309
+
To resolve this error, use the optional query parameter [@microsoft.graph.conflictBehavior](#optional-query-parameters) as seen in the [next example](#example-4-copy-a-file-item-to-a-folder-with-a-preexisting-item-with-the-same-name-by-specifying-the-microsoftgraphconflictbehavior-query-parameter).
292
310
293
-
The following example copies the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value.
294
-
The optional query parameter @microsoft.graph.conflictBehavior is set to replace. The possible values are `replace`, `rename`, or `fail`.
295
-
The destination already has the same name found at the source.
311
+
### Example 4: Copy a file item to a folder with a preexisting item with the same name by specifying the @microsoft.graph.conflictBehavior query parameter
312
+
313
+
The following example copies a file item identified by `{item-id}` into a folder identified by the `driveId` and `id` values.
314
+
In this example, the destination already has a file with the same name. The query parameter `@microsoft.graph.conflictBehavior` is set to replace. The possible values are `replace`, `rename`, or `fail`.
### Example 5: Copy operation preserve version history
376
+
### Example 5: Failure to copy child items that contain a folder item by specifying @microsoft.graph.conflictBehavior as replace
358
377
359
-
The following example copies the item identified by `{item-id}` into a folder identified with a `driveId` and `id` value. It also copies the version history to the target folder. If the source file contains 20 versions and the destination version limit setting is 10, the copy only transfers the maximum number of versions the destination site allows, starting from the most recent.
378
+
The following example attempts to copy the child items in a folder identified by `{item-id}` into a folder identified by the `driveId` and `id` values. One of the child items is a folder item. The destination might have items with colliding names to the children at the source folder. The request attempts to resolve potential name conflicts by setting the optional query parameter `@microsoft.graph.conflictBehavior` to replace. The request is accepted but the monitoring url reports failures. Instead use `rename` or `fail` if at least one of the children is a folder item.
"message": "Errors occurred during copy/move operation.",
419
+
"details": [
420
+
{
421
+
"code": "nameAlreadyExists",
422
+
"message": "Name already exists"
423
+
},
424
+
{
425
+
"code": "nameAlreadyExists",
426
+
"message": "Name already exists"
427
+
},
428
+
{
429
+
"code": "nameAlreadyExists",
430
+
"message": "Name already exists",
431
+
"target": "01E4CGZM4FGUVRMKSJWBCLZQTWNFGHOTXG"
432
+
},
433
+
{
434
+
"code": "nameAlreadyExists",
435
+
"message": "Name already exists",
436
+
"target": "01E4CGZM2XRHETBOUOYVA2OKZFMGGBQ6VU"
437
+
}
438
+
]
439
+
}
440
+
}
441
+
```
442
+
443
+
### Example 6: Copy item to a destination folder and preserve its version history
444
+
445
+
The following example copies the item identified by `{item-id}` into a folder identified by the `driveId` and `id` values. It also copies the version history to the target folder. If the source file contains more versions than the destination version limit setting, the copy only transfers the maximum number of newest versions that the destination site allows.
### Example 6: Copy the children in a folder from root
510
+
### Example 7: Failure to copy child items in a root folder without specifying the childreOnly parameter as true
425
511
426
-
The following example attempts to copy the children in a folder identified by `{item-id}` (also known as root) into a folder identified with a`driveId` and `id`value.
512
+
The following example attempts to copy the child items in the folder identified by `{item-id}`, also known as "root," into a folder identified by the`driveId` and `id`values.
427
513
The `childrenOnly` parameter isn't set to true.
428
-
The request fails because the copy operation can't be done in the root folder.
514
+
The request fails because the copy operation can't be done on the root folder.
Visiting the monitoring URL yields a status report similar to the following example.
495
582
496
583
<!-- { "blockType": "ignored" } -->
497
584
```http
@@ -516,9 +603,9 @@ Content-Length: 341
516
603
```
517
604
To resolve this error, reorganize the source folder structure only to have 150 children.
518
605
519
-
### Example 8: Copy the children where the source item is a file
606
+
### Example 9: Failure to copy the child items of a file item
520
607
521
-
The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a`driveId` and `id`value.
608
+
The following example attempts to copy the children of a source item identified by `{item-id}` into a folder identified by the`driveId` and `id`values.
522
609
The `{item-id}` refers to a file, not a folder. The `childrenOnly` parameter is set to true.
523
610
The request fails since the `{item-id}` is a nonfolder driveItem.
Visiting the monitoring URL yields a status report similar to the following example.
544
631
545
632
<!-- { "blockType": "ignored" } -->
546
633
```http
@@ -563,11 +650,9 @@ Content-Length: 290
563
650
}
564
651
```
565
652
566
-
### Example 9: Copy the children in a folder with childrenOnly and name
653
+
### Example 10: Failure to copy child items by specifying both the childrenOnly and name request body parameters
567
654
568
-
The following example attempts to copy the children in a folder identified by `{item-id}` into a folder identified with a `driveId` and `id` value.
569
-
The `childrenOnly` parameter is set to true and specify a `name` value.
570
-
The request fails because `childrenOnly` and `name` can't be used together.
655
+
The following example attempts to copy the child items in a folder identified by `{item-id}` into a folder identified by the `driveId` and `id` values. The request body sets the `childrenOnly` parameter to true and also specifies a `name` value. The request fails as the `childrenOnly` and `name` parameters are mutually exclusive.
Copy file name to clipboardExpand all lines: api-reference/v1.0/api/onlinemeeting-update.md
+1Lines changed: 1 addition & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -95,6 +95,7 @@ The last column indicates whether updating this property will take effect for an
95
95
| allowMeetingChat | meetingChatMode | Specifies the mode of meeting chat. | Yes |
96
96
| allowPowerPointSharing | Boolean | Indicates whether PowerPoint live is enabled for the meeting. | No |
97
97
| allowTeamworkReactions | Boolean | Indicates whether Teams reactions are enabled for the meeting. | Yes |
98
+
| allowedLobbyAdmitters |[allowedLobbyAdmitterRoles](../resources/onlinemeetingbase.md#allowedlobbyadmitterroles-values)| Specifies the users who can admit from the lobby. Possible values are: `organizerAndCoOrganizersAndPresenters`, `organizerAndCoOrganizers`, `unknownFutureValue`. | Yes |
98
99
| allowWhiteboard | Boolean | Indicates whether whiteboard is enabled for the meeting. Inherited from [onlineMeetingBase](../resources/onlinemeetingbase.md). |
99
100
| endDateTime | DateTime | The meeting end time in UTC. | No |
100
101
| isEntryExitAnnounced | Boolean | Whether or not to announce when callers join or leave. | Yes |
0 commit comments