4.3.3. ProjectSettingsChange

Описание

Метод позволяет изменить настройки существующего проекта.

Запрос

{
  "user_id":(number),
  "methods":[
    {
      "method":"ProjectSettingsChange",
      "params":{
        "project_id":(number),
        "name":(string),
        "default_view":(string),
        "report_settings":{
          "generate_report":(boolean),
          "format":(string),
          "store_template":(boolean)
        },
        "restart_settings":{
          "restart":(boolean),
          "attempts_number":(number)
        }
      }
    }
  ]
}

где:

• user_id — целое число, идентификатор пользователя;

• project_id — целое число, идентификатор проекта пользователя;

• name — строка, название проекта;

• default_view — строка, вид, который будет отображаться при открытии проекта в браузере. Список видов: dashboard (по умолчанию), templates, probes_view;

• generate_report — логический тип, управляет автоматической генерацией отчета в выбранном формате по завершении задачи;

• format — строка, формат отчета для завершенных задач. Список форматов: PDF (по умолчанию), CSV, JSON;

• store_template — логический тип, отвечает за сохранение шаблона в ZIP-архиве вместе с отчетом;

• restart — логический тип, отвечает за повторный запуск задачи со статусом Stalled указанное количество раз. Более подробно о статусе Stalled можно ознакомиться в методе TaskStatus;

• attempts_number — целое число, указывает количество повторных запусков задачи со статусом Stalled. Ключ может принимать значение от 1 до 10, значение по умолчанию — 3.

Ответ

{
  "reply":[
    {
      "method":"ProjectSettingsChange",
      "result":[
        {
          "name":(string),
          "settings":{
            "default_view":(string),
            "report_settings":{
              "generate_report":(boolean),
              "format":(string),
              "store_template":(boolean)
            },
            "restart_settings":{
              "restart":(boolean),
              "attempts_number":(number)
            }
          }
        }
      ]
    }
  ]
}

где:

• name — строка, название проекта;

• default_view — строка, вид, который будет отображаться при открытии проекта в браузере;

• generate_report — логический тип, управляет автоматической генерацией отчета в выбранном формате по завершении задачи;

• format — строка, формат отчета для завершенных задач;

• store_template — логический тип, отвечает за сохранение шаблона в ZIP-архиве вместе с отчетом;

• restart — логический тип, отвечает за повторный запуск задачи со статусом Stalled указанное количество раз;

• attempts_number — целое число, указывает количество повторных запусков задачи со статусом Stalled.

Пример

Запрос утилитой cURL

Запрос Изменений настроек в проекте
curl http://172.16.1.41/ctrl_api/v1/json \
 -H "Content-Type: application/json" \
 --data '{"user_id":1,"methods":[{"method":"ProjectSettingsChange","params":{"project_id":2,"name":"NewNameAPI","default_view":"templates","report_settings":{"generate_report":true,"format":"JSON","store_template":true},"restart_settings":{"restart":true,"attempts_number":1}}}]}'

Ответ на запрос

 {
   "reply":[
     {
       "method":"ProjectSettingsChange",
       "result":{
         "name":"NewNameAPI",
         "settings":{
           "default_view":"templates",
           "report_settings":{
             "generate_report":true,
             "format":"JSON",
             "store_template":true
           },
           "restart_settings":{
             "restart":true,
             "attempts_number":1
           }
         }
       }
     }
   ]
 }