フォルダに共有リンクを追加

このリソースは、バージョン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

folder_id

string

required

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

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

Boxアカウントのルートフォルダは常にID 0で表されます。

Query Parameters

fields

string

required

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

Body

application/json

shared_link

object

フォルダに作成する共有リンクの設定。

共有リンクにデフォルト設定を使用するには、空のオブジェクト ({}) を使用します。

表示子属性

Response

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

任意のフォルダAPIエンドポイントからデフォルトで返される可能性があるフォルダのFull版の表示。任意のフォルダAPIエンドポイントからデフォルトで返されるフォルダのStandard版の表示。他のリソースの下にネストされたときに使用されるファイルバージョンのMini版の表示。最も基本的なフォルダのBase版の表示。fieldsクエリパラメータを使用すると、最小限の数のフィールドが返されます。

string

required

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

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

Example:

"12345"

type

enum<string>

required

値は常にfolderになります。

利用可能なオプション:

folder

Example:

"folder"

etag

string | null

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

Example:

"1"

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:

"Contracts"

created_at

string<date-time> | null

このフォルダが作成された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。

Example:

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

modified_at

string<date-time> | null

このフォルダが最後に更新された日時。ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになる場合があります。

Example:

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

description

string

このフォルダの説明 (省略可)。

Maximum string length: 256

Example:

"Legal contracts for the new ACME deal"

size

integer<int64>

フォルダサイズ (バイト単位)。

この整数を解析する際には、値が非常に大きくなることがあるため注意が必要です。

Example:

629644

path_collection

パスのコレクション · object

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

表示子属性

created_by

ユーザー (Mini) · object

このフォルダを作成したユーザー。

表示子属性

modified_by

ユーザー (Mini) · object

このフォルダを最後に変更したユーザー。

表示子属性

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"

content_created_at

string<date-time> | null

このフォルダが最初に作成された日時。

Example:

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

content_modified_at

string<date-time> | null

このフォルダが最後に更新された日時。

Example:

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

owned_by

ユーザー (Mini) · object

このフォルダを所有するユーザー。

表示子属性

shared_link

共有リンク · object

このフォルダの共有リンク。このフォルダに対してまだ共有リンクが作成されていない場合は、nullになります。

表示子属性

folder_upload_email

object

以下のオプションのいずれかがtrueの場合、folder_upload_emailパラメータはnullではありません。

[このフォルダへのメールによるアップロードを許可する] および [このフォルダのコラボレータにのみメールによるアップロードを許可する] が管理コンソールで1フォルダに対して有効になっていて、ユーザーには少なくともアップロード権限が付与されています。
[このフォルダへのメールによるアップロードを許可する] の設定が管理コンソールで1フォルダに対して有効になっていて、[このフォルダのコラボレータにのみメールによるアップロードを許可する] の設定が無効 (オフ) になっています。

条件が満たされていない場合、パラメータには次の値が設定されます: folder_upload_email: null。

表示子属性

parent

フォルダ (Mini) · object

このフォルダが配置されているフォルダ (省略可)

ルートフォルダやごみ箱フォルダなど、一部のフォルダの場合、この値はnullになることがあります。

表示子属性

item_status

enum<string>

この項目が削除されたかどうかを定義します。

active - 項目がごみ箱に移動されていない場合。
trashed - 項目がごみ箱に移動されているが、まだ削除されていない場合。
deleted - 項目がすでに完全に削除されている場合。

利用可能なオプション:

active,

trashed,

deleted

Example:

"active"

item_collection

Items · object

フォルダ内の項目のページ。

このフィールドをリクエストできるのは、フォルダの情報をクエリで照会するときのみで、フォルダの項目をクエリで照会するときにはリクエストできません。

表示子属性

sync_state

enum<string>

フォルダをユーザーのデバイスに同期する必要があるかどうかを指定します。これはBox Sync (廃止済み) で使用され、Box Driveでは使用されません。

利用可能なオプション:

synced,

not_synced,

partially_synced

Example:

"synced"

has_collaborations

boolean

このフォルダに他のコラボレータが存在するかどうかを指定します。

Example:

true

permissions

object

このフォルダに対して現在のユーザーが持っている権限について説明します。

表示子属性

tags

string[]

この項目のタグ。これらのタグはBoxウェブアプリおよびモバイルアプリで項目の横に表示されます。

タグを追加または削除するには、項目の現在のタグを取得して変更してから、このフィールドを更新します。

タグの数は、1項目あたり100個までに制限され、一意のタグは会社あたり10,000個までに制限されます。

Required array length: 1 - 100 elements

Example:

["approved"]

can_non_owners_invite

boolean

フォルダの所有者ではないユーザーがそのフォルダに新しいコラボレータを招待できるかどうかを指定します。

Example:

true

is_externally_owned

boolean

このフォルダが認証済みの会社以外のユーザーによって所有されているかどうかを指定します。

Example:

true

metadata

項目メタデータインスタンス · object

このフォルダに追加されたメタデータインスタンスを含むオブジェクト。

各メタデータインスタンスは、そのscopeとtemplateKeyによって一意に識別されます。各フォルダに追加されるメタデータテンプレートのインスタンスは1つだけです。各メタデータインスタンスは、キーとしてtemplateKeyが指定されているオブジェクト内にネストされ、さらにそのオブジェクト自体もキーとしてscopeが指定されているオブジェクト内にネストされます。

表示子属性

Example:

{
  "enterprise_27335": {
    "marketingCollateral": {
      "$canEdit": true,
      "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
      "$parent": "folder_59449484661",
      "$scope": "enterprise_27335",
      "$template": "marketingCollateral",
      "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
      "$typeVersion": 2,
      "$version": 1
    }
  }
}

is_collaboration_restricted_to_enterprise

boolean

このフォルダへの招待を社内のユーザーのみに限定するかどうかを指定します。既存のコラボレーションには影響しません。

Example:

true

allowed_shared_link_access_levels

enum<string>[]

このフォルダで使用できるアクセスレベルのリスト。

ルートフォルダなどの一部のフォルダでは共有が許可されていないため、このリストは常に空になります。

利用可能なオプション:

open,

company,

collaborators

Example:

["open"]

allowed_invitee_roles

enum<string>[]

このフォルダを共有するときに招待できるユーザーの役割タイプのリスト。

利用可能なオプション:

editor,

viewer,

previewer,

uploader,

previewer uploader,

viewer uploader,

co-owner

Example:

["editor"]

watermark_info

object

このフォルダに適用された電子すかしに関する詳細。

表示子属性

is_accessible_via_shared_link

boolean

直接共有リンクまたは親フォルダへの共有リンクを使用してフォルダにアクセスできるかどうかを指定します。

Example:

true

can_non_owners_view_collaborators

boolean

このフォルダの所有者ではないコラボレータがこのフォルダの他のコラボレータを表示できないように制限するかどうかを指定します。

この制限を有効にした場合は、所有者ではないユーザーが新しいコラボレータを招待することも制限されます。

Example:

true

classification

object

このフォルダに適用された分類に関する詳細。

表示子属性

is_associated_with_app_item

boolean

フォルダまたはフォルダの先祖が1つ以上のアプリ項目に関連付けられている場合、このフィールドはtrueを返します。コンテキストユーザーがそのフォルダに関連付けられたアプリ項目にアクセスできない場合でもtrueが返されることに注意してください。

Example:

true