20.3.2　機器情報一覧取得

管理用サーバから機器情報の一覧を取得します。

機器情報の1レコードの単位は機器情報（Deviceオブジェクト）単位です。

実行権限

次の権限が必要です。

API権限

APIのバージョン

リクエスト形式

リクエスト行

GET /jp1itdm/api/v1/objects/devices_reference?フィルタ HTTP/1.1

フィルタには取得したい機器情報のフィルタ条件を指定します。詳細は「機器情報のフィルタ条件」を参照してください。

リクエストヘッダー

Host:管理用サーバのホスト名またはIPアドレス:管理用サーバのポート番号
Accept-Language:レスポンスのメッセージ文の言語コード
Accept:application/json
Content-Type:application/json
X-ITDM-Authorization1:Base64エンコードしたユーザーID
X-ITDM-Authorization2:Base64エンコードしたパスワード

リクエストのメッセージボディ

なし

レスポンス形式

ステータス行: ステータスコードおよびステータスコードのテキストが返却されます。詳細は「20.2　APIの共通仕様」のステータスコードの説明を参照してください。

レスポンスヘッダー

詳細は「20.2　APIの共通仕様」のレスポンス形式の説明を参照してください。

レスポンスのメッセージボディ

正常時は機器情報の一覧がJSON形式で格納されます。詳細は「機器情報のデータ形式」を参照してください。

エラーが発生した場合は、エラー情報がJSON形式で格納されます。詳細は「20.2　APIの共通仕様」のエラー情報の説明を参照してください。

機器情報のフィルタ条件

機器情報のフィルタ条件は、リクエスト行のクエリ文字列で指定します。機器情報のフィルタ条件に指定するクエリ文字列の形式を次に示します。

count=取得する件数&offset=レコードの開始位置&fields=取得する機器情報の項目&filters[1]=フィルタ条件1&filters[2]=フィルタ条件2...&filters[10]=フィルタ条件10&sort=ソート条件

（凡例）　...：「&filters[n]=フィルタ条件n」の繰り返し（n＝3〜9）

クエリ文字列の項目の詳細を次に示します。なお、クエリ文字列の項目はすべて省略可能です。クエリ文字列を1つも指定しない場合、すべての機器情報を上限件数まで取得した結果をレスポンスで返却します。

count

取得したい機器情報（Deviceオブジェクト）の件数を指定します。

「0」を指定した場合やこのパラメーターを指定しない場合は、10,000件が指定されたとみなします。10,000件を超える数値を指定した場合、エラーとなります。

例：取得したい機器情報（Deviceオブジェクト）の件数が1,000件の場合、「count=1000」を指定します。

メモ: 機器情報一覧取得で一度に取得可能な上限件数は10,000件です。

offset

取得する機器情報のレコードの開始位置を指定します。

「0」を指定した場合やこのパラメーターを指定しない場合は、機器情報の最初のレコードから取得します。

例：機器情報のレコードの1,001番目から取得したい場合、「offset=1001」を指定します。

メモ

機器情報の取得中に機器情報が追加されたり削除されたりした場合、次の実行時にレコードの開始位置がずれる場合があります。

レコードがずれた場合、取得されない（読み飛ばされる）レコードや重複して取得されるレコードが発生することがあります。

fields

機器情報として取得する項目を指定します。指定する項目は、「フィルタ条件に指定する項目と値の形式」を参照してください。複数の項目を指定する場合は、「項目名」を「,」（コンマ）で区切ります。

このパラメーターを指定しない場合は、機器情報のすべての項目を取得します。

例：機器情報の「ホスト識別子」、「ホスト名」、「機器種別」、および「OS種別」を取得したい場合、「fields=NodeID,HostName,EquipmentType,OsKind」を指定します。

filters[n]

取得する機器情報のフィルタ条件を指定します。フィルタ条件の詳細は、「フィルタ条件の構文」を参照してください。

フィルタ条件は10個まで指定できます。この場合、フィルタ条件の番号を1から順に10までをnに指定します。フィルタ条件の番号を途中で飛ばすことはできません。例えば、「filters[1]=フィルタ条件1&filters[2]=フィルタ条件2&filters[4]=フィルタ条件4」のようにフィルタ条件の番号3を飛ばして指定すると、エラーとなります。

フィルタ条件を複数指定する場合、フィルタ条件をすべて満たす機器情報を取得します。

sort

取得した機器情報を、指定された項目でソートします。ソートする項目は「フィルタ条件に指定する項目と値の形式」に記載の項目名を指定します。項目の降順でソートする場合は、「項目名」の前に「-」を指定します。

複数の項目を指定する場合は、「項目名」を「,」（コンマ）で区切ります。この場合、指定した項目の順にソートされます。

このパラメーターを指定しない場合、「sort=NodeID」が指定されたとみなします。

例：機器情報を「機器種別」の昇順でソートし、次に「更新日時」の降順でソートして取得する場合、「sort=EquipmentType,-LastUpdateTime」を指定します。

メモ: sortパラメーターを指定すると、末尾に「,NodeID」が指定されたとみなしてソートされます。

メモ: countパラメーターとoffsetパラメーターの合計値が2,147,483,647を超える場合はエラーとなります。また、countパラメーターを指定しない、またはcountパラメーターに「0」を指定して、countパラメーターの上限件数とoffsetパラメーターの合計値が2,147,483,647を超える場合もエラーとなります。

メモ

fieldsパラメーター、filters[n]パラメーター、およびsortパラメーターで指定する項目名には、次の記号は使用できません。

「'」、「"」、半角スペース、タブ、「{」、「}」、「[」、「]」、「(」、「)」、「¥」、「:」、「;」、「*」、「?」、「=」、「-」、「|」

フィルタ条件の構文

「filters[n]」に指定するフィルタ条件の構文を次に示します。

演算子「in()」および「not in()」以外を使用する場合

filters[n]=項目名△演算子△'値'

演算子「in()」または「not in()」を使用する場合

