API de Role

Vision General

La API de Role es para gestionar roles de Fess. Puede operar creacion, actualizacion y eliminacion de roles.

URL Base

/api/admin/role

Lista de Endpoints

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

Obtener Lista de Roles

Solicitud

GET /api/admin/role/settings
PUT /api/admin/role/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": "role_id_1",
        "name": "admin"
      },
      {
        "id": "role_id_2",
        "name": "user"
      }
    ],
    "total": 5
  }
}

Obtener Rol

Solicitud

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

Respuesta

{
  "response": {
    "status": 0,
    "setting": {
      "id": "role_id_1",
      "name": "admin"
    }
  }
}

Crear Rol

Solicitud

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

Cuerpo de la Solicitud

{
  "name": "editor"
}

Descripcion de Campos

Campo Requerido Descripcion
name Si Nombre del rol

Respuesta

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

Actualizar Rol

Solicitud

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

Cuerpo de la Solicitud

{
  "id": "existing_role_id",
  "name": "editor_updated",
  "versionNo": 1
}

Respuesta

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

Eliminar Rol

Solicitud

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

Respuesta

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

Ejemplos de Uso

Crear Nuevo Rol

curl -X POST "http://localhost:8080/api/admin/role/setting" \
     -H "Authorization: Bearer YOUR_TOKEN" \
     -H "Content-Type: application/json" \
     -d '{
       "name": "content_manager"
     }'

Obtener Lista de Roles

curl -X GET "http://localhost:8080/api/admin/role/settings?size=50" \
     -H "Authorization: Bearer YOUR_TOKEN"

Informacion de Referencia