20.3.3 機器のインストールソフトウェア情報一覧取得
管理用サーバから機器にインストールされているソフトウェア情報の一覧を取得します。
機器のインストールソフトウェア情報の1レコードの単位は機器単位ではなく、機器にインストールされたソフトウェア(Softwareオブジェクト)単位です。機器のインストールソフトウェア情報を全件取得する場合には以下の方法で取得してください。
- 取得方法
-
機器情報の一覧を取得します。取得した機器情報から機器のインストールソフトウェア情報を取得してください。機器のインストールソフトウェア情報を取得する際に「NodeNameInt」(数値型のホスト識別子)をフィルタ条件に含めてください。「NodeNameInt」(数値型のホスト識別子)を含まないフィルタ条件とした場合、取得に時間がかかります。
実行権限
次の権限が必要です。
-
API権限
APIのバージョン
v1
リクエスト形式
- リクエスト行
GET /jp1itdm/api/v1/objects/devices_reference/softwares?フィルタ 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
-
取得したいインストールソフトウェア(Softwareオブジェクト)の件数を指定します。
「0」を指定した場合やこのパラメーターを指定しない場合は、10,000件が指定されたとみなします。10,000件を超える数値を指定した場合、エラーとなります。
例:取得したいインストールソフトウェア(Softwareオブジェクト)の件数が1,000件の場合、「count=1000」を指定します。
- メモ
-
機器のインストールソフトウェア情報一覧取得で一度に取得可能な上限件数は10,000件です。
- offset
-
取得する機器にインストールされたソフトウェア情報のレコードの開始位置を指定します。
「0」を指定した場合やこのパラメーターを指定しない場合は、機器のインストールソフトウェア情報の最初のレコードから取得します。
例:機器のインストールソフトウェア情報のレコードの1,001番目から取得したい場合、「offset=1000」を指定します。
- メモ
-
機器のインストールソフトウェア情報の取得中に機器のインストールソフトウェア情報が追加されたり削除されたりした場合、次の実行時にレコードの開始位置がずれる場合があります。
レコードがずれた場合、取得されない(読み飛ばされる)レコードや重複して取得されるレコードが発生することがあります。
- 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,SoftwareName,SoftwareVersion,SoftwarePublisher」が指定されたとみなします。
例:機器のインストールソフトウェア情報を「機器種別」の昇順でソートし、次に「更新日時」の降順でソートして取得する場合、「sort=EquipmentType,-LastUpdateTime」を指定します。
- メモ
-
sortパラメーターを指定すると、末尾に「,NodeID,SoftwareName,SoftwareVersion,SoftwarePublisher」が指定されたとみなしてソートされます。
- メモ
-
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 |
機器種別でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
EquipmentUserType |
string |
管理者が任意に追加したユーザー定義の名称でフィルタする場合に指定します。 |
OsKind |
int |
OS種別でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
AMTFirmwareVersion |
string |
AMTファームウェアバージョンでフィルタする場合に指定します。 |
AgentType |
int |
管理種別でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
AgentVersion |
string |
エージェントバージョンでフィルタする場合に指定します。 |
DistributionRegDate |
dateTime |
配信日時でフィルタする場合に指定します。 |
AgentDistributionStatus |
int |
エージェントの配信状態でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
AgentDistributionErrorType |
int |
エージェントの配信に失敗した場合のエラー内容でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
AgentStatus |
int |
機器の管理状態でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
DiscoverTime |
dateTime |
発見日時でフィルタする場合に指定します。 |
AuthStatus |
int |
機器状態の詳細でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
NetworkStatus |
int |
接続状態でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
AgentDeviceStatus |
int |
機器状態でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
DiscoveryProtocol |
int |
エージェントレスでの機器情報の収集方法でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
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の言語でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
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 |
パッケージのダウンロード延期状態でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
Domain |
string |
ドメインまたはワークグループでフィルタする場合に指定します。 |
Manufacturer |
string |
機器のモデルまたはメーカーでフィルタする場合に指定します。 |
NodeNameInt |
int |
数値型のホスト識別子でフィルタする場合に指定します。 |
UUID |
string |
UDIDでフィルタする場合に指定します。 |
PhoneNumber |
string |
契約電話番号でフィルタする場合に指定します。 |
IMEI |
string |
IMEIでフィルタする場合に指定します。 |
RegistrationType |
int |
管理形態でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
OsLastStartUpdateTime |
dateTime |
OS最終起動日時でフィルタする場合に指定します。 |
InstallDate |
dateTime |
インストール日付でフィルタする場合に指定します。 |
SourceKind |
int |
ソフトウェア情報の収集方法でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
InstallPath |
string |
インストールフォルダでフィルタする場合に指定します。 |
BgStatus |
int |
ソフトウェア情報の内部処理状態でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
SoftwareProductID |
string |
プロダクトIDでフィルタする場合に指定します。 |
GUID |
int |
GUIDでフィルタする場合に指定します。 |
SoftwareName |
string |
ソフトウェア名でフィルタする場合に指定します。 |
SoftwareVersion |
string |
バージョンでフィルタする場合に指定します。 |
SoftwarePublisher |
string |
メーカーでフィルタする場合に指定します。 |
SoftwareType |
int |
ソフトウェア情報の種類でフィルタする場合に指定します。 指定できる値は次のどれかです。
|
RegistrationDate |
dateTime |
登録日時でフィルタする場合に指定します。 |
HelpLink |
string |
サポート情報(URL)でフィルタする場合に指定します。 |
SoftwareCheck |
int |
確認状態でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
ImportantSoft |
int |
Microsoft Office製品のソフトウェアであるかどうかでフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
AppType |
int |
アプリ種別でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
MSProductType |
int |
Microsoft Office製品の購入形態でフィルタする場合に指定します。 指定できる値は次のどちらかです。
|
MSProductId |
string |
Microsoft Office製品のプロダクトIDでフィルタする場合に指定します。 |
機器のインストールソフトウェア情報のデータ形式
機器のインストールソフトウェア情報のデータ形式を次に示します。
{ "DeviceSoftwareList": [ { "DeviceSoftware": { "NodeID": "ホスト識別子", "HostName": "ホスト名", "IPAddress": "IPアドレス", "MACAddress": "MACアドレス", "CreateTime": "登録日時", "LastUpdateTime": "更新日時", "LastAliveDate": "最終接続確認日時", "IPSubnet": "サブネットマスク", "EquipmentType": "機器種別", "EquipmentUserType": "管理者が任意に追加したユーザー定義の名称", "OsKind": "OS種別", "AMTFirmwareVersion": "AMTファームウェアバージョン", "AgentType": "管理種別", "AgentVertsion": "エージェントバージョン", "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の最終起動日時", "SoftwareList": [ { "Software": { "InstallDate": "インストール日付", "SourceKind": "ソフトウェア情報の収集方法", "InstallPath": "インストールフォルダ", "BgStatus": "ソフトウェア情報の内部処理状態", "SoftwareProductID": "プロダクトID", "GUID": "GUID", "SoftwareName": "ソフトウェア名", "SoftwareVersion": "バージョン", "SoftwarePublisher": "メーカー", "SoftwareType": "ソフトウェア情報の種類", "RegistrationDate": "登録日時", "HelpLink": "サポート情報(URL)", "SoftwareCheck": "確認状態", "ImportantSoft": "Microsoft Office製品のソフトウェアであるかどうか", "AppType": "アプリ種別", "MSProductType": "Microsoft Office製品の購入形態", "MSProductId": "Microsoft Office製品のプロダクトID" }, ... } ] }, ... } ], "offset": "今回の機器のインストールソフトウェア情報の開始位置", "responseCount": "取得した機器のインストールソフトウェア情報の件数", "totalCount": "指定されたフィルタに合致した機器のインストールソフトウェア情報の総件数"} }
(凡例) ...:直前の階層の複数回繰り返し
DeviceSoftwareList
項目名 |
データ型 |
必須/任意 |
説明 |
---|---|---|---|
DeviceSoftwareList |
配列 |
必須 |
機器のインストールソフトウェア情報のルート名です。DeviceSoftwareオブジェクトの配列が格納されています。 |
DeviceSoftware |
オブジェクト |
必須 |
機器のインストールソフトウェア情報のオブジェクト名です。詳細は「DeviceSoftwareオブジェクト」を参照してください。 |
offset |
int |
必須 |
今回のレスポンスデータに含まれる機器のインストールソフトウェア情報のレコード開始位置が格納されています。 |
responseCount |
int |
必須 |
今回のレスポンスデータに含まれる、取得した機器のインストールソフトウェア情報のレコードの件数が格納されています。 次のリクエスト時に、totalCountの値を超えない範囲で、offsetの値とresponseCountの値の和をリクエストのクエリ文字列のoffsetに指定して実行すると、次の機器のインストールソフトウェア情報のレコードを取得できます。 |
totalCount |
int |
必須 |
リクエストのクエリ文字列で指定されたフィルタに合致する機器のインストールソフトウェア情報のレコードの総件数が格納されています。 |
DeviceSoftwareオブジェクト
DeviceSoftwareオブジェクトの各項目は、SoftwareList配列およびSoftwareオブジェクトを除き任意の項目です。
項目名 |
データ型 |
説明 |
---|---|---|
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に格納される値は次のどれかです。
|
EquipmentUserType |
string |
管理者が任意に追加したユーザー定義の名称が格納されます。 空文字が格納される場合、「"EquipmentUserType": ""」となります。 |
OsKind |
int |
OS種別が格納されます。 OsKindに格納される値は次のどれかです。
|
AMTFirmwareVersion |
string |
AMTファームウェアバージョンが格納されます。 空文字が格納される場合、「"AMTFirmwareVersion": ""」となります。 |
AgentType |
int |
管理種別が格納されます。 AgentTypeに格納される値は次のどれかです。
|
AgentVersion |
string |
エージェントバージョンが格納されます。 空文字が格納される場合、「"AgentVersion": ""」となります。 |
DistributionRegDate |
dateTime |
配信日時が格納されます。 空文字が格納される場合、「"DistributionRegDate": ""」となります。 |
AgentDistributionStatus |
int |
エージェントの配信状態が格納されます。 AgentDistributionStatusに格納される値は次のどれかです。
|
AgentDistributionErrorType |
int |
エージェントの配信に失敗した場合のエラー内容が格納されます。 AgentDistributionErrorTypeに格納される値は次のどれかです。
|
AgentStatus |
int |
機器の管理状態が格納されます。 AgentStatusに格納される値は次のどれかです。
|
DiscoverTime |
dateTime |
発見日時が格納されます。 空文字が格納される場合、「"DiscoverTime": ""」となります。 |
AuthStatus |
int |
機器状態の詳細が格納されます。 AuthStatusに格納される値は次のどれかです。
|
NetworkStatus |
int |
接続状態が格納されます。 NetworkStatusに格納される値は次のどれかです。
|
AgentDeviceStatus |
int |
機器状態が格納されます。 AgentDeviceStatusに格納される値は次のどれかです。
|
DiscoveryProtocol |
int |
エージェントレスでの機器情報の収集方法が格納されます。 DiscoveryProtocolに格納される値は次のどれかです。
|
Caption |
string |
OS名が格納されます。 空文字が格納される場合、「"Caption": ""」となります。 |
AllMacAddress |
string |
機器の持つすべてのMACアドレスが格納されます。 格納されるMACアドレスは次に示す規則で表現されます。
|
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に格納される値は次のどれかです。
|
ProductID |
string |
エージェントの形名が格納されます。 空文字が格納される場合、「"ProductID": ""」となります。 |
PollingInterval |
int |
エージェントが管理用サーバにポーリングする間隔(単位:秒)が格納されます。 |
MngStatusUpdateTime |
dateTime |
機器の管理状態を更新した日時が格納されます。 空文字が格納される場合、「"MngStatusUpdateTime": ""」となります。 |
AllIpAddress |
string |
機器の持つすべてのIPアドレス(IPv4およびIPv6)が格納されます。 格納されるIPアドレスは次に示す規則で表現されます。
空文字が格納される場合、「"AllIpAddress": ""」となります。 |
SnoozeDownloadStatus |
int |
パッケージのダウンロード延期状態が格納されます。 SnoozeDownloadStatusに格納される値は次のどちらかです。
|
Domain |
string |
ドメインまたはワークグループが格納されます。 空文字が格納される場合、「"Domain": ""」となります。 |
Manufacturer |
string |
機器のモデルまたはメーカーが格納されます。 空文字が格納される場合、「"Manufacturer": ""」となります。 |
NodeNameInt |
int |
数値型のホスト識別子が格納されます。 |
UUID |
string |
UDIDが格納されます。 空文字が格納される場合、「"UUID": ""」となります。 |
PhoneNumber |
string |
契約電話番号が格納されます。 空文字が格納される場合、「"PhoneNumber": ""」となります。 |
IMEI |
string |
IMEIが格納されます。 空文字が格納される場合、「"IMEI": ""」となります。 |
RegistrationType |
int |
管理形態が格納されます。 RegistrationTypeに格納される値は次のどちらかです。
|
OsLastStartUpdateTime |
dateTime |
OS最終起動日時が格納されます。 空文字が格納される場合、「"OsLastStartUpdateTime": ""」となります。 |
SoftwareList |
配列 |
機器のインストールソフトウェア情報がSoftwareオブジェクトの配列で格納されます。 SoftwareList配列は必須項目です。 |
Software |
オブジェクト |
機器のインストールソフトウェア情報のオブジェクト名です。詳細は「Softwareオブジェクト」を参照してください。 Softwareオブジェクトは必須項目です。 |
Softwareオブジェクト
Softwareオブジェクトの各項目は、すべて任意の項目です。
項目名 |
データ型 |
説明 |
---|---|---|
InstallDate |
dateTime |
インストール日付が格納されます。 空文字が格納される場合、「"InstallDate": ""」となります。 |
SourceKind |
int |
ソフトウェア情報の収集方法が格納されます。 SourceKindに格納される値は次のどちらかです。
|
InstallPath |
string |
インストールフォルダが格納されます。 空文字が格納される場合、「"InstallPath": ""」となります。 |
BgStatus |
int |
ソフトウェア情報の内部処理状態が格納されます。 BgStatusに格納される値は次のどれかです。
|
SoftwareProductID |
string |
プロダクトIDが格納されます。 空文字が格納される場合、「"SoftwareProductID": ""」となります。 |
GUID |
int |
GUIDが格納されます。 |
SoftwareName |
string |
ソフトウェア名が格納されます。 |
SoftwareVersion |
string |
バージョンが格納されます。 空文字が格納される場合、「"SoftwareVersion": ""」となります。 |
SoftwarePublisher |
string |
メーカーが格納されます。 空文字が格納される場合、「"SoftwarePublisher": ""」となります。 |
SoftwareType |
int |
ソフトウェア情報の種類が格納されます。 SoftwareTypeに格納される値は次のどれかです。
|
RegistrationDate |
dateTime |
登録日時が格納されます。 |
HelpLink |
string |
サポート情報(URL)が格納されます。 |
SoftwareCheck |
int |
確認状態が格納されます。 SoftwareCheckに格納される値は次のどちらかです。
|
ImportantSoft |
int |
Microsoft Office製品のソフトウェアかどうかが格納されます。 ImportantSoftに格納される値は次のどちらかです。
|
AppType |
int |
アプリ種別が格納されます。 AppTypeに格納される値は次のどちらかです。
|
MSProductType |
int |
Microsoft Office製品の購入形態が格納されます。 値がない場合、-1が格納されます。 MSProductTypeに格納される値は次のどれかです。
空文字が格納される場合、「"MSProductType": ""」となります。 |
MSProductId |
string |
Microsoft Office製品のプロダクトIDが格納されます。 格納されるプロダクトIDは、ボリュームライセンス版のプロダクトIDの下5桁が「*」(アスタリスク)でマスクされます。 プロダクトIDが存在しない場合、またはボリュームライセンス版以外の場合は空文字となります。 空文字が格納される場合、「"MSProductId": ""」となります。 |
注※ この状態のソフトウェアは削除されたものとして、管理画面では表示されません。