filters[n]=項目名△in('値1','値2'...)
filters[n]=項目名△not△in('値1','値2'...)

（凡例）...：「,'値n'」の繰り返し

重要: 半角スペースは△の個所で1個だけ記述してください。指定されていない個所で半角スペースを記述した場合や半角スペースを2個以上記述した場合はエラーとなります。

n

フィルタ条件の番号を指定します。1から10まで順に指定してください。

項目名

フィルタ条件の項目を、「フィルタ条件に指定する項目と値の形式」に記載の「項目名」で指定します。

演算子

フィルタ条件の演算子を指定します。指定できる演算子を次の表に示します。

演算子	説明	例
=	指定した項目名の値が、指定した値と一致する機器情報を取得します。	`filters[1]=HostName = 'host01'` ホスト名が「host01」である機器情報を取得します。
!=	指定した項目名の値が、指定した値と一致しない機器情報を取得します。	`filters[1]=HostName != 'host01'` ホスト名が「host01」でない機器情報を取得します。
>	指定した項目名の値が、指定した値よりも大きい機器情報を取得します。	filters[1]=StandbyTimeoutAC > '60' システムスタンバイ（AC）までの時間が60秒より大きい機器情報を取得します。 filters[1]=LastUpdateTime > '2020-04-01' 更新日時が「2020-04-01T00:00:00.000Z」より新しい機器情報を取得します。
<	指定した項目名の値が、指定した値よりも小さい機器情報を取得します。	filters[1]=StandbyTimeoutAC < '60' システムスタンバイ（AC）までの時間が60秒より小さい機器情報を取得します。 filters[1]=LastUpdateTime < '2020-04-01' 更新日時が「2020-04-01T00:00:00.000Z」より古い機器情報を取得します。
>=	指定した項目名の値が、指定した値以上の機器情報を取得します。	filters[1]=StandbyTimeoutAC >= '60' システムスタンバイ（AC）までの時間が60秒以上の機器情報を取得します。 filters[1]=LastUpdateTime >= '2020-04-01' 更新日時が「2020-04-01T00:00:00.000Z」以降の機器情報を取得します。
<=	指定した項目名の値が、指定した値以下の機器情報を取得します。	filters[1]=StandbyTimeoutAC <= '60' システムスタンバイ（AC）までの時間が60秒以下の機器情報を取得します。 filters[1]=LastUpdateTime <= '2020-04-01' 更新日時が「2020-04-01T00:00:00.000Z」以前の機器情報を取得します。
in()	指定した項目名の値が、括弧内に列挙した値のどれかと一致する機器情報を取得します。列挙する値は「'」（シングルクォーテーション）で囲み、「,」（コンマ）で区切ります。 in()句で指定可能な値の上限数は100件です。	`filters[1]=OsKind in('1','2','3')` OS種別が「1」（Windows）、「2」（Linux）、または「3」（UNIX）の機器情報を取得します。
not in()	指定した項目名の値が、括弧内に列挙した値と一致しない機器情報を取得します。列挙する値は「'」（シングルクォーテーション）で囲み、「,」（コンマ）で区切ります。 not in()句で指定可能な値の上限数は100件です。	`filters[1]=OsKind not in('1','2','3')` OS種別が「1」（Windows）、「2」（Linux）、または「3」（UNIX）以外の機器情報を取得します。
like	指定した項目名の値が、指定した値の文字列と一致する機器情報を取得します。値の文字列は大文字と小文字を区別します。値に指定する文字列にはワイルドカード「%」を使用できます。 % 長さ0を含む任意の長さの文字列とみなします。「_」、「%」または「¥」を含む文字列を値に指定する場合、それぞれ「¥_」、「¥%」または「¥¥」に置き換えて指定します。	filters[1]=HostName like 'TestPC' ホスト名が「TestPC」である機器情報を取得します。 filters[1]=HostName like 'Test%' ホスト名が「Test」で始まる機器情報を取得します。 filters[1]=HostName like '%Test%' ホスト名に「Test」を含む機器情報を取得します。
not like	指定した項目名の値が、指定した値の文字列と一致しない機器情報を取得します。値の文字列は大文字と小文字を区別します。値に指定する文字列にはワイルドカード「%」を使用できます。 % 長さ0を含む任意の長さの文字列とみなします。「_」、「%」または「¥」を含む文字列を値に指定する場合、それぞれ「¥_」、「¥%」または「¥¥」に置き換えて指定します。	filters[1]=HostName not like 'TestPC' ホスト名が「TestPC」でない機器情報を取得します。 filters[1]=HostName not like 'Test%' 「Test」で始まるホスト名でない機器情報を取得します。 filters[1]=HostName not like '%Test%' ホスト名に「Test」を含まない機器情報を取得します。

値

フィルタ条件の値を指定します。

指定する項目名のデータ型は、「フィルタ条件に指定する項目と値の形式」を参照してください。データ型の記述形式は、20.2　APIの共通仕様のサポートするデータ型の説明を参照してください。ただし、値は「'」（シングルクォーテーション）で囲んだ文字列で指定します。

メモ

dateTime型の項目名では、使用する演算子によって値の指定形式が異なります。

演算子「=」または「!=」を使用する場合

値を'YYYY-MM-DDTHH:MM:SS.sssZ'の形式で指定してください。

演算子「>」、「>=」、「<」または「<=」を使用する場合

'YYYY-MM-DDTHH:MM:SS.sssZ'の形式のうち、任意の位置まで指定できます。

例えば「filters[1]=LastUpdateTime<'2020-04'」と指定した場合、機器情報の「更新日時」が「2020-04-01T00:00:00.000Z」より前の情報を取得します。

メモ: 「'」を含む文字列を値に指定する場合、「''」に置き換えて指定します。

フィルタ条件に指定する項目と値の形式

フィルタ条件に指定する項目と値の形式を次の表に示します。

