ウェブリンクに共有リンクを追加

put
https://api.box.com/2.0
/web_links/:web_link_id

ウェブリンクに共有リンクを追加します。

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

クエリパラメータ

stringクエリ内必須
shared_link

この項目に返されるshared_linkフィールドを明示的にリクエストします。

リクエスト本文

レスポンス

新しい共有リンクが追加されているウェブリンクのBase版の表示を返します。

権限の組み合わせが正しくない場合に返されます。

Authorizationヘッダーで指定されているアクセストークンが認識されないか、指定されていない場合に返されます。

更新を完了するための権限がユーザーに不足している場合に返されます。

ファイルが見つからない場合、またはユーザーにファイルへのアクセス権限が与えられていない場合に返されます。

file_idが認識されていない形式で指定されている場合に返されます。

If-Matchヘッダーがファイルの現在のetag値と一致しない場合にエラーを返します。これは、ファイルが前回リクエストされたときから変更されていることを示します。

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

put
ウェブリンクに共有リンクを追加
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

cURL
curl -i -X PUT "https://api.box.com/2.0/web_links/32423234?fields=shared_link" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "shared_link": {
         "access": "open",
         "password": "mypassword",
         "unshared_at": "2012-12-12T10:53:43-08:00",
         "permissions": {
           "can_download": false
         }
       }
     }'
.NET
string webLinkId = "11111";
var sharedLinkParams = new BoxSharedLinkRequest()
{
    Access = BoxSharedLinkAccessType.open
};
BoxWebLink link = client.WebLinksManager
    .CreateSharedLinkAsync(webLinkId, sharedLinkParams);
string sharedLinkUrl = link.SharedLink.Url;
Python
url = client.web_link('12345').get_shared_link(access='open')
print(f'The web link shared link URL is: {url}')

レスポンスの例

{
  "type": "error",
  "code": "item_name_invalid",
  "context_info": {
    "message": "Something went wrong."
  },
  "help_url": "http://developers.box.com/docs/#errors",
  "message": "Method Not Allowed",
  "request_id": "abcdef123456",
  "status": 400
}