Box Developerドキュメント
 
    最新バージョン

    ファイルに共有リンクを追加

    put
    https://api.box.com/2.0
    /files/:file_id

    このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

    ファイルに共有リンクを追加します。

    リクエスト

    bearer [ACCESS_TOKEN]
    application/json

    パスパラメータ

    stringパス内必須
    12345

    ファイルを表す一意の識別子。

    ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_id123です。

    クエリパラメータ

    stringクエリ内必須
    shared_link

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

    リクエスト本文

    レスポンス

    application/jsonファイル (Full)

    新しい共有リンクが追加されているファイルのBase版の表示を返します。

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

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

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

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

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

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

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

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

    リクエストの例

    cURL
    curl -i -X PUT "https://api.box.com/2.0/files/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
             }
           }
         }'

    レスポンスの例

    {
      "etag": "1",
      "id": "12345",
      "shared_link": {
        "access": "open",
        "download_count": 0,
        "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
        "effective_access": "open",
        "effective_permission": "can_download",
        "is_password_enabled": false,
        "permissions": {
          "can_download": true,
          "can_edit": true,
          "can_preview": true
        },
        "preview_count": 0,
        "unshared_at": "2020-09-21T10:34:41-07:00",
        "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
        "vanity_name": null,
        "vanity_url": null
      },
      "type": "file"
    }