DownloadAttachment
Salesforce の特定のエンティティに関連付けられた添付ファイルをダウンロードします。
Input
Name | Type | Accepts Output Streams | Description |
ObjectId | String | False | 添付ファイルをダウンロードするオブジェクトのID。 |
Id | String | False | ダウンロードする添付ファイルのID。名前もID も指定しない場合は、すべての添付ファイルがダウンロードされます。 |
Name | String | False | ダウンロードする添付ファイルの名前。名前もID も指定しない場合は、すべての添付ファイルがダウンロードされます。 |
LocalPath | String | False | ファイルの保存先のローカルパス。パスが指定されない場合は、ファイルはFileData 出力のメモリ内に保持されます。 |
LightningMode | String | False | デフォルトはfalse です。'True' に設定すると、'Salesforce Files' のリストからファイルがダウンロードされます。UploadAttachment を'LightningMode' をtrue に設定して使用した場合、このストアドプロシージャを使用するときにもこれをtrue に設定して、アップロードされたファイルをダウンロードする必要があります。また、これをtrue に設定すると、名前による添付ファイルのダウンロードはサポートされません。ファイルのId またはObjectId を指定する必要があります。 |
Encoding | String | False | FileData に出力されるデータのエンコード。
The allowed values are NONE, BASE64. The default value is BASE64. |
FileStream | String | True | ファイルデータが書き込まれる出力ストリームのインスタンス。LocalPath が設定されていない場合のみ使用されます。 |
Result Set Columns
Name | Type | Description |
FileId | String | ファイルのId。 |
Success | String | 特定のファイルのダウンロードのステータス。 |
FileName | String | ダウンロードされたファイルの名前。 |
FullPath | String | ダウンロードされたファイルの完全パス(名前を含む)。 |
FileData | String | LocalPath への入力が空の場合に出力されるファイルのデータ。 |
FailureMessage | String | マルチファイルのダウンロードモードで、ダウンロードに失敗した場合の失敗メッセージを表示。 |