Перейти до вмісту
Довідник 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"
}