ウェブリンクを更新

このリソースは、バージョン2024.0のエンドポイントで使用されています。詳細については、 Box APIのバージョン管理を参照してください。「Box SDKのバージョニング戦略について詳しく学ぶ。」

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

web_link_id

string

required

ウェブリンクのID。

Body

application/json

url

string

ウェブリンクのリンク先となる新しいURL。"http://"または"https://"で始まっている必要があります。

Example:

"https://box.com"

parent

object

ウェブリンクが配置される新しい親フォルダ。これを利用してウェブリンクを別のフォルダに移動します。

表示子属性

parent.id

string

親項目のID。

Example:

"123"

parent.user_id

string

user_idの入力は省略可能です。user_idが存在する場合、ルート以外のフォルダへの移動は許可されません。user_idが指定されている場合、親フォルダIDはゼロにする必要があります。

Example:

"12346930"

name

string

ウェブリンクの新しい名前。設定されていない場合は、デフォルトでURLに設定されます。

Example:

"Box Website"

description

string

ウェブリンクの新しい説明。

Example:

"Cloud Content Management"

shared_link

object

更新する共有リンクの設定。

表示子属性

shared_link.access

enum<string>

共有リンクのアクセスレベル。これは、リンクを知っている全員 (open)、会社内のユーザーのみ (company)、フォルダに招待されたユーザーのみ (collaborators) のいずれかに制限できます。

設定しなかった場合、このフィールドは、デフォルトで、企業の管理者が指定したアクセスレベルになります。このデフォルトの設定で共有リンクを作成するには、{ "shared_link": {} }のように、accessフィールドを指定せずにshared_linkオブジェクトを渡します。

companyアクセスレベルは、有料アカウントのみで使用できます。

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

shared_link.password

string | null

共有リンクへのアクセスに必要なパスワード。パスワードをnullに設定するとパスワードが削除されます。今後、パスワードは8文字以上にし、数字、大文字、または英数字以外の文字を含める必要があります。accessがopenに設定されている場合にのみ、パスワードを設定できます。

Example:

"do-not-use-this-password"

shared_link.vanity_name

string

