ReadAttachment Web メソッドの使用
6 min
RecID 値を指定して、特定の添付ファイル レコードのデータを読み取ります。
リクエスト構文
FRSHEATIntegrationReadAttachmentResponse ReadAttachment(string sessionKey, string tenantId, ObjectAttachmentCommandData commandData)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- commandData: 添付ファイルに関する情報を含む構造体。
パブリッククラス ObjectAttachmentCommandData
{
パブリック文字列 ObjectId;
}- ObjectId: 新しい添付ファイルの RecID。
戻り値
FRSHEATIntegrationReadAttachmentResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationReadAttachmentResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック byte[] attachmentData { 取得; 設定; }
}FRSHEATIntegrationReadAttachmentResponse クラスには次のフィールドがあります。
- ステータス: 接続の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- attachmentData: 指定された添付ファイルの内容を含むバイト配列。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | テナントから添付ファイルを正常に取得しました。 添付ファイルは、 attachmentData フィールドで使用できます。 |
見つかりません | テナントには指定された名前の添付ファイルが含まれていません。 添付ファイルの名前が正しく入力されていること、および添付ファイルが存在することを確認してください。 |
エラー | この Web メソッドの実行中にエラーが発生しました。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 |
例
byte[] 添付ファイルデータ;
定数文字列ファイル名 = "C:\\\\Temp\\\\test.png";
ObjectAttachmentCommandData data = new ObjectAttachmentCommandData()
{
ObjectId = "94069732037142E7BF3D81DB02128289", // RecId of the Attachment record
};
FRSHEATIntegrationReadAttachmentResponse response = frSvc.ReadAttachment(authSessionKey, tenantId, data);
if (response.status == "Success")
{
添付ファイルデータ = response.attachmentData;
if (AttachmentData != null)
{
(FileStream fs = new FileStream(fileName, FileMode.Create) を使用します)
{
(BinaryWriter w = new BinaryWriter(fs)) を使用します
{
(int i = 0; i < AttachmentData.Length; i ) の場合
{
w.Write(AttachmentData[i]);
}
}
}
}
}
そうでない場合 (response.status == "NotFound")
{
Console.WriteLine("指定された RecId の添付ファイル レコードがテナント内に見つかりません");
}
それ以外
{
Console.WriteLine("レコードから添付ファイルを読み取っているときに次のエラーが発生しました: " response.exceptionReason);
}許可されるメッセージのサイズを増やす
Microsoft .NET ベースの Web サービス クライアントの場合、Web サービス経由で大きな添付ファイルを取得するときに、アプリケーションで次のエラーが発生する可能性があります。
通信例外が発生しました: 受信メッセージの最大メッセージ サイズ クォータ (65536) を超えました。クォータを増やすには、App.config ファイルで MaxReceivedMessageSize 属性と MaxBufferSize 属性を構成して、Web サービスを使用する Microsoft .NET クライアント アプリケーションの大きな添付ファイル サイズに対応できるようにします。 次の例を参照してください。
<binding name="IPCMServiceSoap" closeTimeout="00:01:00" openTimeout="00:01:00" receiveTimeout="00:10:00" sendTimeout="00:01:00" allowCookies="false" bypassProxyOnLocal="false" hostNameComparisonMode="StrongWildcard" maxBufferSize="65536" maxBufferPoolSize="524288" maxReceivedMessageSize="65536" messageEncoding="Text" textEncoding="utf-8" transferMode="Buffered" useDefaultWebProxy="true">
...
</binding>上記のサイズ値はバイト単位で表されます。
