Join a webinar on April 30th: Unlocking Your Data using AI with Box Extract & MCP Server. Register here
user_client.shared_links_web_links.find_web_link_for_shared_link(
"".join(
[
"shared_link=",
web_link_from_api.shared_link.url,
"&shared_link_password=Secret123@",
]
)
){
"id": "11446498",
"type": "web_link",
"etag": "1",
"url": "https://www.example.com/example/1234",
"sequence_id": "3",
"name": "My Bookmark",
"parent": {
"id": "12345",
"type": "folder",
"etag": "1",
"sequence_id": "3",
"name": "Contracts"
},
"description": "Example page",
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"type": "folder",
"etag": "1",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"trashed_at": "2012-12-12T10:53:43-08:00",
"purged_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"download_count": 3,
"preview_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"unshared_at": "2018-04-13T13:53:23-07:00",
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
}
},
"item_status": "active"
}共有リンクのウェブリンクを検索
共有リンクで表されるウェブリンクを返します。
共有ウェブリンクは、共有リンクで表すことが可能で、現在の企業内に存在する項目である場合も、別の企業内に存在する項目である場合もあります。
アプリケーションからこのエンドポイントを呼び出すと、共有ウェブリンクについての情報を取得できます (共有リンクが存在する場合のみ)。
user_client.shared_links_web_links.find_web_link_for_shared_link(
"".join(
[
"shared_link=",
web_link_from_api.shared_link.url,
"&shared_link_password=Secret123@",
]
)
){
"id": "11446498",
"type": "web_link",
"etag": "1",
"url": "https://www.example.com/example/1234",
"sequence_id": "3",
"name": "My Bookmark",
"parent": {
"id": "12345",
"type": "folder",
"etag": "1",
"sequence_id": "3",
"name": "Contracts"
},
"description": "Example page",
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"type": "folder",
"etag": "1",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"trashed_at": "2012-12-12T10:53:43-08:00",
"purged_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": {
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"effective_access": "company",
"effective_permission": "can_download",
"is_password_enabled": true,
"download_count": 3,
"preview_count": 3,
"download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
"vanity_url": "https://acme.app.box.com/v/my_url/",
"vanity_name": "my_url",
"access": "open",
"unshared_at": "2018-04-13T13:53:23-07:00",
"permissions": {
"can_download": true,
"can_preview": true,
"can_edit": false
}
},
"item_status": "active"
}Documentation Index
Fetch the complete documentation index at: https://developer.box.com/llms.txt
Use this file to discover all available pages before exploring further.
承認
The access token received from the authorization server in the OAuth 2.0 flow.
ヘッダー
項目が変更されている場合にのみ、その項目を返します。
その項目の最後に認識されたetag値をこのヘッダーに渡すと、それ以降に項目が変更されていない場合、エンドポイントは304 Not Modifiedを返して失敗します。
共有リンクとその共有リンクの省略可能なパスワードを含むヘッダー。
このヘッダーの形式は次のようになります。
shared_link=[link]&shared_link_password=[password].
クエリパラメータ
レスポンスに含める属性のコンマ区切りリスト。このパラメータを使用すると、標準のレスポンスには通常含まれないフィールドをリクエストできます。
このパラメータを指定すると、明示的に指定しない限り標準フィールドはレスポンスに含まれず、リクエストしたフィールドのほかには、Mini版の表示のフィールドしか返されないことに注意してください。
レスポンス
共有リンクが有効で、ユーザーがそのリンクに対するアクセス権限を持っている場合は、Full版のウェブリンクリソースを返します。
ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。
ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。
このウェブリンクの一意の識別子。
"11446498"
値は常にweb_linkになります。
web_link "web_link"
このウェブリンクのエンティティタグ。If-Matchヘッダーで使用します。
"1"
このウェブリンクが指すURL。
"https://www.example.com/example/1234"
この項目に適用された最新のUser Eventを表す数値の識別子。
これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。
たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。
"3"
ウェブリンクの名前。
"My Bookmark"
ウェブリンクが属する親オブジェクト。
Show child attributes
Show child attributes
ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。
"Example page"
ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。
Show child attributes
Show child attributes
このファイルがBoxのサーバー上に作成された日時。
"2012-12-12T10:53:43-08:00"
このファイルがBoxサーバー上で最後に更新された日時。
"2012-12-12T10:53:43-08:00"
このファイルがごみ箱に移動された日時。
"2012-12-12T10:53:43-08:00"
このファイルが完全に削除される日時。
"2012-12-12T10:53:43-08:00"
このウェブリンクを作成したユーザー。
Show child attributes
Show child attributes
このウェブリンクを最後に変更したユーザー。
Show child attributes
Show child attributes
このウェブリンクを所有するユーザー。
Show child attributes
Show child attributes
この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、nullになります。
Show child attributes
Show child attributes
この項目が削除されたかどうか。値には、active、trashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。
active, trashed, deleted "active"
このページは役に立ちましたか？