共有リンクをファイルに追加

プロジェクトの対応 OS

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

概要

説明	API メソッド	API パス
Box のファイルの共有リンクを作成します。	PUT	/files/{file_id}/add_shared_link

入力

パラメーター	説明	データ型
ファイル	共有リンクが作成されるファイル オブジェクトです。	データリスト
アクセス	共有リンクにアクセスできるユーザーを定義します。サポートされている値: 開く – リンクを知っているすべてのユーザー 会社 – 組織内のユーザーのみ 共同作業者 – ファイルまたはその親フォルダーの共同作業者であるユーザーのみ	オプション
パスワード	共有リンクにアクセスするために必要な任意のパスワード。既存のパスワードを削除するには、null に設定します。パスワードは長さが 8 文字以上で、数字、大文字、または記号を含める必要があります。パスワード保護は、アクセス=オープンの場合にのみ許可されます。	string
ダウンロードする	ユーザーが共有リンクを介してファイルをダウンロードできるかどうかを指定します。これは、access = open または company の場合にのみ有効にできます。	Boolean
プレビュー	ユーザーが共有リンクを使用してファイルをプレビューできるかどうかを指定します。この値は常に true です。フォルダーの共有リンクの場合、これはフォルダー内のすべてのアイテムに適用されます。	Boolean
時刻の共有を解除する	共有リンクが自動的に期限切れになるタイミングを指定するオプションのタイムスタンプ。	datetime
共有リンクのバニティ名	共有リンクの vanity_url で使用される、人間にわかりやすいカスタムの識別子。	string

出力

パラメーター	説明	データ型
共有リンクをファイルに追加します。	ファイルに対して作成または更新された共有リンク オブジェクトです。	オプション
ID	ファイルの一意の識別子です。	string
パス コレクション エントリ ID	ファイルのフォルダー パス階層における各コンポーネントの ID です。	string
作成者 ID	ファイルを最初に作成したユーザーの ID。	string
親 ID	ファイルを含む親フォルダーの ID です。	string
所有元 ID	ファイルを所有するユーザーの ID。	string
IDによる変更	ファイルを最後に変更したユーザーの ID。	string
ファイル バージョン ID	ファイルのバージョン ID です	string

注:

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