FindMultipleBusinessObjectsByField Web メソッドの使用
指定されたフィールドまたは値に基づいて 1 つ以上のビジネス オブジェクトを返し、その結果をビジネス オブジェクトの配列として返します。 たとえば、この Web メソッドを使用すると、ステータスがアクティブなすべてのインシデント レコード、タイプがメジャーのすべての変更などを取得できます。
この Web メソッドは、単一のフィールドまたは値の条件に基づいてのみ検索します。 より複雑なクエリが必要な場合は、 検索 Web メソッドを使用します。 この Web メソッドは、一致するレコードが 1 つしかない場合でも、常に結果を配列で返します。 返されるレコードが 1 つだけであることがわかっている場合は、代わりに FindSingleBusinessObjectByField Web メソッドを使用します。
リクエスト構文
FRSHEATIntegrationSearchResponse FindMultipleBusinessObjectsByField(string sessionKey, string tenantId, string boType, string fieldName, string fieldValue)パラメータ
- sessionKey: Connect Web メソッドからのセッション キー。
- tenantId: セッション キーが認証されるテナント。
- boType: 取得するビジネス オブジェクトのタイプ。
- recId: ビジネス オブジェクトの一意の識別子。
- fieldName: 検索対象となるビジネス オブジェクト内のフィールドの名前。
- fieldValue: 一致するレコードで検索するフィールドの値。
戻り値
FRSHEATIntegrationSearchResponse オブジェクトは次のように定義されます。
パブリッククラス FRSHEATIntegrationSearchResponse
{
パブリック文字列ステータス { 取得; 設定; }
パブリック文字列例外理由 { 取得; 設定; }
パブリック リスト<List<WebServiceBusinessObject>> objList { get; set; }
}FRSHEATIntegrationSearchResponse クラスには次のフィールドがあります。
- ステータス: 操作が成功したかどうかを示すステータス値を提供します。 使用可能なステータス値の詳細な説明は、以下の表に記載されています。
- exceptionReason: Connect Web メソッドの実行時にアプリケーションが例外をスローした場合の例外情報が含まれます。
- objList: ステータス フィールドの値が成功の場合、見つかった結果のリストが含まれます。 検索条件が複数のビジネス オブジェクトに一致した場合、外部リストには複数のビジネス オブジェクトが含まれます。 検索条件が結合を要求した場合、内部リストには結合されたビジネス オブジェクトが含まれます。 Microsoft SQL とは異なり、結合された各オブジェクトからの応答フィールドは個別のリストに保持され、混ざり合うことはありません。
次の表に、使用可能なステータス値とその解釈方法を示します。
状態 | 説明 |
|---|---|
成功 | ビジネス オブジェクトが正常に見つかりました。 objList フィールドからビジネス オブジェクト リストにアクセスします。結果は WebServiceBusinessObjectsのリストとして返されます。 |
エラー | ビジネス オブジェクトが見つかりません。 objList フィールドが null です。 対応する exceptionReason フィールドを調べて、Web メソッドが失敗した理由を特定します。 典型的なエラーの 1 つは、「 テーブルが見つかりません」です。これは、指定されたビジネス オブジェクトがテナント内に存在しない場合に発生します。 ビジネス オブジェクトの名前が正しく入力されていることを確認します。 もう 1 つの一般的なエラーは、指定されたフィールドがビジネス オブジェクトに存在しないことです。 エラーメッセージは次のとおりです: ObjectTableMap: フィールド <FieldName> がテーブル <Business Object>に見つかりません フィールド名が正しく入力されていること、および指定されたビジネス オブジェクトに対して定義されていることを確認します。 |
見つかりません | 指定されたビジネス オブジェクトはテナント内に存在しますが、指定された RecID はオブジェクト内の既存のレコードのいずれとも一致しません。 これは例外的な条件ではないため、 exceptionReason フィールドには例外は保存されませんが、 objList フィールドは null になります。 目的のレコードの RecID がテナント内に存在することを確認します。 |
例
FRSHEATIntegrationSearchResponse res = frSvc.FindMultipleBusinessObjectsByField(authSessionKey, tenantId, "Incident", "Status", "Active");
if (res.status == "Success")
{
WebServiceBusinessObject[][] incidentList = res.objList;
foreach (WebServiceBusinessObject[]incidentOuterList inincidentList)
{
foreach (incidentOuterList 内の WebServiceBusinessObject インシデント)
{
WebServiceFieldValue[] incidentFieldList = incident.FieldValues;
WebServiceFieldValue incidentNumberField = incidentFieldList.SingleOrDefault(f => f.Name == "IncidentNumber");
Console.WriteLine("インシデント {0} は選択基準に一致します",incidentNumberField.Value);
}
}
}