Changes between Version 3 and Version 4 of ApiRest

Timestamp:

Apr 13, 2015, 12:37:38 PM (10 years ago)

Author:

ramon

Comment:

Terminar documentación de las funciones creadas hasta la fecha.

ApiRest

@@ -181 +181 @@
          - {{{os}}} (cadena): sistema operativo instalado.
          - {{{idimage}}} (cadena): identificador de la imagen desplegada.
-         - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen.
+         - {{{deploydate}}} (cadena): fecha y hora de despliegue de la imagen (formato AAAA-MM-DD HH:MM:SS).
 
  - {{{/ous/:id1/rooms/:id2/clients/:id3/status}}}
@@ -191 +191 @@
      - {{{status}}} (array): estado de inicio del cliente ({{{"off"}}}, {{{"initializing"}}}, {{{"ogclient"}}}, {{{"busy"}}}, {{{"linux"}}}, {{{"windows"}}} o {{{"nodata"}}}).
    - Otros datos que pueden incluirse:
-     - {{{clientname}}} (entero): nombre del cliente.
+     - {{{clientname}}} (cadena): nombre del cliente.
 
  - {{{/ous/:id1/repos}}}
-   - Listar los repositorios de imágenes definidas en la UO ''id1''.
+   - Listar los repositorios de imágenes definidos en la UO ''id1''.
    - Método: GET.
    - Devuelve:
@@ -203 +203 @@
 
  - {{{/ous/:id1/repos/:id2}}}
-   - Método: GET.
-   - Devuelve:
+   - Obtener los datos del repositorio con identificador ''id2'' de la UO ''id1''.
+   - Método: GET.
+   - Devuelve:
+     - {{{repoid}}} (entero): identificador del repositorio.
+     - {{{reponame}}} (cadena): nombre del repositorio.
+     - {{{description}}} (cadena): descripción del repositorio.
+     - {{{ipaddress}}} (cadena): dirección IP del repositorio.
+     - {{{port}}} (entero): puerto de conexión al servicio del repositorio.
 
  - {{{/ous/:id1/images}}}
-   - Método: GET.
-   - Devuelve:
+   - Listar las imágenes almacenadas en los repositorios definidos en la UO ''id1''.
+   - Método: GET.
+   - Devuelve:
+     - {{{ouid}}} (entero): identificador de la UO.
+     - {{{image}}} (array): datos de las imágenes definidas, compuesta por:
+       - {{{imageid}}} (entero): identificador de la imagen.
+       - {{{imagename}}} (cadena): nombre de la imagen.
 
  - {{{/ous/:id1/images/:id2}}}
-   - Método: GET.
-   - Devuelve:
+   - Obtener los datos de la imagen con identificador ''id2'' de la UO ''id1''.
+   - Método: GET.
+   - Devuelve:
+     - Datos generales:
+       - {{{imageid}}} (entero): identificador de la imagen.
+       - {{{imagename}}} (cadena): nombre de la imagen (nombre del fichero de imagen sin extensión).
+       - {{{description}}} (cadena): descripción de la imagen.
+       - {{{comments}}} (cadena): comentarios acerca de de la imagen.
+       - {{{type}}} (cadena): tipo de imagen ({{{"monolithic"}}}, {{{"base"}}} o {{{"incremental"}}}).
+     - Datos incluidos si la imagen es de tipo incremental:
+       - {{{baseimg}}} (cadena): nombre de la imagen base.
+       - {{{path}}} (cadena): camino de la imagen.
+     - Datos incluidos si la imagen ha sido generada en el cliente modelo:
+       - {{{clientid}}} (entero): identificador del cliente modelo.
+       - {{{disk}}} (entero): nº de orden del disco.
+       - {{{partition}}} (entero): nº de orden de la partición.
+       - {{{creationdate}}} (cadena): fecha y hora de creación de la imagen (formato AAAA-MM-DD HH:MM:SS).
+   - Otros datos que pueden incluirse:
+     - {{{baseid}}} (entero): identificador de la imagen base para una imagen incremental.
 
  - {{{/ous/:id1/images/:id2/software}}}
-   - Método: GET.
-   - Devuelve:
+   - Obtener los datos del perfil de software con la lista de aplicaciones instaladas en la imagen con identificador ''id2'' de la UO ''id1''.
+   - Método: GET.
+   - Devuelve:
+     - {{{imageid}}} (entero): identificador de la imagen.
+     - {{{imagename}}} (cadena): nombre de la imagen.
+     - {{{software}}} (array): datos de las aplicaciones instaladas, compuesta por:
+       - {{{application}}} (cadena): nombre y versión de la aplicación o del paquete del sistema operativo.
 
  - {{{/ous/:id1/images/:id2/boot}}}
+   - Iniciar sesión en el sistema operativo de clientes que tengan instalada la imagen con identificador ''id2'' de la UO ''id1''.
    - Parámetros:
+     - {{{nclients}}} (entero): nº de clientes a iniciar.
    - Método: POST.
    - Devuelve: (por determinar)