Переименование проекта

Данная операция позволяет пользователям переименовывать проект, а также задать ему новое описание. Операция доступна только для владельцев проекта и администраторов и не может быть отменена.

URL

/project/rename

Метод

POST

Диапазон

project_edit

Тип ответа

sync

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

<отсутствуют>

Тело запроса (application/json)

{
  "prjUUID": "322cf2c1-d054-4963-a0e0-f5b189906308",
  "name": "New name of the report",
  "description": "This is a project description"
}

prjUUID должен быть действительным ID веб-отчета.

Поле name должно содержать новое имя проекта. Поле description используется для того, чтобы задать описание проекта. Необходимо указать как минимум один из параметров. Если присутствует только поле description, проект не будет переименован, изменится только его описание.

Пример URL-запроса

https://your.polyanalyst.server:port/polyanalyst/api/v1.0/project/rename

Тело ответа (application/json)

<отсутствует>

Примеры ответов

Код Тело ответа и его описание

200

Проект был успешно переименован. Тело ответа пустое.

400

Ошибка – должен быть указан параметр "name" или "description".

{
  "error": {
    "code": 400,
    "title": "",
    "message": "One of 'name' or 'description' parameters must be specified"
  }
}

403

Ошибка – доступ запрещен (пользователь не является владельцем отчета или администратором).

{
  "error": {
    "code": 403,
    "title": "",
    "message": "Access to this operation is limited to report owners and administrators"
  }
}

403

Ошибка – проект с указанным именем уже существует.

{
  "error": {
    "code": 403,
    "title": "",
    "message": "Project with name My name already exist"
  }
}

500

Ошибка – prjUUID не является проектом (например, указан ID веб-отчета, а не проекта).

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Item dbcbe4bc-c41b-4b0a-ba37-ca0a37855a1f is not a project"
  }
}

500

Ошибка – проект с указанным ID не найден.

{
  "error": {
    "code": 500,
    "title": "",
    "message": "Project 322cf2c1-d054-4963-a0e0-f5b189906301 not found"
  }
}