AddAttachment Web メソッドの使用
指定されたビジネス オブジェクト レコードに添付ファイルを追加します。
リクエスト構文
リクエストを準備する際には、次の構文を使用します。
FRSHEAT統合添付ファイル応答の追加
AddAttachment(文字列セッションキー、文字列テナントID、オブジェクトアタッチメントコマンドデータコマンドデータ)パラメータ
リクエストに次のパラメータを指定します。
sessionKey: Connect Web メソッドからのセッション キー。
tenantId: セッション キーが認証されるテナント。
commandData: 作成要求に関する情報を含む構造体。
パブリッククラス ObjectAttachmentCommandData
{
パブリック文字列 ObjectId;
パブリック文字列 ObjectType;
パブリック文字列ファイル名;
パブリックByte[]ファイルデータ;
パブリック ブール値 ForceSaveInDatabase;
}ObjectAttachmentCommandDataに次の属性を含めます:
- ObjectId: 新しい添付ファイルの RecID。
- ObjectType: この添付ファイルが添付されるメインビジネス オブジェクトのタイプ (オブジェクト参照表記法)。
- fileName: ファイルの名前。
- fileData: 実際のファイルバイト数。
- ForceSaveInDatabase: クライアントの構成に関係なく、添付ファイルをデータベースに保存します。 この属性はデフォルトでは false です。
戻り値
FRSHEATIntegrationAddAttachmentResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationAddAttachmentResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
}FRSHEATIntegrationAddAttachmentResponse クラスには次のフィールドがあります。
- ステータス: 接続の状態に関するステータスを提供します。 以下の表には、使用可能なステータス値の詳細な説明が記載されています。
- exceptionReason: この Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクト レコードに添付ファイルが正常に追加されました。 |
エラー | ビジネス オブジェクト レコードに添付ファイルを追加できません。 例外情報は exceptionReason フィールドに保存されます。 よくあるエラーは次のとおりです。 アップロードされたファイルは制限されたファイル拡張子です。 アップロードに許可されているファイル拡張子のリストについては、システム管理者にお問い合わせください。 添付ファイルのファイル拡張子は、指定されたテナントでは許可されていません。 添付ファイルのアップロードに失敗しました。 アプリケーションはビジネス オブジェクト レコードを見つけることができません。 ビジネスオブジェクトの定義 <Business Object> 指定されたビジネス オブジェクトはテナントに存在しません。 |
例
次の例では、ユーザーのローカル ファイル アプリケーションからサンプル イメージを読み取り、指定されたインシデント レコードにファイルを添付します。
定数文字列ファイル名 = "C:\\\\Temp\\\\sample.jpg";
(FileStream fs = new FileStream(fileName, FileMode.Open, FileAccess.Read) を使用します)
{
(BinaryReader r = new BinaryReader(fs)) を使用します
{
byte[] AttachmentData = 新しいbyte[fs.Length];
(int i = 0; i < fs.Length; i ) の場合
{
AttachmentData[i] = r.ReadByte();
}
ObjectAttachmentCommandData data = new ObjectAttachmentCommandData()
{
ObjectId = "9981FBEBAA8B4EE2820364505855ABC2",
オブジェクトタイプ = "インシデント
ファイル名 = "sample.png",
ファイルデータ = 添付ファイルデータ
};
FRSHEATIntegrationAddAttachmentResponse response = frSvc.AddAttachment(authSessionKey, tenantId, data);
if (response.status != "Success")
{
Console.WriteLine("レコードに添付ファイルを追加中に次のエラーが発生しました: " response.exceptionReason);
}
}
}