Changes between Version 5 and Version 6 of ApiRest


Ignore:
Timestamp:
Apr 8, 2016, 10:37:13 AM (8 years ago)
Author:
ramon
Comment:

Actualización de la definición del API REST

Legend:

Unmodified
Added
Removed
Modified

  • ApiRest

    v5 v6  
    6666Nota: Las rutas que se indican son relativas a la URL de la API REST y los identificadores variables se preceden del carácter "{{{:}}}".
    6767
     68==== Rutas generales ====
     69
    6870 - {{{/login}}}
    6971   - Autenticación de usuario.
    … …  
    9294     - {{{description}}} (cadena): descripción de la UO.
    9395
    94  - {{{/ous/:id1/rooms}}}
     96 - {{{/ous/:id1/labs}}}
    9597   - Listar las aulas definidas en la UO ''id1''.
    9698   - Método: GET.
    9799   - Deveulve:
    98100     - {{{ouid}}} (entero): identificador de la UO.
    99      - {{{rooms}}} (array): datos de las aulas definidas, compuesta por:
    100        - {{{roomid}}} (entero): identificador del aula.
    101        - {{{roomname}}} (cadena): nombre del aula.
    102 
    103  - {{{/ous/:id1/rooms/:id2}}}
     101     - {{{labs}}} (array): datos de las aulas definidas, compuesta por:
     102       - {{{labid}}} (entero): identificador del aula.
     103       - {{{labname}}} (cadena): nombre del aula.
     104       - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponibles para el Proyecto Remote PC.
     105
     106 - {{{/ous/:id1/labs/:id2}}}
    104107   - Obtener los datos del aula con identificador ''id2'' de la UO ''id1''.
    105108   - Método: GET.
    106109   - Devuelve:
    107      - {{{roomid}}} (entero): identificador del aula.
    108      - {{{roomname}}} (cadena): nombre del aula.
     110     - {{{labid}}} (entero): identificador del aula.
     111     - {{{labname}}} (cadena): nombre del aula.
    109112     - {{{description}}} (cadena): descripción del aula.
    110      - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponible para el Proyecto Remote PC.
     113     - {{{inremotepc}}} (booleano): indica si los recursos del aula están disponibles para el Proyecto Remote PC.
    111114     - {{{maxclients}}} (entero): nº máximo de clientes del aula.
    112115     - {{{defclients}}} (entero): nº de clientes definidos en el aula.
    … …  
    115118     - {{{routerip}}} (cadena): dirección IP del router del aula.
    116119     - {{{netmask}}} (cadena): dirección IP de la máscara de red común a los clinetes del aula.
     120     - {{{ntp}}} (cadena): dirección IP del servidor NTP del aula.
    117121     - {{{dns}}} (cadena): dirección IP del servidor DNS principal para el aula.
    118122     - {{{proxyurl}}} (cadena): URL del servidor proxy del aula.
    … …  
    124128     - {{{p2ptime}}} (entero): tiempo de conexión tras finalizar la recepción P2P (en s.).
    125129
    126  - {{{/ous/:id1/rooms/:id2/clients}}}
     130 - {{{/ous/:id1/labs/:id2/clients}}}
    127131   - Listar los clientes definidos en el aula ''id2'' de la UO ''id1''.
    128132   - Método: GET.
    129133   - Devuelve:
    130134     - {{{ouid}}} (entero): identificador de la UO.
    131      - {{{roomid}}} (entero): identificador del aula.
     135     - {{{labid}}} (entero): identificador del aula.
    132136     - {{{clients}}} (array): datos de los clientes definidas, compuesta por:
    133137       - {{{clientid}}} (entero): identificador del cliente.
    134138       - {{{clientname}}} (cadena): nombre del cliente.
    135139
    136  - {{{/ous/:id1/rooms/:id2/clients/:id3}}}
     140 - {{{/ous/:id1/labs/:id2/clients/:id3}}}
    137141   - Obtener los datos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''.
    138142   - Método: GET.
    … …  
    142146     - {{{netiface}}} (cadena): interfaz de red por defecto.
    143147     - {{{netdriver}}} (cadena): driver (módulo a cargar) del interfaz de red (si {{{"generic"}}}, no se necesita cargar nada).
    144      - {{{macaddress}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
    145      - {{{ipaddress}}} (cadena): dirección IP del cliente.
     148     - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
     149     - {{{ip}}} (cadena): dirección IP del cliente.
    146150     - {{{netmask}}} (cadena): máscara de red.
    147151     - {{{routerip}}} (cadena): dirección IP del router por defecto.
    148152     - {{{repoid}}} (cadena): identificador del repositorio de imágenes.
     153   - Otros datos que pueden incluirse:
    149154     - {{{boottype}}} (cadena): plantilla asociada para el arranque del equipo.
    150    - Otros datos que pueden incluirse:
    151155     - {{{hardprofid}}} (entero): identificador del perfil de hardware del cliente.
    152156     - {{{menuid}}} (entero): identificador del menú de inicio del cliente.
    153157     - {{{validation}}} (booleano): indica si se necesita autenticación para entrar en el menú del cliente.
    154158
    155  - {{{/ous/:id1/rooms/:id2/clients/:id3/hardware}}}
     159 - {{{/ous/:id1/labs/:id2/clients/:id3/hardware}}}
    156160   - Obtener los datos del perfil de hardware con la lista de dispoistivos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''.
    157161   - Método: GET.
    … …  
    163167       - {{{description}}} (cadena): descripción del componente.
    164168
    165  - {{{/ous/:id1/rooms/:id2/clients/:id3/diskcfg}}}
     169 - {{{/ous/:id1/labs/:id2/clients/:id3/diskcfg}}}
    166170   - Obtener los datos de configuración e instalación de discos del cliente con identificador ''id3'' del aula   
    167171   - Método: GET.
    … …  
    180184         - {{{filesystem}}} (cadena): nemónico del tipo de sistema de ficheros.
    181185         - {{{os}}} (cadena): sistema operativo instalado.
    182          - {{{idimage}}} (cadena): identificador de la imagen desplegada.
     186         - {{{imageid}}} (cadena): identificador de la imagen desplegada.
    183187         - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS).
    184 
    185  - {{{/ous/:id1/rooms/:id2/clients/:id3/status}}}
     188       - Otros datos previstos que pueden incluirse:
     189         - {{{updated}}} (boolean): indica si la imagen desplegada está actualizada a la última versión del repositorio.
     190         - {{{cachedada}}} (string): información sobre la caché local.
     191
     192 - {{{/ous/:id1/labs/:id2/clients/:id3/status}}}
    186193   - Obtener el de inicio del cliente con identificador ''id3'' del aula   
    187194   - Método: GET.
    … …  
    192199   - Otros datos que pueden incluirse:
    193200     - {{{clientname}}} (cadena): nombre del cliente.
     201     - {{{loggedin}}} (boolean): indica si un usuario tiene una sesión abierta en un sistema operativo (solo si usa OGAgent).
    194202
    195203 - {{{/ous/:id1/repos}}}
    … …  
    210218     - {{{description}}} (cadena): descripción del repositorio.
    211219     - {{{ipaddress}}} (cadena): dirección IP del repositorio.
    212      - {{{port}}} (entero): puerto de conexión al servicio del repositorio.
     220   - Otros datos que pueden incluirse:
     221     - {{{port}}} (entero): puerto de conexión al servicio del repositorio ogAdmRepo.
    213222
    214223 - {{{/ous/:id1/images}}}
    … …  
    220229       - {{{imageid}}} (entero): identificador de la imagen.
    221230       - {{{imagename}}} (cadena): nombre de la imagen.
     231       - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC.
    222232
    223233 - {{{/ous/:id1/images/:id2}}}
    … …  
    230240       - {{{description}}} (cadena): descripción de la imagen.
    231241       - {{{comments}}} (cadena): comentarios acerca de de la imagen.
     242       - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC.
    232243       - {{{type}}} (cadena): tipo de imagen ({{{"monolithic"}}}, {{{"base"}}} o {{{"incremental"}}}).
    233244     - Datos incluidos si la imagen es de tipo incremental:
    … …  
    241252   - Otros datos que pueden incluirse:
    242253     - {{{baseid}}} (entero): identificador de la imagen base para una imagen incremental.
     254     - {{{imagerelease}}} (cadena): revisión actual de la imagen.
    243255
    244256 - {{{/ous/:id1/images/:id2/software}}}
    … …  
    252264
    253265 - {{{/ous/:id1/images/:id2/boot}}}
    254    - Iniciar sesión en el sistema operativo de clientes que tengan instalada la imagen con identificador ''id2'' de la UO ''id1''.
    255    - Parámetros:
    256      - {{{nclients}}} (entero): nº de clientes a iniciar.
    257    - Método: POST.
     266   - Iniciar sesión en el sistema operativo de un cliente elegido al azar y que tenga instalada la imagen con identificador ''id2'' de la UO ''id1''.
     267   - Método: GET.
    258268   - Devuelve: (por determinar)
    259269     - {{{sendto}}} (array): datos de los clientes a los que se les ha enviado la orden de iniciar sesión, compuesta por:
    260270       - {{{clientid}}} (entero): identificador del cliente.
     271       - {{{ip}}} (cadena): dirección IP del cliente.
     272       - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
    261273   - Otros datos que pueden incluirse en la lista de clientes:
    262274       - {{{clientname}}} (cadena): nombre del cliente.
    263        - {{{ip}}} (cadena): dirección IP del cliente.
     275
     276
     277==== Rutas para OGAgent ====
     278
     279Rutas que atienden las notificaciones ''push'' de agentes OGAgent:
     280
     281 - {{{/ogagent/started}}}
     282   - Notificación de que se ha iniciado el servicio OGAgent en un cliente.
     283   - Método: POST.
     284   - Parámetros:
     285     - {{{ip}}} (cadena): dirección IP del cliente.
     286     - {{{mac}}} (cadena): dirección MAC de la interfaz de red.
     287
     288 - {{{/ogagent/stopped}}}
     289   - Notificación de que se ha detenido el servicio OGAgent en un cliente.
     290   - Método: POST.
     291   - Parámetros:
     292     - {{{ip}}} (cadena): dirección IP del cliente.
     293     - {{{mac}}} (cadena): dirección MAC de la interfaz de red.
     294
     295 - {{{/ogagent/loggedin}}}
     296   - Notificación de que un usuario ha iniciado una sesión de escritorio en un cliente.
     297   - Método: POST.
     298   - Parámetros:
     299     - {{{ip}}} (cadena): dirección IP del cliente.
     300     - {{{user}}} (cadena): usuario que inicia la sesión.
     301
     302 - {{{/ogagent/loggedout}}}
     303   - Notificación de que un usuario ha finalizado una sesión de escritorio en un cliente.
     304   - Método: POST.
     305   - Parámetros:
     306     - {{{ip}}} (cadena): dirección IP del cliente.
     307     - {{{user}}} (cadena): usuario que cierra la sesión.