ウェブリンクを復元
ごみ箱に移動されたウェブリンクを復元します。
元のフォルダが削除されている場合にウェブリンクの復元先となる新しい親ID (省略可) を指定することができます。
Request
Bearer [ACCESS_TOKEN]
application/json
Path Parameters
stringin pathrequired
12345ウェブリンクのID。
Query Parameters
string arrayin queryoptional
id,type,nameレスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。
Request Body
stringin bodyoptional
Restored.docxウェブリンクの新しい名前 (省略可)。
objectin body
元のフォルダがすでに存在しない場合にウェブリンクの復元先となるフォルダのID (省略可) を指定します。
このIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にウェブリンクの復元先となるフォールバックの場所を指定します。
stringin bodyoptional
123親項目のID
Response
application/jsonウェブリンク (Standard)
ウェブリンクオブジェクトが復元された場合は、そのオブジェクトを返します。
application/jsonクライアントエラー
ウェブリンクの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からウェブリンクを復元する権限を持っていない場合は、エラーを返します。
application/jsonクライアントエラー
ウェブリンクがごみ箱内にない場合は、エラーを返します。
application/jsonクライアントエラー
ウェブリンクの復元先フォルダに同じ名前のウェブリンクが存在する場合は、エラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
Request Example
cURL
curl -i -X POST "https://api.box.com/2.0/web_links/12345" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \Python
web_link_to_restore = client.web_link(web_link_id='33333')
restored_web_link = client.trash().restore_item(web_link_to_restore)
print('Web link ID is {0} and name is {1}'.format(restored_web_link.id, restored_web_link.name))Response Example
{
"id": 11446498,
"type": "web_link",
"created_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": 11446498,
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"description": "Example page",
"etag": 1,
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": 11446498,
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"name": "My Bookmark",
"owned_by": {
"id": 11446498,
"type": "user",
"login": "ceo@example.com",
"name": "Aaron Levie"
},
"parent": {
"id": 12345,
"type": "folder",
"etag": 1,
"name": "Contracts",
"sequence_id": 3
},
"path_collection": {
"entries": [
{
"id": 12345,
"etag": 1,
"type": "folder",
"sequence_id": 3,
"name": "Contracts"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"sequence_id": 3,
"shared_link": {
"access": "open",
"download_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"permissions": {
"can_download": true,
"can_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_name": "my_url",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"trashed_at": "2012-12-12T10:53:43-08:00",
"url": "https://www.example.com/example/1234"
}