項目名	データ型	説明
NodeID	string	ホスト識別子でフィルタする場合に指定します。
HostName	string	ホスト名でフィルタする場合に指定します。
IPAddress	string	IPアドレスでフィルタする場合に指定します。値はIPv4の「xxx.xxx.xxx.xxx」形式の文字列（xxx：0〜255の数値）で指定します。演算子に「like」または「not like」を使用する場合は、値の末尾にワイルドカード文字「%」を必ず指定してください。
MACAddress	string	MACアドレスでフィルタする場合に指定します。値は「xx:xx:xx:xx:xx:xx」形式または「xx-xx-xx-xx-xx-xx」の文字列（x：0〜9、A〜F、またはa〜fのどれか1文字）で指定します。演算子に「like」または「not like」を使用する場合は、値の末尾にワイルドカード文字「%」を必ず指定してください。
CreateTime	dateTime	登録日時でフィルタする場合に指定します。
LastUpdateTime	dateTime	更新日時でフィルタする場合に指定します。
LastAliveDate	dateTime	最終接続確認日時でフィルタする場合に指定します。
IPSubnet	string	サブネットマスクでフィルタする場合に指定します。値はIPv4の「xxx.xxx.xxx.xxx」形式の文字列（xxx：0〜255の数値）で指定します。演算子に「like」または「not like」を使用する場合は、値の末尾にワイルドカード文字「%」を必ず指定してください。
EquipmentType	string	機器種別でフィルタする場合に指定します。指定できる値は次のどれかです。 `EquipmentTypeComputer`：PC `EquipmentTypeServer`：サーバ `EquipmentTypeStorage`：ストレージ `EquipmentTypeNetworkDevice`：ネットワーク装置 `EquipmentTypePrinter`：プリンタ `EquipmentTypePeripheralDevice`：周辺装置 `EquipmentTypeUSBMemory`：USB接続メディア `EquipmentTypeDisplay`：ディスプレイ `EquipmentTypeSmartDevice`：スマートデバイス `EquipmentTypeOther`：その他 `EquipmentTypeUnknown`：不明 `EquipmentTypeUser`：管理者が任意に追加したユーザー定義
EquipmentUserType	string	管理者が任意に追加したユーザー定義の名称でフィルタする場合に指定します。
OsKind	int	OS種別でフィルタする場合に指定します。指定できる値は次のどれかです。 `0`：不明 `1`：Windows `2`：Linux `3`：UNIX `4`：Mac OS `5`：スマートデバイス用OS `6`：HP-UX `7`：Solaris `8`：AIX
AMTFirmwareVersion	string	AMTファームウェアバージョンでフィルタする場合に指定します。
AgentType	int	管理種別でフィルタする場合に指定します。指定できる値は次のどれかです。 `0`：エージェント管理 `1`：エージェントレス管理 `2`：エージェント管理（ネットワーク監視用） `4`：エージェント管理（サイトサーバ） `6`：エージェント管理（サイトサーバ）（ネットワーク監視用） `9`：MDM連携管理 `16`：エージェント管理（中継システム） `18`：エージェント管理（中継システム）（ネットワーク監視用） `32`：管理用中継サーバ `34`：管理用中継サーバ（ネットワーク監視用） `65`：API管理
AgentVersion	string	エージェントバージョンでフィルタする場合に指定します。
DistributionRegDate	dateTime	配信日時でフィルタする場合に指定します。
AgentDistributionStatus	int	エージェントの配信状態でフィルタする場合に指定します。指定できる値は次のどれかです。 `0`：未配信（デフォルト値） `1`：配信待ち `11`：配信中 `51`：配信に失敗した（配信リトライ中） `52`：配信に失敗した（配信リトライ失敗） `999`：エージェントのインストーラーを起動した
AgentDistributionErrorType	int	エージェントの配信に失敗した場合のエラー内容でフィルタする場合に指定します。指定できる値は次のどれかです。 `0`：（デフォルト） `1`：認証エラー `2`：通信エラー `3`：導入中エラー `4`：PC起動待ちエラー `5`：その他のエラー `101`：エージェントの登録が行われていません `102`：ユーザ認証に失敗しました `103`：管理共有に接続できませんでした `104`：クライアントに接続できませんでした `105`：通信エラーが発生しました `106`：MACアドレスが登録上のMACアドレスと異なります `107`：エージェントが既にインストールされています `108`：エージェントから成功の通知が来ていません `109`：クライアントでマネージャのホスト名が解決できませんでした `110`：認証情報が指定されていません `111`：エージェントの媒体の作成中にエラーが発生しました `112`：エージェントのインストーラが現在実行中です `113`：エージェントのインストーラが終了しませんでした `201`：解凍失敗 `202`：前提OSエラー `203`：ユーザー権限エラー `204`：インストール失敗
AgentStatus	int	機器の管理状態でフィルタする場合に指定します。指定できる値は次のどれかです。 `0`：管理対象 `1`：除外対象 `2`：発見
DiscoverTime	dateTime	発見日時でフィルタする場合に指定します。
AuthStatus	int	機器状態の詳細でフィルタする場合に指定します。指定できる値は次のどれかです。 0：正常に稼働している(デフォルト値) 1：(探索機器の状態)認証エラーが発生した 2：(探索機器の状態)コンピュータが起動していない 101：(プリンタの状態)保守員への連絡が必要な状態 102：(プリンタの状態)カバーオープン 103：(プリンタの状態)紙づまり 104：(プリンタの状態)給紙トレイ紛失 105：(プリンタの状態)排紙トレイ紛失 106：(プリンタの状態)消耗品紛失 107：(プリンタの状態)トナー残量なし 108：(プリンタの状態)排紙トレイ満杯 109：(プリンタの状態)用紙がない 110：(プリンタの状態)給紙トレイが空 111：(プリンタの状態)トナー残量わずか 112：(プリンタの状態)用紙がわずか 113：(プリンタの状態)排紙トレイほぼ満杯 114：(プリンタの状態)通信エラーが発生した 115：(プリンタの状態)期限切れによる予防保守の時期 999：不明 1350：(サイトサーバの状態)致命的なエラーが発生した 1360：(サイトサーバの状態)データベースが閉塞した 3060：(サイトサーバの状態)サイトサーバのインストールに失敗した 3070：(サイトサーバの状態)サイトサーバのアンインストールに失敗した 3160：(ネットワークモニタの状態)ネットワークモニタのサービスが停止した 3260：(サイトサーバの状態)サイトサーバのサービスが停止した 3365：(サイトサーバの状態)操作ログのデータベース格納フォルダの空き容量がない 3370：(サイトサーバの状態)操作ログの保管先フォルダのドライブのディスク容量がない 3375：(サイトサーバの状態)操作ログのデータベース格納フォルダの空き容量が少ない 3380：(サイトサーバの状態)操作ログの保管先フォルダのドライブのディスク容量が少ない 3470：(サイトサーバの状態)データフォルダのドライブのディスク容量がない 3480：(サイトサーバの状態)データフォルダのドライブのディスク容量が少ない 3680：(ネットワークモニタ、サイトサーバの状態)コンピュータが起動していない 3850：(スマートデバイスの状態)スマートデバイスの初期化をした
NetworkStatus	int	接続状態でフィルタする場合に指定します。指定できる値は次のどれかです。 0：許可 1：遮断 2：強制遮断 3：利用期間外 999：不明
AgentDeviceStatus	int	機器状態でフィルタする場合に指定します。指定できる値は次のどれかです。 0：稼動中 1：停止中 2：警告 3：障害 999：不明 1100：対象外
DiscoveryProtocol	int	エージェントレスでの機器情報の収集方法でフィルタする場合に指定します。指定できる値は次のどれかです。 0:管理共有 1:リモートWMI 2:SNMP 3:ICMP 4:ARP 5:Active Directory 6:MDM 999:不明
Caption	string	OS名でフィルタする場合に指定します。
AllMacAddress	string	機器の持つすべてのMACアドレスでフィルタする場合に指定します。 MACアドレスの値は「xx:xx:xx:xx:xx:xx」形式または「xx-xx-xx-xx-xx-xx」の文字列（x：0〜9、A〜F、またはa〜fのどれか1文字）で指定します。複数のMACアドレスは「,」（コンマ）で区切ります。演算子に「like」または「not like」を使用する場合は、値の先頭と末尾にワイルドカード文字「%」を必ず指定してください。サイズを超える値を指定した場合、サイズの範囲内で指定されたMACアドレスだけが有効です。
InstallCompletionDate	dateTime	エージェントの配信が完了した日時でフィルタする場合に指定します。
CSDVersion	string	OSサービスパックでフィルタする場合に指定します。
IEVersion	string	Internet Explorerのバージョンでフィルタする場合に指定します。
UnnecessaryServicecnt	int	セキュリティポリシーで禁止されているWindowsサービスの個数でフィルタする場合に指定します。
VideoTimeoutAC	int	モニタの電源を切る（AC）までの時間（単位：秒）でフィルタする場合に指定します。
VideoTimeoutDC	int	モニタの電源を切る（DC）までの時間（単位：秒）でフィルタする場合に指定します。
StandbyTimeoutAC	int	システムスタンバイ（AC）までの時間（単位：秒）でフィルタする場合に指定します。
StandbyTimeoutDC	int	システムスタンバイ（DC）までの時間（単位：秒）でフィルタする場合に指定します。
HibernateTimeoutAC	int	システムの休止状態（AC）までの時間（単位：秒）でフィルタする場合に指定します。
HibernateTimeoutDC	int	システムの休止状態（DC）までの時間（単位：秒）でフィルタする場合に指定します。
SpindownTimeoutAC	int	ハードディスクの電源を切る（AC）までの時間（単位：秒）でフィルタする場合に指定します。
SpindownTimeoutDC	int	ハードディスクの電源を切る（DC）までの時間（単位：秒）でフィルタする場合に指定します。
OsLanguage	int	OSの言語でフィルタする場合に指定します。指定できる値は次のどれかです。 1 Arabic 4 Chinese (Simplified)– China 9 English 1025 Arabic – Saudi Arabia 1026 Bulgarian 1027 Catalan 1028 Chinese (Traditional) – Taiwan 1029 Czech 1030 Danish 1031 German – Germany 1032 Greek 1033 English – United States 1034 Spanish – Traditional Sort 1035 Finnish 1036 French – France 1037 Hebrew 1038 Hungarian 1039 Icelandic 1040 Italian – Italy 1041 Japanese 1042 Korean 1043 Dutch – Netherlands 1044 Norwegian – Bokmal 1045 Polish 1046 Portuguese – Brazil 1047 Rhaeto-Romanic 1048 Romanian 1049 Russian 1050 Croatian 1051 Slovak 1052 Albanian 1053 Swedish 1054 Thai 1055 Turkish 1056 Urdu 1057 Indonesian 1058 Ukrainian 1059 Belarusian 1060 Slovenian 1061 Estonian 1062 Latvian 1063 Lithuanian 1065 Persian 1066 Vietnamese 1069 Basque 1070 Serbian 1071 Macedonian (F.Y.R.O. Macedonia) 1072 Sutu 1073 Tsonga 1074 Tswana 1076 Xhosa 1077 Zulu 1078 Afrikaans 1080 Faeroese 1081 Hindi 1082 Maltese 1084 Gaelic 1085 Yiddish 1086 Malay – Malaysia 2049 Arabic – Iraq 2052 Chinese (Simplified) – PRC 2055 German – Switzerland 2057 English – United Kingdom 2058 Spanish – Mexico 2060 French – Belgium 2064 Italian – Switzerland 2067 Dutch – Belgium 2068 Norwegian – Nynorsk 2070 Portuguese – Portugal 2072 Romanian – Moldova 2073 Russian – Moldova 2074 Serbian – Latin 2077 Swedish – Finland 3073 Arabic – Egypt 3076 Chinese (Traditional) – Hong Kong SAR 3079 German – Austria 3081 English – Australia 3082 Spanish – International Sort 3084 French – Canada 3098 Serbian – Cyrillic 4097 Arabic – Libya 4100 Chinese (Simplified) – Singapore 4103 German – Luxembourg 4105 English – Canada 4106 Spanish – Guatemala 4108 French – Switzerland 5121 Arabic – Algeria 5127 German – Liechtenstein 5129 English – New Zealand 5130 Spanish – Costa Rica 5132 French – Luxembourg 6145 Arabic – Morocco 6153 English – Ireland 6154 Spanish – Panama 7169 Arabic – Tunisia 7177 English – South Africa 7178 Spanish – Dominican Republic 8193 Arabic – Oman 8201 English – Jamaica 8202 Spanish – Venezuela 9217 Arabic – Yemen 9226 Spanish – Colombia 10241 Arabic – Syria 10249 English – Belize 10250 Spanish – Peru 11265 Arabic – Jordan 11273 English – Trinidad 11274 Spanish – Argentina 12289 Arabic – Lebanon 12298 Spanish – Ecuador 13313 Arabic – Kuwait 13322 Spanish – Chile 14337 Arabic – U.A.E. 14346 Spanish – Uruguay 15361 Arabic – Bahrain 15370 Spanish – Paraguay 16385 Arabic – Qatar 16394 Spanish – Bolivia 17418 Spanish – El Salvador 18442 Spanish – Honduras 19466 Spanish – Nicaragua 20490 Spanish – Puerto Rico
ProductID	string	エージェントの形名でフィルタする場合に指定します。
PollingInterval	int	エージェントが管理用サーバにポーリングする間隔（単位：秒）でフィルタする場合に指定します。
MngStatusUpdateTime	dateTime	機器の管理状態を更新した日時でフィルタする場合に指定します。
AllIpAddress	string	機器の持つすべてのIPアドレスでフィルタする場合に指定します。値はIPv4の「xxx.xxx.xxx.xxx」形式の文字列（xxx：0〜255の数値）および、IPv6の「xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx」形式の文字列（x：0〜9、A〜F、またはa〜fのどれか1文字）で指定します。複数のIPアドレスは「,」（コンマ）で区切ります。演算子に「like」または「not like」を使用する場合は、値の先頭と末尾にワイルドカード文字「%」を必ず指定してください。サイズを超える値を指定した場合、サイズの範囲内で指定されたIPアドレスだけが有効です。
SnoozeDownloadStatus	int	パッケージのダウンロード延期状態でフィルタする場合に指定します。指定できる値は次のどちらかです。 0：延期していない 1：延期している
Domain	string	ドメインまたはワークグループでフィルタする場合に指定します。
Manufacturer	string	機器のモデルまたはメーカーでフィルタする場合に指定します。
NodeNameInt	int	数値型のホスト識別子でフィルタする場合に指定します。
UUID	string	UDIDでフィルタする場合に指定します。
PhoneNumber	string	契約電話番号でフィルタする場合に指定します。
IMEI	string	IMEIでフィルタする場合に指定します。
RegistrationType	int	管理形態でフィルタする場合に指定します。指定できる値は次のどちらかです。 0：オンライン管理 1：オフライン管理
OsLastStartUpdateTime	dateTime	OS最終起動日時でフィルタする場合に指定します。

