DownloadDocument
オフラインアクセスや外部利用のためにSalesforce からドキュメントをダウンロードします。
ストアドプロシージャ固有の情報
このストアドプロシージャは、Salesforce からドキュメントをダウンロードします(ContentDocument/Salesforce Files ではなく、Documents オブジェクトから)。以下の例では、出力カラムには次のものが含まれます。
- Success - ダウンロードが成功したかどうか
- FileId - ダウンロードしたドキュメントの ID
- FileData - ファイルの内容(デフォルトでは Base64 エンコード)
- FileName - ファイルの名前(ディスクに保存する場合)
- FullPath - ファイルが保存された完全なパス(ディスクに保存する場合)
ドキュメント ID でダウンロード
ドキュメントを ID でダウンロードするには:
EXEC DownloadDocument Id = '0151W000002kJtPQAU'
特定のファイルパスにダウンロード
ドキュメントをダウンロードして特定の場所に保存するには:
EXEC DownloadDocument Id = '0151W000002kJtPQAU', FullPath = 'C:\\Downloads\\mydocument.pdf'
Base64 データとしてダウンロード
デフォルトでは、ファイルの内容は FileData 出力カラムに Base64 エンコードされたデータとして返されます。生の(エンコードされていない)内容を取得するには、Encoding パラメータを設定します:
EXEC DownloadDocument Id = '0151W000002kJtPQAU', Encoding = 'NONE'
Input
| Name | Type | Description |
| Id | String | ダウンロードする特定のドキュメントのSalesforce ID。Name またはFolderId が指定されていない場合は必須です。いずれも指定されていない場合、すべてのドキュメントがダウンロードされます。 |
| Name | String | ダウンロードするドキュメントの名前。Id またはFolderId の代替として使用できます。いずれも指定されていない場合、すべてのドキュメントがダウンロードされます。 |
| Folderid | String | ダウンロードするドキュメントを含むフォルダのSalesforce ID。特定のフォルダ内のすべてのドキュメントをダウンロードする場合に便利です。 |
| LocalPath | String | ダウンロードしたファイルが保存されるローカルファイルシステム上のパス。省略した場合、ファイルはFileData 出力を介してインメモリで返されます。 |
| Encoding | String | FileData を介してファイルデータを返す際に使用されるテキストエンコーディング形式。ファイルがディスクに書き込まれる場合は無視されます。
The allowed values are NONE, BASE64. The default value is BASE64. |
Result Set Columns
| Name | Type | Description |
| FileId | String | ダウンロードしたドキュメントのSalesforce ID。 |
| Success | String | 特定のドキュメントのダウンロード操作が成功したかどうかを示します(true またはfalse)。 |
| FileName | String | Salesforce からダウンロードされたファイルの名前。 |
| FullPath | String | ドキュメントが保存されたファイル名を含む完全なローカルファイルパス。 |
| FileData | String | ダウンロードしたファイルのBase64 エンコードされたコンテンツ。LocalPath が設定されずデータがインメモリで保持されている場合のみ返されます。 |
| FailureMessage | String | 複数のドキュメントをダウンロードする場合、ダウンロードに失敗したドキュメントのエラーメッセージが含まれます。 |