共有リンクのフォルダを検索

get
https://api.box.com/2.0
/shared_items/

共有リンクで表されるフォルダを返します。

共有フォルダは、共有リンクで表すことが可能で、現在の会社内に存在する項目である場合も、別の会社内に存在する項目である場合もあります。

アプリケーションからこのエンドポイントを呼び出すと、共有フォルダについての情報を取得できます (共有リンクが存在する場合のみ)。

Request

Bearer [ACCESS_TOKEN]
application/json

Query Parameters

string arrayin queryoptional
id,type,name

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

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

Request Headers

stringin header
required
shared_link=[link]&shared_link_password=[password]

共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。

このヘッダーの形式は次のようになります。

shared_link=[link]&shared_link_password=[password]

stringin header
optional
1

項目が変更されている場合にのみ、その項目を返します。

その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modifiedを返して失敗します。

Response

application/jsonFolder (Standard)

共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、完全版のフォルダリソースを返します。

none

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

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

get
共有リンクのフォルダを検索
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/shared_items" \
     -H "Authorization: Bearer <ACCESS_TOKEN>" \
     -H "BoxApi: shared_link=https://app.box.com/s/jsasdsd8sad24&shared_link_password=letmein"
Java
String sharedLink = "https://app.box.com/s/abcdefghijklmnopqrstuvwxyz123456";
String password = "letmein";
BoxItem.Info itemInfo = BoxItem.getSharedItem(api, sharedLink, password);
Python
folder = client.get_shared_item('https://app.box.com/s/gjasdasjhasd', password='letmein')
Node
client.sharedItems.get(
  'https://app.box.com/s/gjasdasjhasd',
  'letmein'
),then(folder => {
  //...
});

Response Example

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