REST API の共通エレメント

オンライン編集

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

コネクター

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

パラメーター

表 2. パラメータ
パラメーター 説明
countSwitch 照会が、要求されたデータ、取得された行の数、またはその両方のうち、どれを返すかを指定します。 演算子の値は以下のいずれかです。
  • 1 - 要求されたデータだけが返されます
  • 2 - 行数だけが返されます
  • 値なし、または上記以外の値 - 要求されたデータと行数の両方が返されます

演算子

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

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

これらの演算子は、日時形式を使用するすべての列で使用できます。
表 4。 相対日時演算子
オペレーター 構文

last
next

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

starting
ending

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

GET 要求に対する応答のエレメント

表 5. GET リクエストのレスポンス・エレメント
エレメント 説明
total 照会パラメーターを満たすすべてのレコードの数。 limit パラメーターを使用した場合などは、返されるレコードの数が少なくなることがあります。
rows 照会によって返されたレコード。