Gobierno de Aragón Open Data Core GA_OD_CORE (API REST Swagger)

GA_OD_Core (Gobierno de Aragón Open Data Core) es un API creada con la finalidad de poder obtener datos de determinadas vistas usadas y servidas actualmente a través del portal Aragón Open Data.

¿Para qué sirve?

Con esta API pretendemos dar la oportunidad a desarrolladores de consultar estos datos de forma que estén siempre actualizados y preparados para ser usados en otras aplicaciones o servicios mediante el uso de la arquitectura REST.

¿Cómo se usa?

La URL base para acceder a los servicios de la API de Aragón OpenData GA_OD_Core es la siguiente: /GA_OD_Core

Con la tecnología del framework swagger, se muestra la documentación de manera descriptiva y estructurada: /GA_OD_Core/ui

Desde ahí podremos consultar todas las funcionalidades que posee, las cuales describimos a continuación.

Tipos de llamada

Vistas disponibles

Devuelve un Array con todas las vistas disponibles registradas en formato JSON identado.

Concretamente, proporciona el identificador (“id”), nombre (“name”) y disponibilidad (“available”) de cada uno de los recursos incluidos en la API.

Podemos acceder desde la siguiente URL:

/GA_OD_Core/views

Ejemplo:

/GA_OD_Core/views

Columnas de Vista

Devuelve un Array con información sobre las columnas y sus tipos de datos en formato JSON identado.

Requiere que le pasemos como parámetros:

  • id_vista: (Requerido) Id de la vista que queremos consultar.

Podemos acceder desde la siguiente URL:

/GA_OD_Core/show_columns?view_id={view_id}

Ejemplo:

/GA_OD_Core/show_columns?view_id=2

Preview de vista

Devuelve un array con la consulta resultante, por defecto, devuelve los primeros 1000 registros.

Requiere que le pasemos como parámetros:

  • view_id o resource_id: (Requerido) Id de la vista que queremos consultar.
  • fields: (Optional) String para seleccionar los campos del recurso que queremos recuperar, por ejemplo, “entidad”. Hay que generar un parámetro fields para cada uno de los campos a seleccionar.
  • filters: (Opcional) String para filtrar los datos del recurso, a través de la selección mediante. diferentes condiciones categóricas, por ejemplo: “{"entidad": "ARANDA"}”. Hay que generar un parámetro filters para cada uno de los filtros a realizar.
  • formato: (Opcional) puede ser “csv”, “json”, “xml” o “xlsx, es el formato del fichero.
  • limit: (Opcional) Número de filas a restringir
  • _pageSize: (Opcional) Número de resultados en cada página.
  • _page: (Opcional) Número de página.

Podemos acceder desde la siguiente URL:

/GA_OD_Core/preview?view_id={view_id}&fields={fields}&filters={filters}&formato={formato}_pageSize={_pageSize}&_page={_page}

Ejemplo:

/GA_OD_Core/preview?resource_id=2&filters={"entidad": "ARANDA"}

Descarga Fichero

Devuelve un fichero en formato json, csv, xml o xlsx (excel) con el resultado de una consulta contra una vista.

Requiere que le pasemos como parámetros:

  • view_id o resource_id: (Requerido) Id de la vista que queremos consultar.
  • fields: (Optional) String para seleccionar los campos del recurso que queremos recuperar, por ejemplo, “entidad”. Hay que generar un parámetro fields para cada uno de los campos a seleccionar.
  • filters: (Opcional) String para filtrar los datos del recurso, a través de la selección mediante diferentes condiciones categóricas, por ejemplo: “{"ano": "2015"}”. Hay que generar un parámetro filters para cada uno de los filtros a realizar.
  • formato: (Opcional) puede ser “csv”, “json”, “xml” o “xlsx”, es el formato del fichero.
  • limit: (Opcional) Número de filas a restringir
  • _pageSize: (Opcional) Número de resultados en cada página
  • _page: (Opcional) Número de página

Podemos acceder desde la siguiente URL:

/GA_OD_Core/download?view_id={view_id}&fields={fields}&filters={filters}&formato={formato}&_pageSize={_pageSize}&_page={_page}

 

Ejemplo:

/GA_OD_Core/download?resource_id=2&filters={"ano": "2015"}&formato=xlsx

Última actualización: 02/03/2023

¿Te ha resultado útil esta página?

Me ha sido útil

Ayúdanos a mejorar la página del Gobierno de Aragón

¿Por qué no te ha resultado útil? Puedes dejar aquí tu comentario anónimo.

Enviar Enviar mensaje Enviar sin comentario Enviar valoración sin mensaje

Tu respuesta nos ayudará a mejorar la web