Changes between Version 7 and Version 8 of ApiRest


Ignore:
Timestamp:
Feb 2, 2017, 12:56:40 PM (7 years ago)
Author:
ramon
Comment:

Actualización documentación API REST.

Legend:

Unmodified
Added
Removed
Modified

  • ApiRest

    v7 v8  
    8383     - {{{release}}} (cadena): revisión instalada.
    8484     - {{{services}}} (array de cadenas): lista de servicios iniciados.
    85      - {{{ous}}} (array de objetos): datos de los clientes ogLive instalados, compuesta por:
     85     - {{{ous}}} (array de objetos): datos de los clientes ogLive instalados.
    8686       - {{{distribution}}} (cadena): distribución Linux del cliente ogLive.
    8787       - {{{kernel}}} (cadena): versión del Kernel Linux.
    … …  
    195195     - {{{id}}} (entero): identificador del cliente.
    196196     - {{{name}}} (cadena): nombre del cliente.
    197      - {{{hardware}}} (array de objetos): datos de los componentes hardware, compuesta por:
     197     - {{{hardware}}} (array de objetos): datos de los componentes hardware.
    198198       - {{{type}}} (cadena): tipo de componente, los valores se corresponden con el campo {{{nemonico}}} de la tabla {{{tipohardwares}}}.
    199199       - {{{description}}} (cadena): descripción del componente.
    … …  
    202202   - Obtener los datos de configuración e instalación de discos del cliente con identificador ''id3'' del aula   
    203203   - Método: GET.
    204    - Devuelve:
    205      - {{{clientid}}} (entero): identificador del cliente.
    206      - {{{clientname}}} (cadena): nombre del cliente.
    207      - {{{diskcfg}}} (array): configuración de discos, compuesta por:
     204   - Devuelve: objeto.
     205     - {{{id}}} (entero): identificador del cliente.
     206     - {{{name}}} (cadena): nombre del cliente.
     207     - {{{diskcfg}}} (array de objetos): configuración de discos.
    208208       - Configuración para discos:
    209209         - {{{disk}}} (entero): nº de orden del disco.
    … …  
    215215         - {{{size}}} (entero): tamaño de la partición (en KB).
    216216         - {{{filesystem}}} (cadena): nemónico del tipo de sistema de ficheros.
     217         - {{{usage}}} (entero): porcentaje de uso del sistema operativo.
    217218         - {{{os}}} (cadena): sistema operativo instalado.
    218          - {{{imageid}}} (cadena): identificador de la imagen desplegada.
    219          - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS).
    220        - Otros datos previstos que pueden incluirse:
    221          - {{{updated}}} (boolean): indica si la imagen desplegada está actualizada a la última versión del repositorio.
    222          - {{{cachedada}}} (string): información sobre la caché local.
     219         - {{{image}}} (objeto): datos de la imagen desplegada.
     220           - {{{id}}} (cadena): identificador de la imagen.
     221           - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS).
     222           - {{{updated}}} (booleano): indica si la imagen desplegada está actualizada a la última versión del repositorio.
    223223
    224224 - {{{/ous/:id1/labs/:id2/clients/:id3/status}}}
    225225   - Obtener el de inicio del cliente con identificador ''id3'' del aula   
    226226   - Método: GET.
    227    - Devuelve:
    228      - {{{clientid}}} (entero): identificador del cliente.
    229      - {{{ip}}} (cadena): dirección IP del cliente.
    230      - {{{status}}} (array): estado de inicio del cliente ({{{"off"}}}, {{{"initializing"}}}, {{{"ogclient"}}}, {{{"busy"}}}, {{{"linux"}}}, {{{"windows"}}} o {{{"nodata"}}}).
     227   - Devuelve: objeto.
     228     - {{{id}}} (entero): identificador del cliente.
     229     - {{{ip}}} (cadena): dirección IP del cliente.
     230     - {{{status}}} (cadena): estado de inicio del cliente ({{{"off"}}}, {{{"ogclient"}}}, {{{"busy"}}}, {{{"linux"}}}, {{{"windows"}}} o {{{"nodata"}}}).
     231     - {{{loggedin}}} (booleano): indica si un usuario tiene una sesión abierta en un sistema operativo (solo si usa OGAgent).
    231232   - Otros datos que pueden incluirse:
    232      - {{{clientname}}} (cadena): nombre del cliente.
    233      - {{{loggedin}}} (boolean): indica si un usuario tiene una sesión abierta en un sistema operativo (solo si usa OGAgent).
     233     - {{{disk}}} (entero): nº de orden del disco.
     234     - {{{partition}}} (entero): nº de orden de la partición.
     235     - {{{image}}} (objeto): datos de la imagen desplegada.
     236       - {{{name}}} (cadena): nombre de la imagen restaurada.
     237       - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS).
    234238
    235239 - {{{/ous/:id1/repos}}}
    236240   - Listar los repositorios de imágenes definidos en la UO ''id1''.
    237241   - Método: GET.
    238    - Devuelve:
    239      - {{{ouid}}} (entero): identificador de la UO.
    240      - {{{repos}}} (array): datos de los repositorios definidas, compuesta por:
    241        - {{{repoid}}} (entero): identificador del repositorio.
    242        - {{{reponame}}} (cadena): nombre del repositorio.
     242   - Devuelve: array de objetos.
     243     - {{{id}}} (entero): identificador del repositorio.
     244     - {{{name}}} (cadena): nombre del repositorio.
     245     - {{{ou}}} (objeto): UO a la que pertenece.
     246       - {{{id}}} (entero): identificador de la UO.
    243247
    244248 - {{{/ous/:id1/repos/:id2}}}
    245249   - Obtener los datos del repositorio con identificador ''id2'' de la UO ''id1''.
    246250   - Método: GET.
    247    - Devuelve:
    248      - {{{repoid}}} (entero): identificador del repositorio.
    249      - {{{reponame}}} (cadena): nombre del repositorio.
     251   - Devuelve: objeto.
     252     - {{{id}}} (entero): identificador del repositorio.
     253     - {{{name}}} (cadena): nombre del repositorio.
    250254     - {{{description}}} (cadena): descripción del repositorio.
    251      - {{{ipaddress}}} (cadena): dirección IP del repositorio.
    252    - Otros datos que pueden incluirse:
    253      - {{{port}}} (entero): puerto de conexión al servicio del repositorio ogAdmRepo.
     255     - {{{ip}}} (cadena): dirección IP del repositorio.
    254256
    255257 - {{{/ous/:id1/images}}}
    256258   - Listar las imágenes almacenadas en los repositorios definidos en la UO ''id1''.
    257259   - Método: GET.
    258    - Devuelve:
    259      - {{{ouid}}} (entero): identificador de la UO.
    260      - {{{image}}} (array): datos de las imágenes definidas, compuesta por:
    261        - {{{imageid}}} (entero): identificador de la imagen.
    262        - {{{imagename}}} (cadena): nombre de la imagen.
    263        - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC.
     260   - Devuelve: array de objetos.
     261     - {{{id}}} (entero): identificador de la imagen.
     262     - {{{name}}} (cadena): nombre de la imagen.
     263     - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC.
     264     - {{{ou}}} (objeto): UO a la que pertenece.
     265       - {{{id}}} (entero): identificador de la UO.
    264266
    265267 - {{{/ous/:id1/images/:id2}}}
    266268   - Obtener los datos de la imagen con identificador ''id2'' de la UO ''id1''.
    267269   - Método: GET.
    268    - Devuelve:
     270   - Devuelve: objeto.
    269271     - Datos generales:
    270        - {{{imageid}}} (entero): identificador de la imagen.
    271        - {{{imagename}}} (cadena): nombre de la imagen (nombre del fichero de imagen sin extensión).
     272       - {{{id}}} (entero): identificador de la imagen.
     273       - {{{name}}} (cadena): nombre de la imagen (nombre del fichero de imagen sin extensión).
    272274       - {{{description}}} (cadena): descripción de la imagen.
    273275       - {{{comments}}} (cadena): comentarios acerca de de la imagen.
    274276       - {{{inremotepc}}} (booleano): indica si la imagen está preparada para ser usada en el Proyecto Remote PC.
     277       - {{{repo}}} (objeto): repositorio donde está almacenada.
     278         - {{{id}}} (entero): identificador del repositorio.
    275279       - {{{type}}} (cadena): tipo de imagen ({{{"monolithic"}}}, {{{"base"}}} o {{{"incremental"}}}).
    276280     - Datos incluidos si la imagen es de tipo incremental:
    … …  
    278282       - {{{path}}} (cadena): camino de la imagen.
    279283     - Datos incluidos si la imagen ha sido generada en el cliente modelo:
    280        - {{{clientid}}} (entero): identificador del cliente modelo.
    281        - {{{disk}}} (entero): nº de orden del disco.
    282        - {{{partition}}} (entero): nº de orden de la partición.
     284       - {{{client}}} (objeto): datos del cliente modelo.
     285         - {{{id}}} (entero): identificador del cliente.
     286         - {{{disk}}} (entero): nº de orden del disco.
     287         - {{{partition}}} (entero): nº de orden de la partición.
    283288       - {{{creationdate}}} (cadena): fecha y hora de creación de la imagen (formato AAAA-MM-DD HH:MM:SS).
    284    - Otros datos que pueden incluirse:
    285      - {{{baseid}}} (entero): identificador de la imagen base para una imagen incremental.
    286      - {{{imagerelease}}} (cadena): revisión actual de la imagen.
     289       - {{{release}}} (entero): nº de revisión de la imagen.
    287290
    288291 - {{{/ous/:id1/images/:id2/software}}}
    289292   - Obtener los datos del perfil de software con la lista de aplicaciones instaladas en la imagen con identificador ''id2'' de la UO ''id1''.
    290293   - Método: GET.
    291    - Devuelve:
    292      - {{{imageid}}} (entero): identificador de la imagen.
    293      - {{{imagename}}} (cadena): nombre de la imagen.
    294      - {{{software}}} (array): datos de las aplicaciones instaladas, compuesta por:
     294   - Devuelve: objeto
     295     - {{{id}}} (entero): identificador de la imagen.
     296     - {{{name}}} (cadena): nombre de la imagen.
     297     - {{{os}}} (cadena): sistema operativo instalado.
     298     - {{{software}}} (array de objetos): datos de las aplicaciones instaladas.
    295299       - {{{application}}} (cadena): nombre y versión de la aplicación o del paquete del sistema operativo.
    296 
    297  - {{{/ous/:id1/images/:id2/boot}}}
    298    - 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''.
    299    - Método: GET.
    300    - Devuelve: (por determinar)
    301      - {{{sendto}}} (array): datos de los clientes a los que se les ha enviado la orden de iniciar sesión, compuesta por:
    302        - {{{clientid}}} (entero): identificador del cliente.
    303        - {{{ip}}} (cadena): dirección IP del cliente.
    304        - {{{mac}}} (cadena): dirección MAC de la interfaz de red (sin caracteres ":").
    305    - Otros datos que pueden incluirse en la lista de clientes:
    306        - {{{clientname}}} (cadena): nombre del cliente.
    307300
    308301
    … …  
    317310     - {{{ip}}} (cadena): dirección IP del cliente.
    318311     - {{{mac}}} (cadena): dirección MAC de la interfaz de red.
     312     - {{{ostype}}} (cadena): tipo de sistema operativo instalado.
     313     - {{{osversion}}} (cadena): versión de sistema operativo instalado.
     314     - {{{secret}}} (cadena): clave de acceso a la API REST de OGAgent (generada aleatoriamente al iniciar el servicio).
    319315
    320316 - {{{/ogagent/stopped}}}
    … …  
    324320     - {{{ip}}} (cadena): dirección IP del cliente.
    325321     - {{{mac}}} (cadena): dirección MAC de la interfaz de red.
     322     - {{{ostype}}} (cadena): tipo de sistema operativo instalado.
     323     - {{{osversion}}} (cadena): versión de sistema operativo instalado.
    326324
    327325 - {{{/ogagent/loggedin}}}
    … …  
    338336     - {{{ip}}} (cadena): dirección IP del cliente.
    339337     - {{{user}}} (cadena): usuario que cierra la sesión.
     338
     339
     340==== Rutas para UDS ====
     341
     342 - {{{/ous/:id1/images/:id2/reserve}}}
     343   ''(documentar)
     344
     345 - {{{/ous/:id1/images/:id2/events}}}
     346   ''(documentar)
     347
     348 - {{{/ous/:id1/images/:id2/session}}}
     349   ''(documentar)
     350
     351 - {{{/ous/:id1/images/:id2/unreserve}}}
     352   ''(documentar)