レコードの検索
サービス マネージャ統合 Web サービスには、テナント内のレコードを検索するためのいくつかのオプションが用意されています。 次の表は、レコードの検索を可能にする 4 つの Web メソッドをまとめたものです。
ウェブメソッド | 適用範囲 |
|---|---|
検索 | 任意のクエリ基準を使用してレコードを検索するための汎用 Web メソッド。 以下の 4 つの Web メソッドを使用して目的のクエリ条件を表現できない場合は、この Web メソッドを使用します。 |
ページネーション検索 | 任意のクエリ基準を使用して制限された数のレコードを検索するための汎用 Web メソッド。 以下の 3 つの Web メソッドを使用して目的のクエリ条件を表現できない場合は、この Web メソッドを使用します。 |
ビジネスオブジェクトの検索 | データベース内の RecID フィールド値でビジネス オブジェクト レコードを検索します。 レコードは RecID (主キー) によって一意に識別されるため、指定された RecID がビジネス オブジェクト内の既存のレコードの 1 つと一致すると仮定して、この Web メソッドは 1 つのレコードだけを返します。 検索するレコードの RecID が利用できない場合は、別の Web メソッドを使用します。 |
フィールドによる単一ビジネスオブジェクトの検索 | 指定されたフィールドまたは値の条件でビジネス オブジェクト レコードを検索し、見つかった場合は完全に一致するレコードを返します。 たとえば、この Web メソッドを使用して、 LoginId または PrimaryEmail フィールド (列のフィールド値がデータベース テーブル内で一意である場合) のいずれかで従業員レコードを識別します。 この Web メソッドは、一致するレコードが見つかった場合に、正確に 1 つのレコードを返します。 検索で複数のレコードが返される場合、結果は返されません。 複数の結果が返されるかどうか不明な場合は、 FindMultipleBusinessObjectsByField または FindBusinessObject Web メソッドのいずれかを使用します。 |
フィールド別に複数のビジネスオブジェクトを検索 | 指定されたフィールドまたは値の条件でビジネス オブジェクト レコードを検索し、すべての結果を配列で返します。 たとえば、この Web メソッドを使用して、ステータスが 解決済みのすべてのインシデント レコードを識別します。 この Web メソッドは、1 つ以上の一致する結果を配列で返します。 検索条件によって 1 つのレコードが返されることがわかっている場合は、 FindSingleBusinessObjectByField Web メソッドを使用すると、レコードに直接アクセスするより便利な方法が提供されます。 (この Web メソッドを使用して、配列の最初の項目からレコードを取得することもできます。) |
FindBusinessObject、 FindSingleBusinessObjectByField、および FindMultipleBusinessObjectsByField Web メソッドはすべて、 Search Web メソッドの特殊なケースです。 後者の Web メソッドは、任意の複雑なクエリを表現するために使用できます。
このトピックには次のサブトピックが含まれています。
