共通の REST API エレメント

コネクターおよび演算子を使用すると、一致する条件および値に基づいてフィルタリングを行う照会セグメントを作成できます。

コネクター

表 1. コネクター
コネクター 「説明」
and and 連結子を使用して、すべての節を追加します。
or or 連結子を使用して、すべての節を追加します。

パラメーター

表 2. パラメーター
パラメーター 「説明」
countSwitch 照会が要求されたデータ、取得した行数、またはその両方を返すかどうかを指定します。演算子は、以下の値を持つことができます。
  • 1 - 要求されたデータのみが返される
  • 2 - 行数のみが返される
  • 値なしまたはその他の値 - 要求されたデータと行数の両方が返される

演算子

表 3. 演算子
演算子 「説明」 適用可能先
= 等しい。
!= 等しくない。
< より小さい。 数値フィールドおよび日付フィールドのみ。
<= より小さいか等しい。 数値フィールドおよび日付フィールドのみ。
> より大きい。 数値フィールドおよび日付フィールドのみ。
>= より大きいか等しい。 数値フィールドおよび日付フィールドのみ。
last 過去の相対的な期間 (最後の 7 日間など)。 日時フィールドのみ。
next 将来の相対的な期間 (次の 7 日間など)。 日時フィールドのみ。
starting 過去の相対的な時点 (7 日前など) から、または将来の相対的な時点 (7 日後) から始まって無限大に続く期間。構文については、「相対的な日時演算子」を参照してください。 日時フィールドのみ。
ending 過去の相対的な時点 (7 日前など) まで、または将来の相対的な時点 (7 日後) までの期間。この時点までのすべてのデータが含まれます。構文については、「相対的な日時演算子」を参照してください。 日時フィールドのみ。
begins_with 指定した値でストリングが開始。 ストリング・フィールドのみ。
not_begins_with 指定した値でストリングが開始しない。 ストリング・フィールドのみ。
contains 指定した値をストリングが含む。 ストリング・フィールドのみ。
not_contains 指定した値をストリングが含まない。 ストリング・フィールドのみ。
ends_with 指定した値でストリングが終了。 ストリング・フィールドのみ。
not_ends_with 指定した値でストリングが終了しない。 ストリング・フィールドのみ。
9.2.13 is_empty 列が値を含まない。
例:
  • https://hostname:port/api/sam/v2/software_instances?token=token
&criteria={"and":[["exclusion_or_suppress_comment","is_empty"]]}
 選択された列のみ。
9.2.13 is_not_empty 列が値を含む。
例:
  • https://hostname:port/api/sam/v2/software_instances?token=token
&criteria={"and":[["exclusion_or_suppress_comment","is_not_empty"]]}
 選択された列のみ。

相対的な日時演算子の構文

これらの演算子は、日時形式を使用するすべての列で使用できます。
注: このコントラクト API は古いコントラクト (非推奨のコントラクト) に適用されます。新規コントラクトではこの API は使用されません。新規コントラクトについて詳しくは、新規コントラクトの管理を参照してください。
表 4. 相対的な日時演算子
演算子 構文

last next

 Px[D|W|M|Y]
x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。例:
  • 最後の 7 日間に報告されたデータをコンピューターから取得する:
    https://hostname:port/api/sam/computer_systems?token=token
&criteria={"and":[["last_seen","last","P7D"]]}
  • 次の 7 日までに資格が終了するコントラクトを取得する:
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["entitlement_end","next","P7D"]]}

starting ending

 [-|+]Px[D|W|M|Y]
x は 1 から 999 の範囲の数値であり、-/+ は「前」または「先」を表し、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。例:
  • 1 週間先の期間から保守が開始されるコントラクトを検索します。この API は、将来のコントラクトのみを検索します。
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["maintenance_start","starting","+P1W"]]}
  • 資格が 1 日前までに終了したコントラクトを検索します。この API は、過去 1 日前までの有効なコントラクトをすべて検索します。
    https://hostname:port/api/sam/contracts?token=token
&criteria={"and":[["entitlement_end","ending","-P1D"]]}

GET 要求の応答エレメント

表 5. GET 要求の応答エレメント
エレメント 「説明」
total 照会パラメーターに一致するすべてのレコードの数。limit パラメーターを使用した場合などは、返されるレコードの数が小さくなる可能性があります。
rows 照会によって返されるレコード。