Get Installing Components List for a Group

Request Parameters

Parameter

Description

Obligatory

Group identifier.

This parameter can be defined in the request several times to get installing components lists for several groups at a time.

yes

If the group contains stations operating under Windows OS the response document will include the list of components to be installed on these stations. Otherwise the list will be empty.

Request Example

http://192.168.1.1:9080/api/groups/components.ds?id=gr1

XML and JSON response structure examples are described below.

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1551789582" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
<groups total="1">
<group id="gr1">
<components total="12" 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 <groups /> element contains information on all requested groups.

The <groups /> element attribute:

Attribute	Description
total	Total number of station groups information on which is displayed in response

•The <group /> element contains information on a specific group of stations.

The <group /> element attribute:

Attribute	Description
id	Group identifier

▫The <components /> element contains information on all installing components of a specific group of stations.

The <components /> element attributes:

Attribute	Description
total	Total number of all components
inherited	If its value is set to true, then components are inherited from a parent group, and if set to false—then component parameters are configured individually.
inherited_group_id	ID of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
inherited_group_name	Name of a parent group from which component parameters have been inherited. If the inherited attribute is false, than the value of this attribute will be none.

•The <component /> contains information about a specific installing component.

The <component /> element attributes:

Attribute

Description

code

Digital code of the component (see the Component codes section)

name

Name of the component (see the Component codes section)

status

Component status. Can take the following values:

2—the component must be installed,

1—the component can be installed

0—the component must not be installed.

JSON Response Structure

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

"timestamp": 1550514156,

"api": {
"version": 40300,
"versionString": 4.3.0},

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

"version": "12.00.0.201909260",
"uuid": "70c5f522-aaab-4c93-a180-a442a0da9c2a"}},

"data": {
"total": 1,

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

{"code": 14,
"name": "SpIDer Mail for Windows workstations",
"status": 1},

{"code": 38,
"name": "SpIDer Gate for Windows workstations",
"status": 1},

{"code": 54,
"name": "Dr.Web Office Control",
"status": 1},

{"code": 55,
"name": "Dr.Web Antispam",
"status": 1},

{"code": 57,
"name": "SpIDer Guard for Windows workstations",
"status": 1},

{"code": 58,
"name": "SpIDer Guard for Windows servers",
"status": 1},

{"code": 103,
"name": "Dr.Web plug-in for MS Outlook",
"status": 1},

{"code": 105,
"name": "Dr.Web Firewall",
"status": 1},

{"code": 30,
"name": "Dr.Web Agent for Windows",
"status": 2},

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

{"code": 39,
"name": "Dr.Web Agent for UNIX",
"status": 2}],

"group_id": "gr1",

"inherited": true,

"inherited_group_id": "20e27d73-d21d-b211-a788-85419c46f0e6",
"inherited_group_name": "Everyone"}]}}

Description of JSON Response Parameters

The data block contains information on stations.

The data block elements:

Field name	Description
total	Total number of station groups information on which is displayed in response

•The list array contains information on specific stations.

Elements in the list array:

Field name	Description
group_id	Group identifier
inherited	If its value is set to true, then components are inherited from a parent group, and if set to false—then component parameters are configured individually.
inherited_group_id	ID of a parent group from which component parameters have been inherited. If the inherited attribute is set to false, then this attribute value will be none.
inherited_group_name	Name of a parent group from which component parameters have been inherited. If the inherited attribute is false, than the value of this attribute will be none.

▫The components array contains information about a specific installing component.

Elements in the components array:

Field name

Description

code

Digital code of the component (see the Component codes section)

name

Name of the component (see the Component codes section)

status

Component status. Can take the following values:

2—the component must be installed,

1—the component can be installed

0—the component must not be installed.