機器情報のデータ形式

機器情報のデータ形式を次に示します。

{
    "DeviceList": [
        {
        "Device": {
            "NodeID": "ホスト識別子",
            "HostName": "ホスト名",
            "IPAddress": "IPアドレス",
            "MACAddress": "MACアドレス",
            "CreateTime": "登録日時",
            "LastUpdateTime": "更新日時",
            "LastAliveDate": "最終接続確認日時",
            "IPSubnet": "サブネットマスク",
            "EquipmentType": "機器種別",
            "EquipmentUserType": "管理者が任意に追加したユーザー定義の名称",
            "OsKind": "OS種別",
            "AMTFirmwareVersion": "AMTファームウェアバージョン",
            "AgentType": "管理種別",
            "AgentVersion": "エージェントバージョン",
            "DistributionRegDate": "配信日時",
            "AgentDistributionStatus": "エージェントの配信状態",
            "AgentDistributionErrorType": "エージェントの配信に失敗した場合のエラー内容",
            "AgentStatus": "機器の管理状態",
            "DiscoverTime": "発見日時",
            "AuthStatus": "機器状態の詳細",
            "NetworkStatus": "接続状態",
            "AgentDeviceStatus": "機器状態",
            "DiscoveryProtocol": "エージェントレスでの機器情報の収集方法",
            "Caption": "OS名",
            "AllMacAddress": "機器が保持するすべてのMACアドレス",
            "InstallCompletionDate": "エージェントの配信完了日時",
            "CSDVersion": "OSサービスパック",
            "IEVersion": "Internet Explorerのバージョン",
            "UnnecessaryServicecnt": "セキュリティポリシーで禁止されているWindowsサービス数",
            "VideoTimeoutAC": "モニタの電源(AC)を切るまでの時間(単位:秒)",
            "VideoTimeoutDC": "モニタの電源(DC)を切るまでの時間(単位:秒)",
            "StandbyTimeoutAC": "システムスタンバイ(AC)までの時間(単位:秒)",
            "StandbyTimeoutDC": "システムスタンバイ(DC)までの時間(単位:秒)",
            "HibernateTimeoutAC": "システムが休止状態(AC)に入るまでの時間(単位:秒)",
            "HibernateTimeoutDC": "システムが休止状態(DC)に入るまでの時間(単位:秒)",
            "SpindownTimeoutAC": "ハードディスクの電源(AC)を切るまでの時間(単位:秒)",
            "SpindownTimeoutDC": "ハードディスクの電源(DC)を切るまでの時間(単位:秒)",
            "OsLanguage": "OSの言語",
            "ProductID": "エージェントの形名",
            "PollingInterval": "エージェントが管理用サーバにポーリングする間隔(単位:秒)",
            "MngStatusUpdateTime": "管理状態の更新日時",
            "AllIpAddress": "機器が保持するすべてのIPアドレス",
            "SnoozeDownloadStatus": "パッケージのダウンロード延期状態",
            "Domain": "ドメインまたはワークグループ",
            "Manufacturer": "機器のモデルまたはメーカー",
            "NodeNameInt": "数値型のホスト識別子",
            "UUID": "UDID",
            "PhoneNumber": "契約電話番号",
            "IMEI": "IMEI",
            "RegistrationType": "管理形態",
            "OsLastStartUpdateTime": "OSの最終起動日時"
            }, ...
        }
    ],
    "offset": "今回の機器情報の開始位置",
    "responseCount": "取得した機器情報の件数",
    "totalCount": "指定されたフィルタに合致した機器情報の総件数"}

