ウェブリンクを復元
ごみ箱に移動されたウェブリンクを復元します。
元のフォルダが削除されている場合にウェブリンクの復元先となる新しい親ID (省略可) を指定することができます。
リクエスト
bearer [ACCESS_TOKEN]
application/json
パスパラメータ
stringパス内必須
12345ウェブリンクのID。
クエリパラメータ
string arrayクエリ内省略可能
id,type,nameレスポンスに含める属性のカンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
リクエスト本文
string本文内省略可能
"Restored.docx"ウェブリンクの新しい名前 (省略可)。
object本文内
元のフォルダがすでに存在しない場合にウェブリンクの復元先となるフォルダのID (省略可) を指定します。
このIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にウェブリンクの復元先となるフォールバックの場所を指定します。
string本文内省略可能
"123"親項目のID
レスポンス
application/jsonごみ箱内のウェブリンク (復元済み)
ウェブリンクオブジェクトが復元された場合は、そのオブジェクトを返します。
application/jsonクライアントエラー
ウェブリンクの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からウェブリンクを復元する権限を持っていない場合は、エラーを返します。
application/jsonクライアントエラー
ウェブリンクがごみ箱内にない場合は、エラーを返します。
application/jsonクライアントエラー
ウェブリンクの復元先フォルダに同じ名前のウェブリンクが存在する場合は、エラーを返します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -i -X POST "https://api.box.com/2.0/web_links/12345" \
-H "authorization: Bearer <ACCESS_TOKEN>"Python
web_link_to_restore = client.web_link(web_link_id='33333')
restored_web_link = client.trash().restore_item(web_link_to_restore)
print(f'Web link ID is {restored_web_link.id} and name is {restored_web_link.name}')レスポンスの例
{
"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": "trashed",
"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": "null",
"sequence_id": "3",
"shared_link": "null",
"trashed_at": "null",
"url": "https://www.example.com/example/1234"
}