Update Components on Stations of a Group

Request Parameters

Parameter

Description

Obligatory

id

Group identifier.

This parameter can be defined in the request several times to update components on stations of several groups at a time.

yes

 

Request Example

http://192.168.1.1:9080/api/groups/update-components.ds?id=123123123

XML and JSON response structure examples are described below.

 

XML Response

<drweb-es-api api_version="4.3.0" timestamp="1558521923" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <stations total="3">
     <station id="d071625c-d21d-b211-9bc4-bc02713bf843" status="delayed"/>

     <station id="70200e02-d21d-b211-8a39-a00ca2f8be36" status="delayed"/>

     <station id="e8702ab1-a176-4aef-8660-f01851fcae80" status="initiated"/>
  </stations>
</drweb-es-api>

 

Description of XML Response Parameters

The <stations /> element contains information on update process launch at a group's stations.

The <stations /> element attribute:

Attribute

Description

total

Total number of stations on which update has been launched

The <station /> element contains information on specific stations on which components update has been launched.

The <station /> element attributes:

Attribute

Description

id

Station identifier

status

The state of update process. Can take the following values:

delayed—update is delayed,

failed—update is failed,

initiated—update is initiated.

 

JSON Response

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

    "timestamp": 1558522006,

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

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

      "version": "12.00.0.201909260",
      "uuid": "27671337-e0b0-4f60-aeb0-ab1f2ca47f77"}},

"data": {
    "total": 3,

    "list": {
      "d071625c-d21d-b211-9bc4-bc02713bf843": "delayed",

      "70200e02-d21d-b211-8a39-a00ca2f8be36": "delayed",
      "e8702ab1-a176-4aef-8660-f01851fcae80": "initiated"}}}

 

Description of JSON Response Parameters

The data contains information on all stations on which components update has been launched.

The data block elements:

Field name

Description

total

Total number of stations on which components update has been launched

The list block contains information on specific stations on which components update has been launched.

The list block elements:

Field name

Description

Identifier of a station on which components update has been launched

The state of update process. Can take the following values:

delayed—update is delayed,

failed—update is failed,

initiated—update is initiated.