20.3.3 Installed software information list acquisition
This API acquires an installed software information list (list that shows information regarding the software programs installed on devices) from the management server.
The unit for one record of installed software information is not device unit, but installed software information of the device (Software object) unit. To obtain all software information installed on the device, use the following method.
- Acquisition method
-
Get a list of device information. Obtain the installed software information of the device from the acquired device information. Include NodeNameInt (numeric host identifier) in the filter condition when acquiring the installed software information of the device. If the filter condition does not include NodeNameInt (numeric host identifier), it will take more time to acquire the information.
Execution permission
You need the following permission:
-
API permission
API version
v1
Request format
- Request line
GET /jp1itdm/api/v1/objects/devices_reference/softwares?filter HTTP/1.1
For filter, specify filter conditions for acquiring desired installed software information. For details, see Filter conditions for acquiring installed software information.
- Request header
Host:host-name-or-IP-address-of-management-server:port-number-of-management-server Accept-Language:language-code-in-the-message-of-response Accept:application/json Content-Type:application/json X-ITDM-Authorization1:Base64-encoded-user-ID X-ITDM-Authorization2:Base64-encoded-password
- Request message body
-
None
Response format
- Status line
-
Either a status code or its text is returned. For details, see the description of status codes in 20.2 Common API specifications.
- Response header
-
For details, see the description of the response format in 20.2 Common API specifications.
- Response message body
-
Under normal circumstances, the message body contains a device information list in JSON format. For details, see Data format for installed software information.
When an error occurs, error information is stored in JSON format. For details, see the description of the error information in 20.2 Common API specifications.
Filter conditions for acquiring installed software information
You can specify a filter condition for acquiring installed software information by inserting a query string in the request line. A query string to be used to specify filter conditions for acquiring installed software information should be in the following format:
count=number-of-records-to-acquire&offset=start-position-for-records&fields=items-included-in-each-acquired-record&filters[1]=filter-condition-1&filters[2]=filter-condition-2...&filters[10]=filter-condition-10&sort=sort-condition
Legend: ...: Repetitions of &filters[n]=filter-condition-n (n = 3 to 9)
Each item in the query string is described in detail below. All of these items are optional. When no query string is specified, a response returned will contain the maximum number of installed software information records that can be acquired.
- count
-
Specify the number of installed software (Software Object) you want to acquire.
If you specify 0 or if you omit this parameter, it is assumed that 10,000 has been specified. Specifying a value that exceeds 10,000 will result in an error.
Example: When you want to acquire 1,000 installed software (Software Object), specify count=1000.
- Note
-
The maximum number of information that can be acquired at one time by the installed software information list acquisition is 10,000.
- offset
-
Specify the start position for the record of software information installed on the device to be acquired.
If you specify 0 or if you omit this parameter, installed software information records are acquired starting from the first record.
Example: When you want to acquire installed software information records starting from Record 1,001, specify offset=1000.
- Note
-
Adding or deleting installed software information records during the acquisition of installed software information records can cause the start position to shift when you attempt to acquire the next set of installed software information records.
If the records are shifted, some records may not be acquired (skipped) or duplicate records may be acquired.
- fields
-
Specify the items you want included in each acquired installed software information record. For details about the specifiable items, see Items that can be specified as filter conditions and the format of their values. When you specify multiple items, use a comma (,) to separate them.
If you omit this parameter, each one of the acquired installed software information records will contain all items.
Example: If you want the acquired installed software information records to contain the host ID, host name, device type, and OS type of the individual devices, specify fields=NodeID,HostName,EquipmentType,OsKind.
- filters[n]
-
Specify filter conditions for the installed software information records to be acquired. For details about filter conditions, see Syntax for filter conditions.
You can specify a maximum of 10 filter conditions. When there are 10 filter conditions, specify filter condition numbers from 1 to 10, in that order, by replacing each n with the corresponding number. Do not skip a filter condition number. For example, specifying the following filter conditions, in which filter condition number 3 is skipped, results in an error: filters[1]=filter-condition-1&filters[2]=filter-condition-2&filters[4]=filter-condition-4.
When you specify multiple filter conditions, only those installed software information records that satisfy all specified conditions are acquired.
- sort
-
Specify items to be used to sort the acquired installed software information records. Select from the items listed under Items that can be specified as filter conditions and the format of their values. To sort the acquired device information records in the descending order of the values corresponding to a certain item, prefix the item name with a minus sign (-).
When you specify multiple item names, separate them with a comma (,). When multiple items are specified, the acquired installed software information records are first sorted according to the first item specified, and the resulting records are further sorted according to the second item specified, and so on.
If you omit this parameter, it is assumed that sort=NodeID,SoftwareName,SoftwareVersion,SoftwarePublisher is specified.
Example: To sort acquired installed software information records in ascending order of device type, and then sort the resulting records in descending order of last updated date and time, specify sort=EquipmentType,-LastUpdateTime.
- Note
-
If you specify sort parameter, it is assumed that ,NodeID,SoftwareName,SoftwareVersion,SoftwarePublisher is specified in end of the parameter.
- Note
-
An error occurs if the total value for the count parameter and offset parameter exceeds 2,147,483,647. An error also occurs if the count parameter is not specified or 0 is specified for the count parameter, and the total value for the upper limit for the count parameter and the offset parameter exceeds 2,147,483,647.
- Note
-
The following symbols cannot be used in the item names specified in the fields parameter, filters[n] parameter, or sort parameter.
single quotation mark ('), double quotation mark ("), space, tab, left curly bracket ({), right curly bracket (}), left square bracket ([), right square bracket (]), left parenthesis ((), right parenthesis ()), backslash (\), colon (:), semicolon (;), asterisk (*), question mark (?), equal sign (=), hyphen (-), and vertical bar (|)
Syntax for filter conditions
Use the following syntax to specify a filter condition for filters[n]:
- When an operator other than in() or not in() is to be used:
filters[n]=item-name∆operator∆'value'
- When in() or not in() is to be used as an operator:
filters[n]=item-name∆in('value-1','value-2'...) filters[n]=item-name∆not∆in('value-1','value-2'...)
Legend:
...: Repetitions of ,'value-n'
∆: One space character
- Important
-
Only one space should be written at ∆. If the space is used in not specified at ∆ or if two or more spaces are written, an error occurs.
- n
-
Specify a filter condition number. Filter conditions must be numbered serially from 1 to 10.
- item-name
-
Specify a filter condition by selecting from the item names listed under Items that can be specified as filter conditions and the format of their values.
- operator
-
Specify an operator for the filter condition. The following table shows specifiable operators.
Operator
Description
Example
=
Acquires installed software information records whose value corresponding to the specified item-name matches the specified value.
filters[1]=HostName = 'host01'
Acquires installed software information records whose host name is host01.
!=
Acquires installed software information records whose value corresponding to the specified item-name does not match the specified value.
filters[1]=HostName != 'host01'
Acquires installed software information records whose host name is something other than host01.
>
Acquires installed software information records whose value corresponding to the specified item-name is larger than the specified value.
filters[1]=StandbyTimeoutAC > '60'
Acquires installed software information records whose time to system standby (AC) is longer than 60 seconds.
filters[1]=LastUpdateTime > '2020-04-01'
Acquires installed software information records whose last updated date and time is after 2020-04-01T00:00:00.000Z.
<
Acquires installed software information records whose value corresponding to the specified item-name is smaller than the specified value.
filters[1]=StandbyTimeoutAC < '60'
Acquires installed software information records whose time to system standby (AC) is shorter than 60 seconds.
filters[1]=LastUpdateTime < '2020-04-01'
Acquires installed software information records whose last updated date and time is before 2020-04-01T00:00:00.000Z.
>=
Acquires installed software information records whose value corresponding to the specified item-name is equal to or larger than the specified value.
filters[1]=StandbyTimeoutAC >= '60'
Acquires installed software information records whose time to system standby (AC) is equal to or longer than 60 seconds.
filters[1]=LastUpdateTime >= '2020-04-01'
Acquires installed software information records whose last updated date and time is 2020-04-01T00:00:00.000Z or later.
<=
Acquires installed software information records whose value corresponding to the specified item-name is equal to or smaller than the specified value.
filters[1]=StandbyTimeoutAC <= '60'
Acquires installed software information records whose time to system standby (AC) is equal to or shorter than 60 seconds.
filters[1]=LastUpdateTime <= '2020-04-01'
Acquires installed software information records whose last updated date and time is 2020-04-01T00:00:00.000Z or earlier.
in()
Acquires installed software information records whose value corresponding to the specified item-name matches one of the values listed in parentheses.
The listed values are individually enclosed in single quotation marks (') and separated with a comma (,) in between.
The maximum number of values that can be specified in the in() clause is 100.
filters[1]=OsKind in('1','2','3')
Acquires installed software information records whose OS type is 1 (Windows), 2 (Linux), or 3 (UNIX).
not in()
Acquires installed software information records whose value corresponding to the specified item-name does not match any of the values listed in parentheses.
The listed values are individually enclosed in single quotation marks (') and separated with a comma (,) in between.
The maximum number of values that can be specified in the not in() clause is 100.
filters[1]=OsKind not in('1','2','3')
Acquires installed software information records whose OS type is something other than 1 (Windows), 2 (Linux), or 3 (UNIX).
like
Acquires installed software information records whose value corresponding to the specified item-name matches a string in the specified value.
This operator distinguishes between uppercase and lowercase letters in a string contained in the value.
You can use a wildcard (%) in a string contained in the specified value.
- %
-
Represents a string of any length, including 0 length.
When the specified value contains a string that contains a underscore (_), percent sign (%) or backslash (\), replace it with \_, \% or \\.
filters[1]=HostName like 'TestPC'
Acquires installed software information records whose host name is TestPC.
filters[1]=HostName like 'Test%'
Acquires installed software information records whose host name starts with the string Test.
filters[1]=HostName like '%Test%'
Acquires installed software information records whose host name contains the string Test.
not like
Acquires installed software information records whose value corresponding to the specified item-name does not match a string in the specified value.
This operator distinguishes between uppercase and lowercase letters in a string contained in the value.
You can use a wildcard (%) in a string contained in the specified value.
- %
-
Represents a string of any length, including 0 length.
When the specified value contains a string that contains a underscore (_), percent sign (%) or backslash (\), replace it with \_, \% or \\.
filters[1]=HostName not like 'TestPC'
Acquires installed software information records whose host name is something other than TestPC.
filters[1]=HostName not like 'Test%'
Acquires installed software information records whose host name does not start with the string Test.
filters[1]=HostName not like '%Test%'
Acquires installed software information records whose host name does not contain the string Test.
- value
-
Specify a value for the filter condition.
For details about the data type of the item name to be specified, see Items that can be specified as filter conditions and the format of their values. For details about the coding format appropriate to each data type, see the information provided under Supported data types in 20.2 Common API specifications. Remember that you have to enclose a string in single quotation marks (') to specify a value.
- Note
-
The format to be used to specify a value for the dateTime-type item names varies depending on the operator used.
- When using = or != as the operator
-
Specify the value in the 'YYYY-MM-DDTHH:MM:SS.sssZ' format.
- When using >, >=, < or <= as the operator
-
The basic format being 'YYYY-MM-DDTHH:MM:SS.sssZ', you only have to specify up to a desired point in this format.
For example, if you specify filters[1]=LastUpdateTime<'2020-04', installed software information records whose last updated date and time is earlier than 2020-04-01T00:00:00.000Z are acquired.
- Note
-
If a string containing single quotation mark (') is specified as a value, it must be replaced with two single quotation marks ('').
Items that can be specified as filter conditions and the format of their values
The following table describes the items that can be specified as filter conditions and the format of their values:
Item name |
Data type |
Description |
---|---|---|
NodeID |
string |
Specify this item to filter device information records by host ID. |
HostName |
string |
Specify this item to filter device information records by host name. |
IPAddress |
string |
Specify this item to filter device information records by IP address. This value must be expressed as a string by using the IPv4 format xxx.xxx.xxx.xxx (where xxx represents a number in the range of 0-255). When using like or not like as the operator, remember to suffix the specified value with the wildcard character %. |
MACAddress |
string |
Specify this item to filter device information records by MAC address. This value must be in the xx:xx:xx:xx:xx:xx format or expressed as a string using the format xx-xx-xx-xx-xx-xx (where x represents a number in the range of 0-9 or a letter in the range of A-F or a-f). When using like or not like as the operator, remember to suffix the specified value with the wildcard character %. |
CreateTime |
dateTime |
Specify this item to filter device information records by created date and time. |
LastUpdateTime |
dateTime |
Specify this item to filter device information records by last updated date and time. |
LastAliveDate |
dateTime |
Specify this item to filter device information records by date and time when a computer-to-management server connection was last confirmed. |
IPSubnet |
string |
Specify this item to filter device information records by subnet mask. This value must be expressed as a string by using the IPv4 format xxx.xxx.xxx.xxx (where xxx represents a number in the range of 0-255). When using like or not like as the operator, remember to suffix the specified value with the wildcard character %. |
EquipmentType |
string |
Specify this item to filter device information records by device type. You can specify one of the following values:
|
EquipmentUserType |
string |
Specify this item to filter device information records by name of user definition optionally added by the administrator user. |
OsKind |
int |
Specify this item to filter device information records by OS type. You can specify one of the following values:
|
AMTFirmwareVersion |
string |
Specify this item to filter device information records by AMT firmware version. |
AgentType |
int |
Specify this item to filter device information records by management type. You can specify one of the following values:
|
AgentVersion |
string |
Specify this item to filter device information records by agent version. |
DistributionRegDate |
dateTime |
Specify this item to filter device information records by distribution date and time. |
AgentDistributionStatus |
int |
Specify this item to filter device information records by agent distribution status. You can specify one of the following values:
|
AgentDistributionErrorType |
int |
Specify this item to filter device information records by error description provided after a failed agent distribution attempt. You can specify one of the following values:
|
AgentStatus |
int |
Specify this item to filter device information records by device management status. You can specify one of the following values:
|
DiscoverTime |
dateTime |
Specify this item to filter device information records by discovered date and time. |
AuthStatus |
int |
Specify this item to filter device information records by detailed device status. You can specify one of the following values:
|
NetworkStatus |
int |
Specify this item to filter device information records by connection status. You can specify one of the following values:
|
AgentDeviceStatus |
int |
Specify this item to filter device information records by device status. You can specify one of the following values:
|
DiscoveryProtocol |
int |
Specify this item to filter device information records by method used to collect device information from agentless devices. You can specify one of the following values:
|
Caption |
string |
Specify this item to filter device information records by OS name. |
AllMacAddress |
string |
Specify this item to filter device information records by all MAC addresses held by a device. This value must be in the xx:xx:xx:xx:xx:xx format or expressed as a string using the format xx-xx-xx-xx-xx-xx (where x represents a number in the range of 0-9 or a letter in the range of A-F or a-f). When using like or not like as the operator, remember to suffix the specified value with the wildcard character %. If the specified value exceeds the maximum length allowed, only those specified MAC addresses that fit within the allowed length become valid. |
InstallCompletionDate |
dateTime |
Specify this item to filter device information records by date and time when the distribution of the agent was completed. |
CSDVersion |
string |
Specify this item to filter device information records by OS Service Pack. |
IEVersion |
string |
Specify this item to filter device information records by Internet Explorer version. |
UnnecessaryServicecnt |
int |
Specify this item to filter device information records by number of Windows services prohibited by security policies. |
VideoTimeoutAC |
int |
Specify this item to filter device information records by time (units: seconds) to monitor shutdown (AC). |
VideoTimeoutDC |
int |
Specify this item to filter device information records by time (units: seconds) to monitor shutdown (DC). |
StandbyTimeoutAC |
int |
Specify this item to filter device information records by time (units: seconds) to entering system standby (AC). |
StandbyTimeoutDC |
int |
Specify this item to filter device information records by time (units: seconds) to entering system standby (DC). |
HibernateTimeoutAC |
int |
Specify this item to filter device information records by time (units: seconds) to entering system hibernation state (AC). |
HibernateTimeoutDC |
int |
Specify this item to filter device information records by time (units: seconds) to entering system hibernation state (DC). |
SpindownTimeoutAC |
int |
Specify this item to filter device information records by time (units: seconds) to hard disk shutdown (AC). |
SpindownTimeoutDC |
int |
Specify this item to filter device information records by time (units: seconds) to hard disk shutdown (DC). |
OsLanguage |
int |
Specify this item to filter device information records by OS language. You can specify one of the following values:
|
ProductID |
string |
Specify this item to filter device information records by agent model. |
PollingInterval |
int |
Specify this item to filter device information records by interval (units: seconds) at which an agent polls the management server. |
MngStatusUpdateTime |
dateTime |
Specify this item to filter device information records by date and time when the management status of devices was updated. |
AllIpAddress |
string |
Specify this item to filter device information records by all IP addresses held by the individual devices. This value must be expressed as a string by using the IPv4 format xxx.xxx.xxx.xxx (where xxx represents a number in the range of 0-255), or the IPv6 format xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx (x: one character from 0-9, A-F, or a-f). When using like or not like as the operator, remember to suffix the specified value with the wildcard character %. If the specified value exceeds the maximum length allowed, only those specified IP addresses that fit within the allowed length become valid. |
SnoozeDownloadStatus |
int |
Specify this item to filter device information records by package download delay status. You can specify one of the following values:
|
Domain |
string |
Specify this item to filter device information records by domain or work group. |
Manufacturer |
string |
Specify this item to filter device information records by device model or manufacturer. |
NodeNameInt |
int |
Specify this item to filter device information records by numeric-type host ID. |
UUID |
string |
Specify this item to filter device information records by UDID. |
PhoneNumber |
string |
Specify this item to filter device information records by contract phone number. |
IMEI |
string |
Specify this item to filter device information records by IMEI. |
RegistrationType |
int |
Specify this item to filter device information records by management type. You can specify one of the following values:
|
OsLastStartUpdateTime |
dateTime |
Specify this item to filter device information records by date and time when the OS was last started. |
InstallDate |
dateTime |
Specify this item to filter installed software information records by installation date. |
SourceKind |
int |
Specify this item to filter installed software information records by method used to collect software information. You can specify one of the following values:
|
InstallPath |
string |
Specify this item to filter installed software information records by installation folder. |
BgStatus |
int |
Specify this item to filter installed software information records by status that shows how software information is being processed internally. You can specify one of the following values:
|
SoftwareProductID |
string |
Specify this item to filter installed software information records by product ID. |
GUID |
int |
Specify this item to filter installed software information records by GUID. |
SoftwareName |
string |
Specify this item to filter installed software information records by software name. |
SoftwareVersion |
string |
Specify this item to filter installed software information records by version. |
SoftwarePublisher |
string |
Specify this item to filter installed software information records by manufacturer. |
SoftwareType |
int |
Specify this item to filter installed software information records by software information type. You can specify one of the following values:
|
RegistrationDate |
dateTime |
Specify this item to filter installed software information records by registration date and time. |
HelpLink |
string |
Specify this item to filter installed software information records by support information (URL). |
SoftwareCheck |
int |
Specify this item to filter installed software information records by check status. You can specify one of the following values:
|
ImportantSoft |
int |
Specify this item to filter installed software information records by whether the software in question is a Microsoft Office product. You can specify one of the following values:
|
AppType |
int |
Specify this item to filter installed software information records by application type. You can specify one of the following values:
|
MSProductType |
int |
Specify this item to filter installed software information records by purchasing status of Microsoft Office products. You can specify one of the following values:
|
MSProductId |
string |
Specify this item to filter installed software information records by Microsoft Office product ID. |
Data format for installed software information
Installed software information has the following data format:
{ "DeviceSoftwareList": [ { "DeviceSoftware": { "NodeID": "host-ID", "HostName": "host-name", "IPAddress": "IP-address", "MACAddress": "MAC-address", "CreateTime": "created-date-and-time", "LastUpdateTime": "last-updated-date-and-time", "LastAliveDate": "date-and-time-last-confirmed", "IPSubnet": "subnet-mask", "EquipmentType": "device-type", "EquipmentUserType": "device-type-name-added-by-the-administrator-user", "OsKind": "OS-type", "AMTFirmwareVersion": "AMT-firmware-version", "AgentType": "management-type", "AgentVertsion": "agent-version", "DistributionRegDate": "distribution-date-and-time", "AgentDistributionStatus": "agent-distribution-status", "AgentDistributionErrorType": "error-description-provided-after-failed-agent-distribution", "AgentStatus": "device-management-status", "DiscoverTime": "discovered-date-and-time", "AuthStatus": "detailed-device-status", "NetworkStatus": "connection-status", "AgentDeviceStatus": "device-status", "DiscoveryProtocol": "method-used-to-collect-device-information-from-agentless-devices", "Caption": "OS-name", "AllMacAddress": "all-MAC-addresses-held-by-a-device", "InstallCompletionDate": "date-and-time-when-the-distribution-of-the-agent-was-completed", "CSDVersion": "OS-Service-Pack", "IEVersion": "Internet Explorer version", "UnnecessaryServicecnt": "number-of-Windows-services-prohibited-by-security-policies", "VideoTimeoutAC": "time-(units:seconds)-to-monitor-shutdown-(AC)", "VideoTimeoutDC": "time-(units:seconds)-to-monitor-shutdown-(DC)", "StandbyTimeoutAC": "time-(units:seconds)-to-entering-system-standby-(AC)", "StandbyTimeoutDC": "time-(units:seconds)-to-entering-system-standby-(DC)", "HibernateTimeoutAC": "time-(units:seconds)-to-entering-system-hibernation-state-(AC)", "HibernateTimeoutDC": "time-(units:seconds)-to-entering-system-hibernation-state-(DC)", "SpindownTimeoutAC": "time-(units:seconds)-to-hard-disk-shutdown-(AC)", "SpindownTimeoutDC": "time-(units:seconds)-to-hard-disk-shutdown-(DC)", "OsLanguage": "OS-language", "ProductID": "agent-model", "PollingInterval": "interval-(units:seconds)-at-agent-polls-management-server", "MngStatusUpdateTime": "updated-date-and-time-management-status", "AllIpAddress": "all-IP-addresses-held-by-a-device", "SnoozeDownloadStatus": "package-download-delay-status", "Domain": "domain-or-work-group", "Manufacturer": "device-model-or-manufacturer", "NodeNameInt": "numeric-type-host-ID", "UUID": "UDID", "PhoneNumber": "contract-phone-number", "IMEI": "IMEI", "RegistrationType": "management-type", "OsLastStartUpdateTime": "date-and-time-when-OS-last-started", "SoftwareList": [ { "Software": { "InstallDate": "installation-date", "SourceKind": "method-used-to-collect-software-information", "InstallPath": "installation-folder", "BgStatus": "status-of-internally-processed-software-information", "SoftwareProductID": "product-ID", "GUID": "GUID", "SoftwareName": "software-name", "SoftwareVersion": "version", "SoftwarePublisher": "manufacturer", "SoftwareType": "software-information-type", "RegistrationDate": "registration-date-and-time", "HelpLink": "support-information-(URL)", "SoftwareCheck": "check-status", "ImportantSoft": "whether-the-software-is-a-Microsoft-Office-product", "AppType": "application-type", "MSProductType": "purchasing-type-of-Microsoft-Office-product", "MSProductId": "Microsoft-Office-product-ID" }, ... } ] }, ... } ], "offset": "start-position-of-the-installed-software-information-records", "responseCount": "number-of-acquired-installed-software-information-records", "totalCount": "total-number-of-installed-software-information-records-matching-the-specified-filters"} }
Legend: ...: Iterations of the previous layer
DeviceSoftwareList
Item name |
Data type |
Mandatory / Optional |
Description |
---|---|---|---|
DeviceSoftwareList |
Array |
Mandatory |
Root name of installed software information. This item stores arrays of DeviceSoftware objects. |
DeviceSoftware |
Object |
Mandatory |
Object name of an installed software information record. For details, see DeviceSoftware object. |
offset |
int |
Mandatory |
This item stores the start position of the device information records included in the current response data. |
responseCount |
int |
Mandatory |
This item stores the number of acquired device information records included in the current response data. To request the next set of device information records, calculate the sum of the offset value and the responseCount value, which must not exceed the totalCount value, and specify it for offset in the query string of the request. |
totalCount |
int |
Mandatory |
This item stores the total number of device information records matching the filters specified in the query string of the request. |
DeviceSoftware object
Although the SoftwareList array and the Software object are mandatory, all the other DeviceSoftware object items are optional.
Item name |
Data type |
Description |
---|---|---|
NodeID |
string |
This item stores a host ID. |
HostName |
string |
This item stores a host name. When an empty character is stored, this item appears as follows: "HostName": "" |
IPAddress |
string |
This item stores an IP (IPv4) address. When there are multiple IP addresses, the one that was used to send a notification to the management server is stored. When an empty character is stored, this item appears as follows: "IPAddress": "" |
MACAddress |
string |
This item stores a MAC address. When an empty character is stored, this item appears as follows: "MACAddress": "" |
CreateTime |
dateTime |
This item stores a created date and time. When an empty character is stored, this item appears as follows: "CreateTime": "" |
LastUpdateTime |
dateTime |
This item stores a last updated date and time. When an empty character is stored, this item appears as follows: "LastUpdateTime": "" |
LastAliveDate |
dateTime |
This item stores a date and time when a computer-to-management server connection was last confirmed. When an empty character is stored, this item appears as follows: "LastAliveDate": "" |
IPSubnet |
string |
This item stores the subnet mask corresponding to the IP address stored in IPAddress. When an empty character is stored, this item appears as follows: "IPSubnet": "" |
EquipmentType |
string |
This item stores a device type. Specifically, one of the following device types is stored:
|
EquipmentUserType |
string |
This item stores the name of the user definition optionally added by the administrator user. When an empty character is stored, this item appears as follows: "EquipmentUserType": "" |
OsKind |
int |
This item stores an OS type. Specifically, one of the following values is stored:
|
AMTFirmwareVersion |
string |
This item stores an AMT firmware version. When an empty character is stored, this item appears as follows: "AMTFirmwareVersion": "" |
AgentType |
int |
This item stores a management type. Specifically, one of the following values is stored:
|
AgentVersion |
string |
This item stores an agent version. When an empty character is stored, this item appears as follows: "AgentVersion": "" |
DistributionRegDate |
dateTime |
This item stores a distribution date and time. When an empty character is stored, this item appears as follows: "DistributionRegDate": "" |
AgentDistributionStatus |
int |
This item stores an agent distribution status. Specifically, one of the following values is stored:
|
AgentDistributionErrorType |
int |
This item stores an error description provided after a failed agent distribution attempt. Specifically, one of the following values is stored:
|
AgentStatus |
int |
This item stores a device management status. Specifically, one of the following values is stored:
|
DiscoverTime |
dateTime |
This item stores a discovered date and time. When an empty character is stored, this item appears as follows: "DiscoverTime": "" |
AuthStatus |
int |
This item stores a detailed device status. Specifically, one of the following values is stored:
|
NetworkStatus |
int |
This item stores a connection status. Specifically, one of the following values is stored:
|
AgentDeviceStatus |
int |
This item stores a device status. Specifically, one of the following values is stored:
|
DiscoveryProtocol |
int |
This item stores a method used to collect device information from agentless devices. Specifically, one of the following values is stored:
|
Caption |
string |
This item stores an OS name. When an empty character is stored, this item appears as follows: "Caption": "" |
AllMacAddress |
string |
This item stores all MAC addresses held by a device. The MAC addresses that are stored are represented by the following rules:
When an empty character is stored, this item appears as follows: "AllMacAddress": "" |
InstallCompletionDate |
dateTime |
This item stores a date and time when the distribution of the agent was completed. When an empty character is stored, this item appears as follows: "InstallCompletionDate": "" |
CSDVersion |
string |
This item stores an OS Service Pack. When an empty character is stored, this item appears as follows: "CSDVersion": "" |
IEVersion |
string |
This item stores an Internet Explorer version. When an empty character is stored, this item appears as follows: "IEVersion": "" |
UnnecessaryServicecnt |
int |
This item stores a number of Windows services prohibited by security policies. |
VideoTimeoutAC |
int |
This item stores a time (units: seconds) to monitor shutdown (AC). |
VideoTimeoutDC |
int |
This item stores a time (units: seconds) to monitor shutdown (DC). |
StandbyTimeoutAC |
int |
This item stores a time (units: seconds) to entering system standby (AC). |
StandbyTimeoutDC |
int |
This item stores a time (units: seconds) to entering system standby (DC). |
HibernateTimeoutAC |
int |
This item stores a time (units: seconds) to entering system hibernation state (AC). |
HibernateTimeoutDC |
int |
This item stores a time (units: seconds) to entering system hibernation state (DC). |
SpindownTimeoutAC |
int |
This item stores a time (units: seconds) to hard disk shutdown (AC). |
SpindownTimeoutDC |
int |
This item stores a time (units: seconds) to hard disk shutdown (DC). |
OsLanguage |
int |
This item stores an OS language. Specifically, one of the following values is stored:
|
ProductID |
string |
This item stores an agent model. When an empty character is stored, this item appears as follows: "ProductID": "" |
PollingInterval |
int |
This item stores an interval (units: seconds) at which an agent polls the management server. |
MngStatusUpdateTime |
dateTime |
This item stores a date and time when the management status of devices was updated. When an empty character is stored, this item appears as follows: "MngStatusUpdateTime": "" |
AllIpAddress |
string |
This item stores all IP addresses (IPv4 and IPv6) held by a device. The IP addresses that are stored are represented by the following rules:
|
SnoozeDownloadStatus |
int |
This item stores a package download delay status. Specifically, one of the following values is stored:
|
Domain |
string |
This item stores a domain or work group. When an empty character is stored, this item appears as follows: "Domain": "" |
Manufacturer |
string |
This item stores a device model or manufacturer. When an empty character is stored, this item appears as follows: "Manufacturer": "" |
NodeNameInt |
int |
This item stores a numeric-type host ID. |
UUID |
string |
This item stores a UDID. When an empty character is stored, this item appears as follows: "UUID": "" |
PhoneNumber |
string |
This item stores a contract phone number. When an empty character is stored, this item appears as follows: "PhoneNumber": "" |
IMEI |
string |
This item stores a IMEI. When an empty character is stored, this item appears as follows: "IMEI": "" |
RegistrationType |
int |
This item stores a management type. Specifically, one of the following values is stored:
|
OsLastStartUpdateTime |
dateTime |
This item stores a date and time when the OS was last started. When an empty character is stored, this item appears as follows: "OsLastStartUpdateTime": "" |
SoftwareList |
Array |
This item stores arrays of Software objects that represent the individual installed software information records. This item is mandatory. |
Software |
Object |
This item stores an object name of each installed software information record. For details, see Software object. This item is mandatory. |
Software object
All Software object items are optional.
Item name |
Data type |
Description |
---|---|---|
InstallDate |
dateTime |
This item stores an installation date. When an empty character is stored, this item appears as follows: "InstallDate": "" |
SourceKind |
int |
This item stores the method used to collect software information. Specifically, one of the following values is stored:
|
InstallPath |
string |
This item stores an installation folder. When an empty character is stored, this item appears as follows: "InstallPath": "" |
BgStatus |
int |
This item stores the status that shows how software information is being processed internally. Specifically, one of the following values is stored:
|
SoftwareProductID |
string |
This item stores a product ID. When an empty character is stored, this item appears as follows: "SoftwareProductID": "" |
GUID |
int |
This item stores a GUID. |
SoftwareName |
string |
This item stores a software name. |
SoftwareVersion |
string |
This item stores a version. When an empty character is stored, this item appears as follows: "SoftwareVersion": "" |
SoftwarePublisher |
string |
This item stores a manufacturer. When an empty character is stored, this item appears as follows: "SoftwarePublisher": "" |
SoftwareType |
int |
This item stores a software information type. Specifically, one of the following values is stored:
|
RegistrationDate |
dateTime |
This item stores a registration date and time. |
HelpLink |
string |
This item stores support information (URL). |
SoftwareCheck |
int |
This item stores s check status. Specifically, one of the following values is stored:
|
ImportantSoft |
int |
This item stores information regarding whether the software in question is a Microsoft Office product. Specifically, one of the following values is stored:
|
AppType |
int |
This item stores an application type. Specifically, one of the following values is stored:
|
MSProductType |
int |
This item stores the purchasing status of Microsoft Office products. "-1" is stored if no value is specified. Specifically, one of the following values is stored:
When an empty character is stored, this item appears as follows: "MSProductType": "" |
MSProductId |
string |
This item stores the product ID of the Microsoft Office product. Specifically, the product ID of the volume license version is stored, with the last five digits of the ID masked with asterisks (*). When no product ID exists, or when the purchasing status is something other than the volume license version, an empty character is stored. When an empty character is stored, this item appears as follows: "MSProductId": "" |
#: The software in this status is regarded as deleted software and does not show up in the management window.