Выполнение задания

Параметры запроса

Параметр

Описание

Допустимые значения

Обязательный

action

Действие над станцией-новичком

•approve — подтвердить доступ станции к Серверу,

•cancelonconnect — отменить действие, заданное для выполнения при следующем подключении станции к Серверу,

•reject — отклонить станцию

нет

group

Группа, в которую добавляется станция-новичок

–

нет

id

Идентификатор станции-новичка

–

нет

task-id

Идентификатор задания

•newbies — задать действие над станцией-новичком,

•update_repositories — запустить обновление репозитория Сервера

да

 

Параметры action, group и id задаются только при значении параметра task-id=newbies.

Если параметр action имеет значение approve, то использование параметра group обязательно.

 

Примеры запросов

1.Для task-id=newbies:

http://192.168.1.1:9080/api/server/task.ds?task-id=newbies&action=approve&group=_notfound_&id=001

http://192.168.1.1:9080/api/server/tasks.ds?task-id=newbies&action=approve&group=_notfound_&id=001

2.Для task-id=update_repositories:

http://192.168.1.1:9080/api/server/task.ds?task-id=update_repositories

http://192.168.1.1:9080/api/server/tasks.ds?task-id=update_repositories

Если обновление репозитория Сервера уже было запущено, то на запрос task-id=update_repositories придет ответ со статусом success.

Ниже представлены примеры ответов в формате XML и в формате JSON.

 

Ответ в формате XML

1.Для task-id=newbies:

<drweb-es-api api_version="4.3.0" timestamp="1558521889" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <task id="newbies" status="failed" message="Group is not found"/>
</drweb-es-api>

2.Для task-id=update_repositories:

<drweb-es-api api_version="4.3.0" timestamp="1558521889" server="192.168.1.1" srv_version="12.00.0.201909260" status="true">
  <task id="update_repositories" status="failed" message="Not enough privileges to perform the operation"/>
</drweb-es-api>

 

Описание параметров ответного XML

Элемент <task /> содержит информацию о запрошенном задании.

Атрибуты элемента <task />:

Атрибут

Описание

id

Идентификатор задания. Может принимать значения:

•newbies — задание действия над станцией-новичком,

•update_repositories — задание на обновление репозитория Сервера.

status

Статус выполнения задания:

•success — задание выполнено успешно,

•failed — задание не выполнено.

message

Сообщение об ошибке при выполнении задания. В случае успешного выполнения задания атрибут message содержит пустую строку сообщения.

 

Ответ в формате JSON

1.Для task-id=newbies:

{ "head": {
    "status": true,
    "timestamp": 1558522034,

    "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": {
    "task": {
      "id": "newbies",

      "message": "Group is not found",
      "status": "failed"}}}

2.Для task-id=update_repositories:

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

    "timestamp": 1558522034,

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

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

      "version": "12.00.0.201909260",
      "uuid": "1023dcd7-d11d-b211-896d-8804c0842edb"}},

"data": {
    "task": {
      "id": "update_repositories",

      "message": "Not enough privileges to perform the operation",
      "status": "failed"}}}

 

Описание параметров ответного JSON

Блок task содержит информацию о запрошенном задании.

Элементы блока task:

Название поля

Описание

id

Идентификатор задания. Может принимать значения:

•newbies — задание действия над станцией-новичком,

•update_repositories — задание на обновление репозитория Сервера.

message

Сообщение об ошибке при выполнении задания. В случае успешного выполнения задания элемент message содержит пустую строку сообщения.

status

Статус выполнения задания:

•success — задание выполнено успешно,

•failed — задание не выполнено.