共有リンクのURLで使用するカスタムバニティ名を定義します (例: https://app.box.com/v/my-shared-link)。

バニティURLは通常の共有リンクよりもかなり推測しやすいため、機密性の高いコンテンツを共有する場合は、カスタムURLを使用しないでください。

Minimum string length: 12

Example:

"my-shared-link"

shared_link.unshared_at

string<date-time>

この共有リンクの有効期限が切れる日時のタイムスタンプ。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。この値には、現在の日時より後の日時を指定する必要があります。

Example:

"2012-12-12T10:53:43-08:00"

Response

更新されたウェブリンクオブジェクトを返します。

ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。ウェブリンクとは、URLを指すオブジェクトです。これらのオブジェクトはBoxウェブアプリケーション内ではブックマークとも呼ばれます。

ウェブリンクオブジェクトはファイルオブジェクトと同様に扱われ、通常のファイルに適用されるアクションの大部分もサポートしています。

string

required

このウェブリンクの一意の識別子。

Example:

"11446498"

type

enum<string>

required

値は常にweb_linkになります。

利用可能なオプション:

web_link

Example:

"web_link"

etag

string

このウェブリンクのエンティティタグ。If-Matchヘッダーで使用します。

Example:

"1"

url

string

このウェブリンクが指すURL。

Example:

"https://www.example.com/example/1234"

sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

たとえば、Box DriveなどのアプリケーションがAPIを介して項目を取得し、その項目の変更に関連するUser Eventの発生を監視する場合などがこれに該当します。User Eventのsequence_idが最初に取得されたリソースのsequence_idよりも小さいか同じである場合、アプリケーションはそのようなUser Eventをすべて無視します。

Example:

"3"

name

string

ウェブリンクの名前。

Example:

"My Bookmark"

parent

フォルダ (Mini) · object

ウェブリンクが属する親オブジェクト。

表示子属性

parent.id

string

required

フォルダを表す一意の識別子。

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

Example:

"12345"

parent.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

parent.etag

string | null

このフォルダのHTTP etag。これは変更が発生した場合 (またはしなかった場合) にフォルダに対して変更を行う目的でのみ、If-MatchおよびIf-None-Matchヘッダー内の一部のAPIエンドポイントで使用できます。

Example:

"1"

parent.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

parent.name

string

フォルダの名前。

Example:

"Contracts"

description

string

ウェブリンクに付加される説明。この説明は、Boxウェブアプリケーション内に表示されます。

Example:

"Example page"

path_collection

パスのコレクション · object

ルートフォルダを起点にした、このウェブリンクを含むフォルダツリー。

表示子属性

path_collection.total_count

integer<int64>

required

このリスト内のフォルダの数。

Example:

1

path_collection.entries

フォルダ (Mini) · object[]

required

この項目の親フォルダ。

表示子属性

path_collection.entries.id

string

required

フォルダを表す一意の識別子。

Example:

"12345"

path_collection.entries.type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

path_collection.entries.etag

string | null

Example:

"1"

path_collection.entries.sequence_id

string | null

この項目に適用された最新のUser Eventを表す数値の識別子。

これをGET /eventsエンドポイントと組み合わせて使用すると、この識別子が読み取られる前に発生した可能性があるUser Eventを除外できます。

Example:

"3"

path_collection.entries.name

string

フォルダの名前。

Example:

"Contracts"

created_at

string<date-time>

このファイルがBoxのサーバー上に作成された日時。

Example:

"2012-12-12T10:53:43-08:00"

modified_at

string<date-time>

このファイルがBoxサーバー上で最後に更新された日時。

Example:

"2012-12-12T10:53:43-08:00"

trashed_at

string<date-time> | null

このファイルがごみ箱に移動された日時。

Example:

"2012-12-12T10:53:43-08:00"

purged_at

string<date-time> | null

このファイルが完全に削除される日時。

Example:

"2012-12-12T10:53:43-08:00"

created_by

ユーザー (Mini) · object

このウェブリンクを作成したユーザー。

表示子属性

created_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

created_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

created_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

modified_by

ユーザー (Mini) · object

このウェブリンクを最後に変更したユーザー。

表示子属性

modified_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

modified_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

modified_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

owned_by

ユーザー (Mini) · object

このウェブリンクを所有するユーザー。

表示子属性

owned_by.id

string

required

このユーザーの一意の識別子。

Example:

"11446498"

owned_by.type

enum<string>

required

値は常にuserになります。

利用可能なオプション:

user

Example:

"user"

owned_by.name

string

このユーザーの表示名。

Maximum string length: 50

Example:

"Aaron Levie"

このユーザーのプライマリメールアドレス。

Example:

"ceo@example.com"

shared_link

共有リンク · object

この項目の共有リンクオブジェクト。共有リンクがまだ作成されていない場合は、nullになります。

表示子属性

shared_link.url

string<url>

required

Box上の項目にアクセスするために使用できるURL。

このURLに移動すると、BoxのプレビューUIに項目が表示され、許可されている場合は、このUIからファイルをダウンロードできます。

このURLは、この共有リンクに対してカスタムのvanity_urlが設定されている場合でも動作します。

Example:

"https://www.box.com/s/vspke7y05sb214wjokpk"

shared_link.effective_access

enum<string>

required

共有リンクの実際のアクセスレベル。許可されるアクセスレベルが会社の設定で制限されている場合は、accessフィールドの値よりも低いアクセスレベルになることがあります。

利用可能なオプション:

open,

company,

collaborators

Example:

"company"

shared_link.effective_permission

enum<string>

required

この共有リンクの実際の権限。これらにより、共有リンクの権限と、管理者、所有者、任意の先祖項目 (フォルダなど) によって設定される項目の権限の組み合わせの制限が厳しくなります。

利用可能なオプション:

can_edit,

can_download,

can_preview,

no_access

Example:

"can_download"

shared_link.is_password_enabled

boolean

required

共有リンクを通じて項目にアクセスする際にパスワードを要求するかどうかを定義します。

Example:

true

shared_link.download_count

integer

required

この項目がダウンロードされた回数。

Example:

3

shared_link.preview_count

integer

required

この項目がプレビューされた回数。

Example:

3

shared_link.download_url

string<url> | null

ファイルをダウンロードするために使用できるURL。このURLをブラウザで使用すると、ファイルをダウンロードできます。このURLには、ファイルを正しいファイルタイプで保存できるように、ファイル拡張子が含まれます。

フォルダの場合、このプロパティはnullになります。

Example:

"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg"

shared_link.vanity_url

string<url> | null

Boxで項目をプレビューする目的にも使用できる「カスタムURL」。カスタムURLの作成と変更は、Boxウェブアプリケーションでのみ行えます。

Example:

"https://acme.app.box.com/v/my_url/"

shared_link.vanity_name

string | null

vanity_urlフィールドで使用される、共有リンクのカスタム名。

Example:

"my_url"

shared_link.access

enum<string>

この共有リンクのアクセスレベル

open - このリンクを知っている全員にこの項目へのアクセスを許可します
company - 同じ会社のユーザーにのみこの項目へのアクセスを許可します
collaborators - この項目のコラボレータとなっているユーザーに対してのみこの項目へのアクセスを許可します

共有リンクの作成時にこのフィールドを省略した場合は、Enterprise管理者によって指定されたデフォルトのアクセスレベルに設定されます。

利用可能なオプション:

open,

company,

collaborators

Example:

"open"

shared_link.unshared_at

string<date-time> | null

このリンクが共有解除される日時。このフィールドを設定できるのは、有料アカウントを持つユーザーのみです。

Example:

"2018-04-13T13:53:23-07:00"

shared_link.permissions

object

このリンクを通じてユーザーが項目のプレビュー、編集、およびダウンロードを行うことを許可するかどうかを定義します。これらの権限は、共有リンクのみに適用され、その項目自体に適用される権限より優先されることはありません。

表示子属性

shared_link.permissions.can_download

boolean

required

共有リンクを通じて項目をダウンロードすることを許可するかどうかを定義します。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

実際のアクセスレベルがcollaboratorsではなく、openまたはcompanyに設定されている場合は、この値をtrueに設定できます。

Example:

true

shared_link.permissions.can_preview

boolean

required

共有リンクを通じて項目をプレビューすることを許可するかどうかを定義します。

この値は常にtrueです。フォルダの共有リンクの場合、この設定はフォルダ内のすべての項目にも適用されます。

Example:

true

shared_link.permissions.can_edit

boolean

required

共有リンクからの項目の編集を許可するかどうかを定義します。

can_downloadがtrueで、項目のタイプがfileの場合のみ、この値もtrueに設定できます。

Example:

false

item_status

enum<string>

この項目が削除されたかどうか。値には、active、trashed (ファイルがごみ箱に移動された場合)、deleted (ファイルが完全に削除された場合) があります。

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"