Get a List of Components to Install for a Group

Request Parameter

Parameter

Description

Mandatory

id

Group ID.

This parameter can be repeated any number of times per request to get a list of components to install for multiple groups at a time.

yes

If a group contains stations running Windows operating system, the response document will include a list of components to be installed on these stations. Otherwise, the list will be empty.

Request Example

https://192.168.1.1:9081/api/groups/components.ds?id=7ec98a70-5c83-11ea-512f-70a167e08535

XML and JSON response structure examples are described below.

XML Response Structure

<drweb-es-api api_version="4.3.2" timestamp="1581789582" server="192.168.1.1" srv_version="13.00.1.202310121" status="true">

  <groups total="1">

    <group id="7ec98a70-5c83-11ea-512f-70a167e08535">

        <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" />

          <component code="14" name="SpIDer Mail for Windows workstations" status="1" />

          <component code="38" name="SpIDer Gate for Windows workstations" status="1" />

          <component code="54" name="Dr.Web Office Control" status="1" />

          <component code="55" name="Dr.Web Antispam" status="1" />

          <component code="57" name="SpIDer Guard for Windows workstations" status="1" />

          <component code="58" name="SpIDer Guard for Windows servers" status="1" />

          <component code="103" name="Dr.Web plug-in for MS Outlook" status="1" />

          <component code="105" name="Dr.Web Firewall" status="1" />

          <component code="30" name="Dr.Web Agent for Windows" status="2" />

          <component code="37" name="Dr.Web Agent Scanner for Windows" status="2" />

          <component code="39" name="Dr.Web Agent for UNIX" status="2" />

        </components>

    </group>

  </groups>

</drweb-es-api>

Description of XML Response Parameters

The <groups /> element contains information about all components to install for groups specified in the request.

The <groups /> element attribute:

Attribute

Description

total

Total number of groups in a response

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

The <group /> element attribute:

Attribute

Description

id

Group ID

▫The <components /> element contains information about components to install for a specific group.

The <components /> element attributes:

Attribute

Description

total

Total number of components to install

inherited

If the value is true, it means that components were inherited from a parent group, and if false—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 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": 1580514156,

    "api": {

      "version": 40302,

      "versionString": "4.3.2"},

    "server": {

      "name": "192.168.1.1",

      "version": "13.00.1.202310121",

      "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": "7ec98a70-5c83-11ea-512f-70a167e08535",

      "inherited": true,

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

      "inherited_group_name": "Everyone"}]}}

Description of JSON Response Parameters

The data block contains information about all components to install for groups specified in the request.

The data block elements:

Field name

Description

total

Total number of groups in a response

list

Array with information about components to install for each group

•Every object in the list array contains information about components to install for a specific group.

Elements in the list array:

Field name

Description

components

Array with parameters for each component to install for a specific group

group_id

Group ID

inherited

If the value is true, it means that components were inherited from a parent group, and if false—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 component parameters have been inherited.

This element will not be present as long as the inherited element is false.

▫Every object in the components array contains information about a specific component to install.

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.