ハードウェア・インベントリーの取得 (v2)

権限

この API を使用するには、「エンドポイントの表示」権限および「ハードウェア・インベントリーの表示」権限が必要です。

リソース URL

https://hostname:port/api/sam/v2/computers?token=token

リソース情報

スキーマの説明

GET api/sam/v2/schemas/computer.json?token=token

選択可能な列

適用可能な関連付け

API 関連付けの使用方法について詳しくは、以下を参照してください:REST API の関連付け。

照会パラメーター

表 3. 照会パラメーター

パラメーター	「説明」	必須	値
columns	取得する列を指定します。このパラメーターを指定しなかった場合、デフォルトの列のみが取得されます。 例: 製品名とリリースの取得 URL?columns[]=first_seen		ストリング
order	返されたデータのソート方法を指定します。列のソートのデフォルト方向は昇順です。降順ソートを指定する場合は、列名に desc を追加します。 例: コンピューター ID の降順での並び替え: URL?order[]=id desc		ストリング
限界値	取得する行数を指定します。このパラメーターを省略した場合、すべての行が取得されます。 例: 100 件のレコードの取得 URL?limit=100		数字
offset	結果の取得でスキップする行数を指定します。これを limit パラメーターと一緒に使用して、結果をページ編集できます。 例: レコード 150 の後から始まる 50 件のレコードの取得 URL?limit=50&offset=150		数字
token	固有のユーザー認証 ID。認証トークンを取得するための REST API を使用して取得することができます。BigFix Inventory にログインして「ユーザー」アイコンにカーソルを移動して、「プロファイル」をクリックすることもできます。次に、「トークンの表示」をクリックします。	✓	英数字
criteria	特定の条件と合致するレコードを取得します。このパラメーターでは、以下の構造が 1 行で記述されている必要があります。 <criteria> ::= <left-brace> <boolean-operator><colon> <left-bracket> <criterion> [{ <comma> <criterion> }...] <right-bracket> <right-brace> <boolean-operator> ::= "and" | "or" <criterion> ::= <criteria> | <left-bracket> <column> <comma> <operator> <comma> <value> <right-bracket> <column> ::= <json-string> <operator> ::= <json-string> <value> ::= <json-array> | <json-string> | <json-numver> | <json-null> 演算子について詳しくは、以下を参照してください。「共通のコネクターおよび演算子」。 例: 特定の日付範囲内に初めて報告したコンピューターの取得: URL?criteria={"and":[["first_seen", ">", "1970-01-01T00:00:00+00:00Z"], ["first_seen", "<", "1970-01-02T00:00:00+00:00Z"]]} 日時の値を使用する列の場合、特定の日付の代わりにある期間のデータを取得することもできます。これを行うには、last または next を <operator> として使用し、次の規則で時刻の値を指定します。PxD/PxW/PxM/PxY。ここで、x は 1 から 999 の範囲の数値であり、D、W、M、Y はそれぞれ、日、週、月、年を表す指定子です。 例: 過去 7 日間に初めて報告されたコンピューターの取得 URL?criteria={"and":[["first_seen","last","P7D"]]}		ストリング

会話例 - デフォルトの列

要求

GET api/sam/v2/computers?token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

応答本文

[{
"name":"NC9143126194",
"ip_address":["9.143.126.194"],
"os":"Win2012R2 6.3.9600",
"last_seen":"2016-09-22T10:32:12Z",
"is_deleted":1
}]

会話例 - すべての列

要求

GET api/sam/v2/computers?columns[]=id&columns[]=bigfix_id
&columns[]=name&columns[]=dns_name
&columns[]=ip_address&columns[]=os&columns[]=os_type
&columns[]=first_seen&columns[]=last_seen&columns[]=is_deleted
&columns[]=deletion_date&columns[]=is_managed_by_vm_manager
&token=7adc3efb175e2bc0f4484bdd2efca54a8fa04623
Host: localhost:9081 
Accept: application/json 
Accept-Language: en-US

応答本文

[{
"id":2,
"bigfix_id":11368943,
"name":"NC9143126194",
"dns_name":"NC9143126194",
"ip_address":["9.143.126.194"],
"os":"Win2012R2 6.3.9600",
"os_type":"Windows",
"first_seen":"2016-10-04T09:42:55Z",
"last_seen":"2016-09-22T10:32:12Z",
"is_deleted":1,
"deletion_date":"2016-12-19T09:40:14Z",
"is_managed_by_vm_manager":0
}]

会話例 - 追加の列

会話例 - 関連付け