Changes between Version 2 and Version 3 of ApiRest


Ignore:
Timestamp:
Apr 9, 2015, 2:42:29 PM (9 years ago)
Author:
ramon
Comment:

Continuar definiendo la propuesta de API REST.

Legend:

Unmodified
Added
Removed
Modified
  • ApiRest

    v2 v3  
    8585
    8686 - {{{/ous/:id1}}}
    87    - Consultar los datos de la UO con identificador ''id1''.
     87   - Obtener los datos de la UO con identificador ''id1''.
    8888   - Método: GET.
    8989   - Devuelve:
     
    102102
    103103 - {{{/ous/:id1/rooms/:id2}}}
    104    - Consultar los datos del aula con identificador ''id2'' de la UO ''id1''.
     104   - Obtener los datos del aula con identificador ''id2'' de la UO ''id1''.
    105105   - Método: GET.
    106106   - Devuelve:
     
    125125
    126126 - {{{/ous/:id1/rooms/:id2/clients}}}
    127    - Método: GET.
    128    - Devuelve:
     127   - Listar los clientes definidos en el aula ''id2'' de la UO ''id1''.
     128   - Método: GET.
     129   - Devuelve:
     130     - {{{ouid}}} (entero): identificador de la UO.
     131     - {{{roomid}}} (entero): identificador del aula.
     132     - {{{clients}}} (array): datos de los clientes definidas, compuesta por:
     133       - {{{clientid}}} (entero): identificador del cliente.
     134       - {{{clientname}}} (cadena): nombre del cliente.
    129135
    130136 - {{{/ous/:id1/rooms/:id2/clients/:id3}}}
    131    - Método: GET.
    132    - Devuelve:
     137   - Obtener los datos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''.
     138   - Método: GET.
     139   - Devuelve:
     140     - {{{clientid}}} (entero): identificador del cliente.
     141     - {{{clientname}}} (cadena): nombre del cliente.
     142     - {{{netiface}}} (cadena): interfaz de red por defecto.
     143     - {{{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.
     146     - {{{netmask}}} (cadena): máscara de red.
     147     - {{{routerip}}} (cadena): dirección IP del router por defecto.
     148     - {{{repoid}}} (cadena): identificador del repositorio de imágenes.
     149     - {{{boottype}}} (cadena): plantilla asociada para el arranque del equipo.
     150   - Otros datos que pueden incluirse:
     151     - {{{hardprofid}}} (entero): identificador del perfil de hardware del cliente.
     152     - {{{menuid}}} (entero): identificador del menú de inicio del cliente.
     153     - {{{validation}}} (booleano): indica si se necesita autenticación para entrar en el menú del cliente.
    133154
    134155 - {{{/ous/:id1/rooms/:id2/clients/:id3/hardware}}}
    135    - Método: GET.
    136    - Devuelve:
     156   - Obtener los datos del perfil de hardware con la lista de dispoistivos del cliente con identificador ''id3'' del aula ''id2'' de la UO ''id1''.
     157   - Método: GET.
     158   - Devuelve:
     159     - {{{clientid}}} (entero): identificador del cliente.
     160     - {{{clientname}}} (cadena): nombre del cliente.
     161     - {{{hardware}}} (array): datos de los componentes hardware, compuesta por:
     162       - {{{type}}} (cadena): tipo de componente, los valores se corresponden con el campo {{{nemonico}}} de la tabla {{{tipohardwares}}}.
     163       - {{{description}}} (cadena): descripción del componente.
    137164
    138165 - {{{/ous/:id1/rooms/:id2/clients/:id3/diskcfg}}}
    139    - Método: GET.
    140    - Devuelve:
     166   - Obtener los datos de configuración e instalación de discos del cliente con identificador ''id3'' del aula   
     167   - Método: GET.
     168   - Devuelve:
     169     - {{{clientid}}} (entero): identificador del cliente.
     170     - {{{clientname}}} (cadena): nombre del cliente.
     171     - {{{diskcfg}}} (array): configuración de discos, compuesta por:
     172       - Configuración para discos:
     173         - {{{disk}}} (entero): nº de orden del disco.
     174         - {{{parttable}}} (cadena): tipo de tabla de particiones ({{{"MSDOS"}}}, {{{"GPT"}}}, {{{"LVM"}}} o {{{"ZPOOL"}}}).
     175         - {{{size}}} (entero): tamaño del disco (en KB).
     176       - Configuración para particiones (puede estudiarse si es mejor que esta información sea una array {{{partitions}}} dentro de la configuración del disco):
     177         - {{{partition}}} (entero): nº de orden de la partición.
     178         - {{{parttype}}} (cadena): nemónico del tipo de partición.
     179         - {{{size}}} (entero): tamaño de la partición (en KB).
     180         - {{{filesystem}}} (cadena): nemónico del tipo de sistema de ficheros.
     181         - {{{os}}} (cadena): sistema operativo instalado.
     182         - {{{idimage}}} (cadena): identificador de la imagen desplegada.
     183         - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen.
    141184
    142185 - {{{/ous/:id1/rooms/:id2/clients/:id3/status}}}
    143    - Método: GET.
    144    - Devuelve:
     186   - Obtener el de inicio del cliente con identificador ''id3'' del aula   
     187   - Método: GET.
     188   - Devuelve:
     189     - {{{clientid}}} (entero): identificador del cliente.
     190     - {{{ip}}} (cadena): dirección IP del cliente.
     191     - {{{status}}} (array): estado de inicio del cliente ({{{"off"}}}, {{{"initializing"}}}, {{{"ogclient"}}}, {{{"busy"}}}, {{{"linux"}}}, {{{"windows"}}} o {{{"nodata"}}}).
     192   - Otros datos que pueden incluirse:
     193     - {{{clientname}}} (entero): nombre del cliente.
    145194
    146195 - {{{/ous/:id1/repos}}}
    147    - Método: GET.
    148    - Devuelve:
     196   - Listar los repositorios de imágenes definidas en la UO ''id1''.
     197   - Método: GET.
     198   - Devuelve:
     199     - {{{ouid}}} (entero): identificador de la UO.
     200     - {{{repos}}} (array): datos de los repositorios definidas, compuesta por:
     201       - {{{repoid}}} (entero): identificador del repositorio.
     202       - {{{reponame}}} (cadena): nombre del repositorio.
    149203
    150204 - {{{/ous/:id1/repos/:id2}}}