Importar datos a una ontología desde fichero vía API

Introducción

Con la herramienta Import tool de plataforma es posible volcar los datos de un fichero CSV, JSON o XML sobre una ontología ya existente o sobre una nueva (ver Crear una ontología importando un XML desde un Portal Open Data ). Esta herramienta también se encuentra apificada, por lo que se puede invocar vía API a través de una sencilla petición HTTP REST.

Invocación desde Swagger

Si accedemos a las APIs del Control Panel desde la cabecera y buscamos en el desplegable la opción “Import tool”, nos aparecerá la interfaz Swagger de dicha API:

Open

Open

Y una operación POST para hacer la importación:

Seleccionamos esta operación y rellenamos los parámetros:

• Authorization: se introduce en la cabecera de la petición y representa el token Oauth2 del usuario. Se puede obtener pulsando en el botón APIs de la cabecera del Panel de Control.

• newOntology: indica si se quiere crear una nueva ontología (true) donde volcar los datos del fichero o hacerlo sobre una existente (false).

• ontologyName: nombre de la ontología donde se van a importar los datos del fichero. Si el campo newOntology está a false, tendrá que ser el nombre de una ontología existente y a la que el usuario tenga permiso. Si, por el contrario, está a true, tendrá que ser un nombre de ontología válido y que no exista una ontología con el mismo nombre.

• ontologyDescription: breve descripción de la ontología nueva que se va a crear para importar los datos. Este parámetro solamente es obligatorio rellenarlo si se ha marcado newOntology a true.

• file: fichero CSV, XML o JSON con los datos a importar.

Una vez rellenados estos parámetros, pulsamos sobre Execute y, si todo ha funcionado correctamente, el resultado será un código 200.

Si accedemos al listado de ontologías (DEVELOPMENT → My Ontologies), podremos ver nuestra nueva ontología creada:

Y desde la herramienta de consultas (TOOLS → Query Tool), veremos que se han insertado correctamente los datos:

Invocación desde Postman

Si disponemos de la aplicación Postman podemos realizar la petición HTTP desde ahí. En este caso vamos a importar un dato nuevo desde un fichero JSON a la ontología ya existente Restaurants.

Para ello, seleccionamos POST como método HTTP, configuramos la URL de la API y rellenamos los parámetros necesarios desde la pestaña Params:

En las cabeceras de la petición incluimos el token Oauth2:

Finalmente, en el cuerpo de la petición incluimos el fichero:

Pulsamos sobre el botón Send y, si la petición nos ha devuelto un código 200:

Podemos acceder a la herramienta de consultas (TOOLS → Query Tool) del Panel de Control para comprobar que se ha insertado ese nuevo dato correctamente: