Update Components by Stations

Request Parameter

Parameter

Description

Mandatory

id

Station identifier.

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

yes

 

Request Example

https://192.168.1.1:9081/api/stations/update-components.ds?id=d071625c-d21d-b211-9bc4-bc02713bf843

XML and JSON response structure examples are described below.

 

XML Response Structure

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

 

Description of XML Response Parameters

The <stations/> element contains information on components update start on stations specified in a request.

The <stations /> element attribute:

Attribute

Description

total

Total number of stations in a response

The <station /> element contains information on components update start on a specific station.

The <station /> element attributes:

Attribute

Description

id

Station identifier

status

Status of components update start:

delayed—update is delayed,

failed—update start failed,

initiated—update is initiated.

 

JSON Response Structure

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

    "timestamp": 1582030585,

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

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

       "version": "12.00.0.201909260",
       "uuid": "eae1a652-96d5-48fd-9169-4788a03688b8"}},

 "data": {
    "total": 1,

    "list": {
       "d071625c-d21d-b211-9bc4-bc02713bf843": "initiated"}}}

 

Description of JSON Response Parameters

The data block contains information on components update start on stations specified in a request.

The data block elements:

Field name

Description

total

Total number of stations in a response

list

Block with results of components update start for each station

The list block elements:

Field name

Description

Station ID

Status of components update start:

delayed—update is delayed,

failed—update start failed,

initiated—update is initiated.