Перейти к содержимому
Справочник API
/
/
/
Добавить группу

Добавить группу

Request

Создаёт группу профилей.

  • Предварительные условия: имя не должно быть пустым, должно быть не длиннее 100 символов и не должно уже использоваться другой группой в команде. Команда ограничена 1000 группами.
  • Эффект: создаёт группу. Если команда выдаёт доступ по группам, а вызывающий не является владельцем, ему также выдаётся доступ к новой группе.
  • Завершение: синхронное; data содержит идентификатор новой группы.
  • Повтор: дублирующее имя отклоняется, а не приводит к повторному использованию существующей группы, поэтому повтор после успешного вызова, ответ на который вы не увидели, завершится ошибкой о дублировании имени — это признак того, что первый вызов сработал. Подтвердите через /envgroup/page.
Bodyapplication/json
groupNamestringrequired

Название группы

POST
/api/envgroup/create
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/create \
  -H 'Content-Type: application/json' \
  -d '{
    "groupName": "Group-333"
  }'

Responses

Успех. data — объект с полями id и groupName.

Headers
any
Bodyapplication/json
codeintegerrequired

Возвращаемый код результата 0: Нормальный. Остальные коды являются исключениями.

msgstring or nullrequired

Сообщение об ошибке

dataobjectrequired

Данные, полученные в результате операции.

requestIdstringrequired

Идентификатор запроса на операцию

Response
{
  "code": 0,
  "msg": null,
  "data": {
    "id": "1673823102599682",
    "groupName": "example-name"
  },
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}