API de Group

Vision General

La API de Group es para gestionar grupos de Fess. Puede operar creacion, actualizacion y eliminacion de grupos.

URL Base

/api/admin/group

Lista de Endpoints

Metodo Ruta Descripcion
GET/PUT /settings Obtener lista de grupos
GET /setting/{id} Obtener grupo
POST /setting Crear grupo
PUT /setting Actualizar grupo
DELETE /setting/{id} Eliminar grupo

Obtener Lista de Grupos

Solicitud

GET /api/admin/group/settings
PUT /api/admin/group/settings

Parametros

Parametro Tipo Requerido Descripcion
size Integer No Numero de elementos por pagina (predeterminado: 20)
page Integer No Numero de pagina (comienza en 0)

Respuesta

{
  "response": {
    "status": 0,
    "settings": [
      {
        "id": "group_id_1",
        "name": "Engineering",
        "gidNumber": 1000
      },
      {
        "id": "group_id_2",
        "name": "Sales",
        "gidNumber": 1001
      }
    ],
    "total": 5
  }
}

Obtener Grupo

Solicitud

GET /api/admin/group/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "group_id_1",
      "name": "Engineering",
      "gidNumber": 1000
    }
  }
}

Crear Grupo

Solicitud

POST /api/admin/group/setting
Content-Type: application/json

Cuerpo de la Solicitud

{
  "name": "Marketing",
  "gidNumber": 1002
}

Descripcion de Campos

Campo Requerido Descripcion
name Si Nombre del grupo
gidNumber No Numero de ID del grupo

Respuesta

{
  "response": {
    "status": 0,
    "id": "new_group_id",
    "created": true
  }
}

Actualizar Grupo

Solicitud

PUT /api/admin/group/setting
Content-Type: application/json

Cuerpo de la Solicitud

{
  "id": "existing_group_id",
  "name": "Marketing Team",
  "gidNumber": 1002,
  "versionNo": 1
}

Respuesta

{
  "response": {
    "status": 0,
    "id": "existing_group_id",
    "created": false
  }
}

Eliminar Grupo

Solicitud

DELETE /api/admin/group/setting/{id}

Respuesta

{
  "response": {
    "status": 0,
    "id": "deleted_group_id",
    "created": false
  }
}

Ejemplos de Uso

Crear Nuevo Grupo

curl -X POST "http://localhost:8080/api/admin/group/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "Product Team",
       "gidNumber": 2000
     }'

Obtener Lista de Grupos

curl -X GET "http://localhost:8080/api/admin/group/settings" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informacion de Referencia