Get a List of Components to Install

Request Parameter

Parameter

Description

Mandatory

Station ID.

This parameter can be repeated any number of times per request to obtain the lists of components to install for multiple stations at a time.

yes

The response document for stations running Windows operating system will contain a list of components to install, while the list for other stations will be empty.

Request Example

https://192.168.1.1:9081/api/stations/components.ds?id=1001&id=1002

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1589406721" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">
<stations total="2">
<station id="1001">
<components total="11" inherited="true" inherited_group_id="20e27d73-d21d-b211-a788-85419c46f0e6" inherited_group_name="Everyone">
<component code="4" name="Dr.Web Scanner for Windows" status="1"/>

Description of XML Response Parameters

The <stations /> element contains a list of components to install on stations specified in the request.

The <stations /> element attribute:

Attribute	Description
total	Total number of stations in a response

•The <station /> element contains information about a specific station.

The <station /> element attribute:

Attribute	Description
id	Station ID

▫The <components /> element contains information about all components to install on a station.

The <components /> element attributes:

Attribute	Description
total	Total number of components to install on a station
inherited	If the value is true, it means that the components were inherited from a parent group, and if false—it means that the component parameters were configured individually.
inherited_group_id	ID of a parent group from which component parameters have been inherited. If the inherited attribute is false, this attribute’s value will be empty.
inherited_group_name	Name of a parent group from which the component parameters have been inherited. If the inherited attribute is false, this attribute’s value will be empty.

•The <component /> element contains parameters of a specific component to install.

The <component /> element attributes:

Attribute

Description

code

Digital code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

status

Component status:

2—the component must be installed,

1—the component can be installed,

0—the component does not need to be installed.

JSON Response Structure

{ "head": {
"status": true,

"timestamp": 1589406940,

"api": {
"version": 40302,
"versionString": "4.3.2"},

"server": {
"name": "192.168.1.1",

"version": "13.00.1.202310121",
"uuid": "b35d999d-9212-481d-af8c-8551c4113383"}},

"data": {
"total": 2,

"list": [
{"components": [
{"code": 4,
"name": "Dr.Web Scanner for Windows",
"status": 1},

...,

{"code": 37,
"name": "Dr.Web Agent Scanner for Windows",
"status": 2}],

"inherited": true,

"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"inherited_group_name": "Everyone",
"station_id": "1001"},

{"components": [
{"code": 4,
"name": "Dr.Web Scanner for Windows",
"status": 1},

...,

{"code": 37,
"name": Dr.Web Agent Scanner for Windows",
"status": 2}],

"inherited": true,

"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",

"inherited_group_name": "Everyone",
"station_id": "1002"}]}}

Description of JSON Response Parameters

The data block contains a list of components to install on stations specified in the request.

The data block elements:

Field name	Description
total	Total number of stations in a response
list	Array with information about all components to install for each station

•Elements in the list array:

Field name	Description
components	Array with parameters for each component to install for a specific station
inherited	If the value is true, it means that the components were inherited from a parent group, and if false—it means that the component parameters were configured individually.
inherited_group_id	ID of a parent group from which component parameters have been inherited. This element will not be present as long as the inherited element is false.
inherited_group_name	Name of a parent group from which the component parameters have been inherited. This element will not be present as long as the inherited element is false.
station_id	Station ID

▫Elements in the components array:

Field name

Description

code

Digital code of a component (see Appendix B2. Component Codes)

name

Name of a component (see Appendix B2. Component Codes)

status

Component status:

2—the component must be installed,

1—the component can be installed,

0—the component does not need to be installed.