API Catálogo de datos (RPC-style API CKAN)

La web de Aragón Open Data está desarrollada sobre CKAN (Comprehensive Knowledge Archive Network), que es un producto de software libre creado y evolucionado por la Open Knowledge Foundation.

Introducción

El CKAN es un producto que incorpora de manera nativa una API (Interfaz de Programación de Aplicaciones) que permite el acceso directo a los datos. Se puede encontrar toda la información de la API siguiendo este enlace.

Métodos

En este tabla aparecen en la columna primera el nombre, en la segunda la descripción y en la tercera los parámetros que pueden aplicarse.

Nombre Descripción Parámetros
package_list Devuelve todos los conjuntos de datos Sin parámetros
group_list Devuelve todos los temas Sin parámetros
tag_list Devuelve todas las etiquetas

query (opcional): para buscar una etiqueta específica.

vocabulary_id (opcional): el id o nombre del vocabulario, en caso de tenga.

all_fields (opcional, por defecto: 'false'): devolver etiquetas completas en vez de solo el nombre.

organization_list Devuelve a todos los publicadores Sin parámetros
recently_changed_packages_activity_list Devuelve todos los conjuntos de datos modificados recientemente Sin parámetros
group_package_show Devuelve todos los conjuntos de datos que pertenecen a un tema id: tema del que se quiere obtener los conjuntos de datos
package_show Devuelve los conjuntos de datos que satisfagan el criterio de búsqueda

q (opcional, por defecto: '*:*'): consulta solr

fq: en caso de querer aplicar un filtro a la consulta

sort (opcional, por defecto: 'relevance asc, metadata_modified desc'): clasificar los resultados de la búsqueda

rows (límite de 1000): el número de filas que devuelve la petición

start: la posición desde donde debe comenzar el listado de conjuntos de datos

tag_show Devuelve la información de la etiqueta y todos sus conjuntos de datos

id: nombre o id de la etiqueta

vocabulary_id (opcional): el id o nombre del vocabulario, en caso de que tenga

include_datasets (opcional, por defecto: 'false'): incluye una lista de los conjuntos de datos de la etiqueta

organization_show Devuelve la información de un publicador

id: nombre o id de la organización

include_datasets (opcional, por defecto: 'false'): incluye una lista de los conjuntos de datos de la organización

include_datasets_count (opcional, por defecto: 'true'): incluye la cantidad de conjuntos de datos

include_extras(opcional, por defecto: 'true'): incluye campos adicionales de la organización

include_tags (opcional, por defecto: 'true'): incluye etiquetas de la organización

Ejemplos básicos

A continuación se muestra un listado de ejemplos básicos que interactúan con la API de Aragón Open Data.

Listado de catálogo de datos

[GET] https://opendata.aragon.es/api/action/package_list

Listado de los temas del catálogo de datos

[GET ]https://opendata.aragon.es/api/action/group_list

Listado de las etiquetas utilizadas en los conjuntos de datos

[GET] https://opendata.aragon.es/api/action/tag_list

Listado de todos los publicadores que participan en Aragón Open Data

[GET] https://opendata.aragon.es/api/action/organization_list

Listado de los conjuntos de datos modificados recientemente

[GET] https://opendata.aragon.es/api/action/recently_changed_packages_activity_list

Ejemplos complejos

Listado de todas las etiquetas que contengan el literal salud:

[GET] https://opendata.aragon.es/api/action/tag_list?query=salud

Resultado (código):

{

"help": https://opendata.aragon.es/api/3/action/help_show?name=tag_list",

"success": true,

"result": [

"Estado de salud",

"Salud", 

"Usuarios del Servicio Aragonés de Salud"

]

}

Detalle de la etiqueta Ayuntamiento:

[GET] https://opendata.aragon.es/api/action/tag_show?id=Ayuntamiento

Resultado (código):

{

"help": "htpps://opendata.aragon.es/api/3/action/help_show?name=tag_show"

"success": true,

"result": {

"vocabylary_id": null,

"display_name": "Ayuntamiento",

"id": "e31a7848-9ef9-43c4-b90e-16a0e65e5f23",

"name": "Ayuntamiento"

}

}

Listado con detalle de los conjuntos de datos que contienen la etiqueta Zaragoza:

[GET] https://opendata.aragon.es/api/action/tag_show?id=Zaragoza&include_datasets=true

Detalle del publicador Instituto Aragonés del Agua, ocultando los extras y el número de conjuntos de datos que posee:

[GET] https://opendata.aragon.es/api/action/organization_show?id=instituto-aragones-agua&include_dataset_count=false&include_extras=false

Detalle del personal sanitario en el año 2012:

[GET] https://opendata.aragon.es/api/action/package_show?id=personal-sanitario-anyo-2012

Listado con detalle de todos los conjuntos de datos que pertenrcen al tema de salud:

[GET] https://opendata.aragon.es/api/action/package_search?fq=groups:salud&sort=relevance asc,metadata_modified desc,&rows=20&start=0

Listado con detalle de todos los conjuntos de datos que pertenecen al tema de empleo y además tienen al menos un recurso de tipo calendario:

[GET] https://opendata.aragon.es/api/action/package_search?q=(res_format:(ics OR ICS)) AND dataset_type:dataset AND entity_type:package AND state:active AND capacity:public&fq=groups:empleo&sort=relevance asc,metadata_modified desc,&rows=20&start=0

Listado con detalle de todos los conjuntos de datos publicados por el Instituto Aragonés de Estadística:

[GET] https://opendata.aragon.es/api/action/package_search?sort=relevance asc,metadata_modified desc,&rows=20&start=0&fq=organization:instituto-aragones-estadistica

Listado con detalle de todos los conjuntos de datos que tienen las etiquetas de festivos 2019:

[GET] https://opendata.aragon.es/api/action/package_search?sort=relevance asc,metadata_modified desc,&rows=20&start=0&fq=tags:(*Festivos* AND *2019*)

Listado con detalle de todos los conjuntos de datos que contiene Información Estadística y que pertenecen al grupo de Educación y Formación:

[GET] https://opendata.aragon.es/api/action/package_search?sort=relevance asc,metadata_modified desc,&rows=20&start=0&q=(organization:instituto-aragones-estadistica AND 01_IAEST_Temaestadistico:03*)

Listado con detalle de todos los conjuntos de datos que contiene Información Estadística, pertenecen al grupo de Educación y Formación y al subgrupo de Gasto público en educación:

[GET] https://opendata.aragon.es/api/action/package_search?sort=relevance asc,metadata_modified desc,&rows=20&start=0&q=(organization:instituto-aragones-estadistica AND 01_IAEST_Temaestadistico:0303*)

De forma adicional, la API de CKAN ha sido ampliada con tres operaciones más:

Obtener el número de conjuntos de datos y de recursos almacenados en Aragón Open Data

[GET] https://opendata.aragon.es/aod/services/web/datasets/countDatasets

Obtener los cinco conjuntos de datos más visitados en Aragón Open Data

[GET] https://opendata.aragon.es/aod/services/web/datasets/downloaded

Obtener los cinco conjuntos de datos más recientes almacenados en Aragón Open Data

[GET] https://opendata.aragon.es/aod/services/web/datasets/newest

Ú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