FindSingleBusinessObjectByField Web メソッドの使用
指定されたフィールドまたは値に基づいて単一のビジネス オブジェクトを返します。 これは、一意のフィールドで一致するレコードを検索するために導入された便利な Web メソッドです。
この Web メソッドが役立つ一般的な使用例をいくつか示します。
- ログイン ID フィールドで特定の従業員レコードを検索します。
- PrimaryEmail フィールドで特定の従業員レコードを検索しています。
- チーム フィールドで特定の標準ユーザー チーム レコードを検索します。
- 名前 フィールドで特定の組織単位レコードを検索します。
リクエスト構文
FRSHEATIntegrationFindBOResponse FindSingleBusinessObjectByField(string sessionKey, string tenantId, string boType, string fieldName, string fieldValue)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- boType: 取得するビジネス オブジェクトのタイプ。
- recId: ビジネス オブジェクトの一意の識別子。
- fieldName: 検索対象となるビジネス オブジェクト内のフィールドの名前 (例: status)。
- fieldValue: 一致するレコードで検索するフィールドの値 (例: active)。
戻り値
FRSHEATIntegrationFindBOResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationFindBOResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
public WebServiceBusinessObject obj { get; set; }
}FRSHEATIntegrationFindBOResponse クラスには次のフィールドがあります。
- ステータス: 操作が成功したかどうかを示すステータス値を提供します。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason: Connect Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- obj: FindBusinessObject Web メソッドを介して正確なレコードが見つかった場合 (つまり、ステータス フィールドの値が successの場合)、ビジネス オブジェクトにアクセスできるフィールド。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に見つかりました。 obj フィールドからビジネス オブジェクトにアクセスします。 |
エラー | ビジネス オブジェクトが見つかりません。 obj フィールドが null です。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 典型的なエラーの 1 つは、「 テーブルが見つかりません」です。これは、指定されたビジネス オブジェクトがテナント内に存在しない場合に発生します。 ビジネス オブジェクトの名前が正しく入力されていることを確認します。 もう 1 つの一般的なエラーは、指定されたフィールドがビジネス オブジェクトに存在しないことです。 エラーメッセージは次のとおりです: ObjectTableMap: フィールド <FieldName> がテーブル <Business Object>に見つかりません フィールド名が正しく入力されていること、および指定されたビジネス オブジェクトに対して定義されていることを確認します。 |
見つかりません | 指定されたビジネス オブジェクトはテナント内に存在しますが、指定された RecID はオブジェクト内の既存のレコードのいずれとも一致しません。 これは例外的な条件ではないため、 exceptionReason フィールドには例外は保存されませんが、 obj フィールドは null になります。 目的のレコードの RecID がテナント内に存在することを確認します。 FindSingleBusinessObjectByFieldなどの別の Web メソッドの使用を検討してください。 |
複数の結果 | 指定された検索条件により、一致する結果が複数返されました。 この Web メソッドの目的は、一致するビジネス オブジェクトを 1 つ返すことなので、 obj フィールドは null です。 代わりに FindSingleBusinessObjectByField Web メソッドの使用を検討してください。 |
例
FRSHEATIntegrationFindBOResponse res = frSvc.FindSingleBusinessObjectByField(authSessionKey, tenantId, "Incident", "IncidentNumber", "10001");
if (res.status == "Success")
{
foreach (WebServiceFieldValue f in res.obj.FieldValues)
{
if (string.Compare(f.Name, "LastModDateTime", true) == 0)
{
日付時刻 lastMod;
if (f.Value != null)
{
lastMod = (DateTime)f.Value;
Console.WriteLine("The LastModDateTime of the record is " + lastMod.ToString());
}
}
}
}