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

プロジェクトの対応 OS

Windows | クロスプラットフォーム

概要

説明	API メソッド	API パス
Box のフォルダーの共有リンクを作成します。	PUT	/フォルダー/{folder_id}/add_shared_link

入力

パラメーター	説明	データ型
フォルダー	共有リンクが作成されるフォルダー オブジェクトです。	データリスト
アクセス	共有リンクにアクセスできるユーザーを定義します。サポートされている値: 開く – リンクを知っているすべてのユーザー 会社 – 組織内のユーザーのみ 共同作業者 – フォルダーの共同作業者のみ	オプション
パスワード	共有リンクにアクセスするために必要な任意のパスワード。削除するには、null に設定します。パスワードは長さが 8 文字以上で、数字、大文字、または記号を含める必要があります。パスワードは、アクセス=オープンの場合にのみ設定できます。	string
ダウンロードする	ユーザーが共有リンクからアイテムをダウンロードできるかどうかを示します。これは、access = open または company の場合にのみ有効にできます。	Boolean
プレビュー	ユーザーが共有リンクを使用してフォルダー内のアイテムをプレビューできるかどうかを示します。これは常に True であり、フォルダー内のすべてのアイテムに適用されます。	Boolean
時刻の共有を解除する	共有リンクが自動的に期限切れになるタイミングを指定するオプションのタイムスタンプ。	datetime
編集	共有リンクを使用してフォルダー内のアイテムを編集できるかどうかを指定します。種類がフォルダーのアイテムに対してのみ False に設定できます。	Boolean
バニティ名	vanity_urlの生成に使用される、人間が使いやすいカスタムの文字列です。カスタムバニティURLは、標準の共有リンクよりも推測しやすいため、機密性の高いコンテンツには使用しないでください。	string

出力

パラメーター	説明	データ型
共有リンクをフォルダーに追加します。	フォルダーに対して作成または更新された共有リンク オブジェクトです。	object
ID	フォルダーの一意の識別子です。	string
パス コレクション エントリ ID	このフォルダーに至るまでのパス階層内の各フォルダーの ID です。	string
作成者 ID	フォルダーを最初に作成したユーザーの ID。	string
アイテム コレクション エントリ ファイル バージョン ID	アイテム コレクションで返されるアイテムに関連付けられているファイル バージョンの ID です。	string
アイテム コレクション エントリ ID	フォルダーのアイテム コレクションで返される各アイテムの ID です。	string
親 ID	親フォルダーの ID です。	string
所有元 ID	フォルダーを所有するユーザーの ID です。	string
IDによる変更	フォルダーを最後に変更したユーザーの ID。	string

注:

• API ワークフローでは、単一の応答オブジェクトが出力として返されます。必須フィールドは、このオブジェクトから直接抽出できます。
• RPA ワークフローでは、一部の出力パラメーターが異なる場合がありますが、明示的に公開されていない場合でも、必要な値を応答オブジェクトから取得できます。