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
| Prompt Message | Specifies the message that users see when they initiate the integration. Use this field to provide context about what happens next. The message is limited to 500 characters. |
The **Callback Parameters** section configures the parameters that Box sends to the callback URL when a user accepts a confirmation prompt. If this setting is not configured, Box does not send any parameters to the callback URL. To add a parameter, select the **Method** (GET or POST), specify the **Parameter name** and add a **Parameter value**.
The **File** method is no longer supported. If you already used this method, you cannot edit its values. You can change the **File** method to **GET** or **POST**, but you can't undo this action.
To add content to an archive, you need to create it first. If you have not done this yet, use the [Create Archive][Create Archive] endpoint.
30
+
31
+
## Add file or folder to archive
32
+
33
+
Use the [`PUT /files/:id`][Update file] API endpoint to add a file to an archive, or the [`PUT /folders/:id`][Update folder] endpoint to add a folder. The `id` parameter is the ID of the file/folder you want to add to the archive. To specify the destination, use the `parent.id`[parameter][Update parent id of folder] in the request body. This can be either an ID of an archive or the ID of a folder that is inside an archive.
Box Archive is available only for Enterprise Advanced accounts.
36
+
37
+
</Message>
38
+
39
+
Box Archive allows you to create and manage archives. An archive is a folder dedicated to storing content that is redundant, outdated, or trivial. Content in an archive is owned by the enterprise, and it is not accessible to previous owner and collaborators.
40
+
41
+
## Archives are folders
42
+
43
+
Archives are a special type of folders. Box Archive APIs allow you to create, list and delete archives. However, there are other APIs that also work with archives or with content within archives. For a full list of supported APIs, see the [Supported APIs][Supported APIs] guide.
44
+
45
+
## 必須のスコープ
46
+
47
+
Before using any of the Box Archive APIs, make sure you can access [Box Archive in Admin Console][Box Archive in Admin Console]. Your Box Platform app must have the `GCM` and `Read and write all files and folders`[scopes][Scopes] enabled. If you plan to only view archives and not modify them, use the `Read all files and folders` instead of the `Read and write all files and folders` scope.
48
+
49
+
<Messagetype="notice">
50
+
51
+
The `GCM` scope is not available in the Developer Console and needs to be enabled by contacting customer support.
52
+
53
+
</Message>
54
+
55
+
[Supported APIs]: g://archives/supported-apis
56
+
57
+
[Box Archive in Admin Console]: https://support.box.com/hc/en-us/p/Product_Page_2023?section-id=40168863437843
This guide describes how to restore content that you archived by mistake.
29
+
30
+
## Restore file or folder from archive
31
+
32
+
Use the [`PUT /files/:id`][Update file] API endpoint to restore a file from an archive, or the [`PUT /folders/:id`][Update folder] endpoint to restore a folder from an archive. The `id` parameter is the ID of the file/folder you want to restore from an archive. To specify the destination, use the `parent.id`[parameter][Update parent id of folder] in the request body. This is the ID of a folder (can be owned by any user) where you want to restore the file/folder.
33
+
34
+
To restore a file/folder to user's root folder, use `0` as the `parent.id` value. Additionally, pass the ID of the user in the `parent.user_id`[parameter][Update parent user id of folder] in the request body.
35
+
36
+
[Update file]: e://put-files-id
37
+
38
+
[Update parent id of file]: https://developer.box.com/reference/put-files-id/#param-parent-id
39
+
40
+
[Update parent user id of file]: https://developer.box.com/reference/put-files-id/#param-parent-user_id
41
+
42
+
[Update folder]: e://put-folders-id
43
+
44
+
[Update parent id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-id
45
+
46
+
[Update parent user id of folder]: https://developer.box.com/reference/put-folders-id/#param-parent-user_id
0 commit comments