Saltar al contenido
Referencia de API
/
/
/
Agregar grupo

Agregar grupo

Request

Crea un grupo de perfiles.

  • Requisitos previos: el nombre no puede estar vacío, admite como máximo 100 caracteres y no puede estar ya en uso por otro grupo del equipo. Un equipo está limitado a 1000 grupos.
  • Efecto: crea el grupo. Cuando el equipo autoriza el acceso por grupo y quien llama no es el propietario, también se le concede acceso al grupo nuevo.
  • Finalización: sincrónica; data lleva el identificador del grupo nuevo.
  • Reintentos: un nombre duplicado se rechaza en lugar de reutilizar el grupo existente, así que un reintento tras una llamada que tuvo éxito pero cuya respuesta no viste falla con un error de nombre duplicado; eso es señal de que la primera llamada funcionó. Confírmalo con /envgroup/page.
Bodyapplication/json
groupNamestringrequired

Nombre del grupo

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

Correcto. data es un objeto con los campos id y groupName.

Headers
any
Bodyapplication/json
codeintegerrequired

Código de resultado devuelto 0: Normal. Los demás códigos son excepciones.

msgstring or nullrequired

Mensaje de error

dataobjectrequired

Los datos devueltos por la operación

requestIdstringrequired

ID de solicitud de operación

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