ウェブリンクを復元

post

https://api.box.com/2.0

/web_links/:web_link_id/

ごみ箱に移動されたウェブリンクを復元します。

元のフォルダが削除されている場合にウェブリンクの復元先となる新しい親ID(省略可)を指定することができます。

関連するガイド

ごみ箱ウェブリンクの復元

リクエスト

AuthorizationBearer [ACCESS_TOKEN]

Content-Typeapplication/json

パスパラメータ

web_link_id stringパス内必須

例12345

ウェブリンクのID。

クエリパラメータ

fields string arrayクエリ内省略可能

例id,type,name

応答に含める属性のカンマ区切りリスト。このパラメータを使用すると、標準の応答には通常含まれないフィールドをリクエストできます。

このパラメータを指定すると、明示的に指定しない限り標準フィールドは応答に含まれず、リクエストしたフィールドのほかには、簡易版レプリゼンテーションのフィールドしか返されないことに注意してください。

リクエスト本文

name string本文内省略可能

例Restored.docx

ウェブリンクの新しい名前(省略可)。

parent object本文内

元のフォルダがすでに存在しない場合にウェブリンクの復元先となるフォルダのID(省略可)を指定します。

このIDは、元のフォルダがすでに存在しない場合にのみ使用されることに注意してください。このIDは、元の場所が削除されている場合にウェブリンクの復元先となるフォールバックの場所を指定します。

parent.id stringnull省略可能

例123

親項目のID

レスポンス

201application/jsonウェブリンク (標準)

ウェブリンクオブジェクトが復元された場合は、そのオブジェクトを返します。

403application/jsonクライアントエラー

ウェブリンクの復元先フォルダに対してユーザーがアクセス権限を持っていない場合、またはごみ箱からウェブリンクを復元する権限を持っていない場合は、エラーを返します。

404application/jsonクライアントエラー

ウェブリンクがごみ箱内にない場合は、エラーを返します。

409application/jsonクライアントエラー

ウェブリンクの復元先フォルダに同じ名前のウェブリンクが存在する場合は、エラーを返します。

defaultapplication/jsonクライアントエラー

予期しないクライアントエラー。

post

ウェブリンクを復元

このドキュメント内で一部のAPIを試せるようになりました。

ログイン

リクエストの例

cURL

curl -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))

レスポンスの例

{
  "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": [
    {
      "id": 12345,
      "etag": 1,
      "type": "folder",
      "sequence_id": 3,
      "name": "Contracts"
    }
  ],
  "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_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"
}