（凡例）　...：直前の階層の複数回繰り返し

DeviceList

項目名	データ型	必須/任意	説明
DeviceList	配列	必須	機器情報のルート名です。Deviceオブジェクトの配列が格納されています。
Device	オブジェクト	必須	機器情報のオブジェクト名です。詳細は「Deviceオブジェクト」を参照してください。
offset	int	必須	今回のレスポンスデータに含まれる機器情報のレコード開始位置が格納されています。
responseCount	int	必須	今回のレスポンスデータに含まれる、取得した機器情報のレコードの件数が格納されています。次のリクエスト時に、`totalCount`の値を超えない範囲で、`offset`の値と`responseCount`の値の和をリクエストのクエリ文字列の`offset`に指定して実行すると、次の機器情報のレコードを取得できます。
totalCount	int	必須	リクエストのクエリ文字列で指定されたフィルタに合致する機器情報のレコードの総件数が格納されています。

Deviceオブジェクト

Deviceオブジェクトの各項目は、すべて任意の項目です。

項目名	データ型	説明
NodeID	string	ホスト識別子が格納されます。
HostName	string	ホスト名が格納されます。空文字が格納される場合、「`"HostName": ""`」となります。
IPAddress	string	IPアドレス（IPv4）が格納されます。複数のIPアドレスがある機器の場合は、管理用サーバへの通知時に使用したIPアドレスが格納されます。空文字が格納される場合、「`"IPAddress": ""`」となります。
MACAddress	string	MACアドレスが格納されます。空文字が格納される場合、「`"MACAddress": ""`」となります。
CreateTime	dateTime	登録日時が格納されます。空文字が格納される場合、「`"CreateTime": ""`」となります。
LastUpdateTime	dateTime	更新日時が格納されます。空文字が格納される場合、「`"LastUpdateTime": ""`」となります。
LastAliveDate	dateTime	最終接続確認日時が格納されます。空文字が格納される場合、「`"LastAliveDate": ""`」となります。
IPSubnet	string	IPAddressに格納されているIPアドレスに対応するサブネットマスクが格納されます。空文字が格納される場合、「`"IPSubnet": ""`」となります。
EquipmentType	string	機器種別が格納されます。 EquipmentTypeに格納される値は次のどれかです。 `EquipmentTypeComputer`：PC `EquipmentTypeServer`：サーバ `EquipmentTypeStorage`：ストレージ `EquipmentTypeNetworkDevice`：ネットワーク装置 `EquipmentTypePrinter`：プリンタ `EquipmentTypePeripheralDevice`：周辺装置 `EquipmentTypeUSBMemory`：USB接続メディア `EquipmentTypeDisplay`：ディスプレイ `EquipmentTypeSmartDevice`：スマートデバイス `EquipmentTypeOther`：その他 `EquipmentTypeUnknown`：不明 `EquipmentTypeUser`：管理者が任意に追加したユーザー定義
EquipmentUserType	string	管理者が任意に追加したユーザー定義の名称が格納されます。空文字が格納される場合、「`"EquipmentUserType": ""`」となります。
OsKind	int	OS種別が格納されます。 OsKindに格納される値は次のどれかです。 `0`：不明 `1`：Windows `2`：Linux `3`：UNIX `4`：Mac OS `5`：スマートデバイス用OS `6`：HP-UX `7`：Solaris `8`：AIX
AMTFirmwareVersion	string	AMTファームウェアバージョンが格納されます。空文字が格納される場合、「`"AMTFirmwareVersion": ""`」となります。
AgentType	int	管理種別が格納されます。 AgentTypeに格納される値は次のどれかです。 `0`：エージェント管理 `1`：エージェントレス管理 `2`：エージェント管理（ネットワーク監視用） `4`：エージェント管理（サイトサーバ） `6`：エージェント管理（サイトサーバ）（ネットワーク監視用） `9`：MDM連携管理 `16`：エージェント管理（中継システム） `18`：エージェント管理（中継システム）（ネットワーク監視用） `32`：管理用中継サーバ `34`：管理用中継サーバ（ネットワーク監視用） `65`：API管理
AgentVersion	string	エージェントバージョンが格納されます。空文字が格納される場合、「`"AgentVersion": ""`」となります。
DistributionRegDate	dateTime	配信日時が格納されます。空文字が格納される場合、「`"DistributionRegDate": ""`」となります。
AgentDistributionStatus	int	エージェントの配信状態が格納されます。 AgentDistributionStatusに格納される値は次のどれかです。 `0`：未配信（デフォルト値） `1`：配信待ち `11`：配信中 `51`：配信に失敗した（配信リトライ中） `52`：配信に失敗した（配信リトライ失敗） `999`：エージェントのインストーラーを起動した
AgentDistributionErrorType	int	エージェントの配信に失敗した場合のエラー内容が格納されます。 AgentDistributionErrorTypeに格納される値は次のどれかです。 `0`：（デフォルト） `1`：認証エラー `2`：通信エラー `3`：導入中エラー `4`：PC起動待ちエラー `5`：その他のエラー `101`：エージェントの登録が行われていません `102`：ユーザ認証に失敗しました `103`：管理共有に接続できませんでした `104`：クライアントに接続できませんでした `105`：通信エラーが発生しました `106`：MACアドレスが登録上のMACアドレスと異なります `107`：エージェントが既にインストールされています `108`：エージェントから成功の通知が来ていません `109`：クライアントでマネージャのホスト名が解決できませんでした `110`：認証情報が指定されていません `111`：エージェントの媒体の作成中にエラーが発生しました `112`：エージェントのインストーラが現在実行中です `113`：エージェントのインストーラが終了しませんでした `201`：解凍失敗 `202`：前提OSエラー `203`：ユーザー権限エラー `204`：インストール失敗
AgentStatus	int	機器の管理状態が格納されます。 AgentStatusに格納される値は次のどれかです。 `0`：管理対象 `1`：除外対象 `2`：発見
DiscoverTime	dateTime	発見日時が格納されます。空文字が格納される場合、「`"DiscoverTime": ""`」となります。
AuthStatus	int	機器状態の詳細が格納されます。 AuthStatusに格納される値は次のどれかです。 0：正常に稼働している(デフォルト値) 1：(探索機器の状態)認証エラーが発生した 2：(探索機器の状態)コンピュータが起動していない 101：(プリンタの状態)保守員への連絡が必要な状態 102：(プリンタの状態)カバーオープン 103：(プリンタの状態)紙づまり 104：(プリンタの状態)給紙トレイ紛失 105：(プリンタの状態)排紙トレイ紛失 106：(プリンタの状態)消耗品紛失 107：(プリンタの状態)トナー残量なし 108：(プリンタの状態)排紙トレイ満杯 109：(プリンタの状態)用紙がない 110：(プリンタの状態)給紙トレイが空 111：(プリンタの状態)トナー残量わずか 112：(プリンタの状態)用紙がわずか 113：(プリンタの状態)排紙トレイほぼ満杯 114：(プリンタの状態)通信エラーが発生した 115：(プリンタの状態)期限切れによる予防保守の時期 999：不明 1350：(サイトサーバの状態)致命的なエラーが発生した 1360：(サイトサーバの状態)データベースが閉塞した 3060：(サイトサーバの状態)サイトサーバのインストールに失敗した 3070：(サイトサーバの状態)サイトサーバのアンインストールに失敗した 3160：(ネットワークモニタの状態)ネットワークモニタのサービスが停止した 3260：(サイトサーバの状態)サイトサーバのサービスが停止した 3365：(サイトサーバの状態)操作ログのデータベース格納フォルダの空き容量がない 3370：(サイトサーバの状態)操作ログの保管先フォルダのドライブのディスク容量がない 3375：(サイトサーバの状態)操作ログのデータベース格納フォルダの空き容量が少ない 3380：(サイトサーバの状態)操作ログの保管先フォルダのドライブのディスク容量が少ない 3470：(サイトサーバの状態)データフォルダのドライブのディスク容量がない 3480：(サイトサーバの状態)データフォルダのドライブのディスク容量が少ない 3680：(ネットワークモニタ、サイトサーバの状態)コンピュータが起動していない 3850：(スマートデバイスの状態)スマートデバイスの初期化をした
NetworkStatus	int	接続状態が格納されます。 NetworkStatusに格納される値は次のどれかです。 0：許可 1：遮断 2：強制遮断 3：利用期間外 999：不明
AgentDeviceStatus	int	機器状態が格納されます。 AgentDeviceStatusに格納される値は次のどれかです。 0：稼動中 1：停止中 2：警告 3：障害 999：不明 1100：対象外
DiscoveryProtocol	int	エージェントレスでの機器情報の収集方法が格納されます。 DiscoveryProtocolに格納される値は次のどれかです。 0:管理共有 2:SNMP 3:ICMP 4:ARP 5:Active Directory 6:MDM 999:不明
Caption	string	OS名が格納されます。空文字が格納される場合、「`"Caption": ""`」となります。
AllMacAddress	string	機器の持つすべてのMACアドレスが格納されます。格納されるMACアドレスは次に示す規則で表現されます。 MACアドレスは「:」（コロン）で区切った16進数で表記します。それぞれのMACアドレスは「,」（コンマ）で区切って複数並べられます。すべてのMACアドレスを並べると512文字を超える場合、512文字以内に収まる分だけ出力されます。空文字が格納される場合、「`"AllMacAddress": ""`」となります。
InstallCompletionDate	dateTime	エージェントの配信が完了した日時が格納されます。空文字が格納される場合、「`"InstallCompletionDate": ""`」となります。
CSDVersion	string	OSサービスパックが格納されます。空文字が格納される場合、「`"CSDVersion": ""`」となります。
IEVersion	string	Internet Explorerのバージョンが格納されます。空文字が格納される場合、「`"IEVersion": ""`」となります。
UnnecessaryServicecnt	int	セキュリティポリシーで禁止されているWindowsサービスの個数が格納されます。
VideoTimeoutAC	int	モニタの電源を切る（AC）までの時間（単位：秒）が格納されます。
VideoTimeoutDC	int	モニタの電源を切る（DC）までの時間（単位：秒）が格納されます。
StandbyTimeoutAC	int	システムスタンバイ（AC）までの時間（単位：秒）が格納されます。
StandbyTimeoutDC	int	システムスタンバイ（DC）までの時間（単位：秒）が格納されます。
HibernateTimeoutAC	int	システムの休止状態（AC）までの時間（単位：秒）が格納されます。
HibernateTimeoutDC	int	システムの休止状態（DC）までの時間（単位：秒）が格納されます。
SpindownTimeoutAC	int	ハードディスクの電源を切る（AC）までの時間（単位：秒）が格納されます。
SpindownTimeoutDC	int	ハードディスクの電源を切る（DC）までの時間（単位：秒）が格納されます。
OsLanguage	int	OSの言語が格納されます。 OsLanguageに格納される値は次のどれかです。 1 Arabic 4 Chinese (Simplified)– China 9 English 1025 Arabic – Saudi Arabia 1026 Bulgarian 1027 Catalan 1028 Chinese (Traditional) – Taiwan 1029 Czech 1030 Danish 1031 German – Germany 1032 Greek 1033 English – United States 1034 Spanish – Traditional Sort 1035 Finnish 1036 French – France 1037 Hebrew 1038 Hungarian 1039 Icelandic 1040 Italian – Italy 1041 Japanese 1042 Korean 1043 Dutch – Netherlands 1044 Norwegian – Bokmal 1045 Polish 1046 Portuguese – Brazil 1047 Rhaeto-Romanic 1048 Romanian 1049 Russian 1050 Croatian 1051 Slovak 1052 Albanian 1053 Swedish 1054 Thai 1055 Turkish 1056 Urdu 1057 Indonesian 1058 Ukrainian 1059 Belarusian 1060 Slovenian 1061 Estonian 1062 Latvian 1063 Lithuanian 1065 Persian 1066 Vietnamese 1069 Basque 1070 Serbian 1071 Macedonian (F.Y.R.O. Macedonia) 1072 Sutu 1073 Tsonga 1074 Tswana 1076 Xhosa 1077 Zulu 1078 Afrikaans 1080 Faeroese 1081 Hindi 1082 Maltese 1084 Gaelic 1085 Yiddish 1086 Malay – Malaysia 2049 Arabic – Iraq 2052 Chinese (Simplified) – PRC 2055 German – Switzerland 2057 English – United Kingdom 2058 Spanish – Mexico 2060 French – Belgium 2064 Italian – Switzerland 2067 Dutch – Belgium 2068 Norwegian – Nynorsk 2070 Portuguese – Portugal 2072 Romanian – Moldova 2073 Russian – Moldova 2074 Serbian – Latin 2077 Swedish – Finland 3073 Arabic – Egypt 3076 Chinese (Traditional) – Hong Kong SAR 3079 German – Austria 3081 English – Australia 3082 Spanish – International Sort 3084 French – Canada 3098 Serbian – Cyrillic 4097 Arabic – Libya 4100 Chinese (Simplified) – Singapore 4103 German – Luxembourg 4105 English – Canada 4106 Spanish – Guatemala 4108 French – Switzerland 5121 Arabic – Algeria 5127 German – Liechtenstein 5129 English – New Zealand 5130 Spanish – Costa Rica 5132 French – Luxembourg 6145 Arabic – Morocco 6153 English – Ireland 6154 Spanish – Panama 7169 Arabic – Tunisia 7177 English – South Africa 7178 Spanish – Dominican Republic 8193 Arabic – Oman 8201 English – Jamaica 8202 Spanish – Venezuela 9217 Arabic – Yemen 9226 Spanish – Colombia 10241 Arabic – Syria 10249 English – Belize 10250 Spanish – Peru 11265 Arabic – Jordan 11273 English – Trinidad 11274 Spanish – Argentina 12289 Arabic – Lebanon 12298 Spanish – Ecuador 13313 Arabic – Kuwait 13322 Spanish – Chile 14337 Arabic – U.A.E. 14346 Spanish – Uruguay 15361 Arabic – Bahrain 15370 Spanish – Paraguay 16385 Arabic – Qatar 16394 Spanish – Bolivia 17418 Spanish – El Salvador 18442 Spanish – Honduras 19466 Spanish – Nicaragua 20490 Spanish – Puerto Rico
ProductID	string	エージェントの形名が格納されます。空文字が格納される場合、「`"ProductID": ""`」となります。
PollingInterval	int	エージェントが管理用サーバにポーリングする間隔（単位：秒）が格納されます。
MngStatusUpdateTime	dateTime	機器の管理状態を更新した日時が格納されます。空文字が格納される場合、「`"MngStatusUpdateTime": ""`」となります。
AllIpAddress	string	機器の持つすべてのIPアドレス（IPv4およびIPv6）が格納されます。格納されるIPアドレスは次に示す規則で表現されます。 IPv4アドレスは「.」（ピリオド）で区切った10進数で表記します。 IPv6アドレスは「:」（コロン）で区切った16進数で表記します。それぞれのIPアドレスは「,」（コンマ）で区切って複数並べられます。すべてのIPアドレスを並べると512文字を超える場合、512文字以内に収まる分だけ出力されます。空文字が格納される場合、「`"AllIpAddress": ""`」となります。
SnoozeDownloadStatus	int	パッケージのダウンロード延期状態が格納されます。 SnoozeDownloadStatusに格納される値は次のどちらかです。 0：延期していない 1：延期している
Domain	string	ドメインまたはワークグループが格納されます。空文字が格納される場合、「`"Domain": ""`」となります。
Manufacturer	string	機器のモデルまたはメーカーが格納されます。空文字が格納される場合、「`"Manufacturer": ""`」となります。
NodeNameInt	int	数値型のホスト識別子が格納されます。
UUID	string	UDIDが格納されます。空文字が格納される場合、「`"UUID": ""`」となります。
PhoneNumber	string	契約電話番号が格納されます。空文字が格納される場合、「`"PhoneNumber": ""`」となります。
IMEI	string	IMEIが格納されます。空文字が格納される場合、「`"IMEI": ""`」となります。
RegistrationType	int	管理形態が格納されます。 RegistrationTypeに格納される値は次のどちらかです。 0：オンライン管理 1：オフライン管理
OsLastStartUpdateTime	dateTime	OS最終起動日時が格納されます。空文字が格納される場合、「`"OsLastStartUpdateTime": ""`」となります。

ページの先頭へ

20.3.2 機器情報一覧取得

20.3.2　機器情報一覧取得