Lister les jeux de données
/d4c/api/datasets/2.0/search/
Description
Recherche des paquets satisfaisant à un critère de recherche donné.
Cette action accepte les paramètres de requête de recherche solr (détails ci-dessous) et renvoie un dictionnaire de résultats, y compris des jeux de données dictionnés qui correspondent aux critères de recherche, un compte de recherche et également des informations sur les facettes.
Dans le cas d'une utilisation sans paramètre de recherche, tous les Datasets sont restituées.
Paramètres Solr:
Pour un traitement plus approfondi de chaque paramètre, veuillez lire la documentation de Solr .
Cette action accepte un sous - ensemble de paramètres de requête de recherche de solr:
Paramètres
| q |
la requête solr. Optionnel. Par défaut: "*: *" |
|---|---|
| fq |
toutes les requêtes de filtre à appliquer. Remarque: + id_site: {ckan_site_id} est ajouté à cette chaîne avant l'exécution de la requête. |
| facet |
permet d'activer les résultats à facettes. Par défaut: vrai . |
| facet.mincount |
les nombres minimum pour les champs de facettes doivent être inclus dans les résultats. |
| facet.limit |
le nombre maximal de valeurs renvoyées par les champs de facette. Une valeur négative signifie illimitée. Cela peut être défini à l'échelle de l'instance avec l' option de configuration search.facets.limit . La valeur par défaut est 50. |
| sort |
tri des résultats de la recherche. Optionnel. Par défaut: 'pertinence asc, metadata_modified desc' . Conformément à la documentation de solr, il s'agit d'une chaîne de noms de champs et d'ordres de tri séparés par des virgules. |
| rows |
le nombre de lignes correspondantes à renvoyer. Il existe une limite stricte de 1 000 jeux de données par requête. |
| start |
le décalage dans le résultat complet pour l'endroit où l'ensemble des jeux de données renvoyés doit commencer. |
| facet.field |
les champs à facettes. Par défaut vide. Si vide, l'information de facette retournée est vide. |
| include_draft |
Si la valeur est True , les jeux de données de brouillon seront inclus dans les résultats. Un utilisateur ne recevra que ses propres jeux de données et un sysadmin sera renvoyé à tous les jeux de données de brouillon. Facultatif, la valeur par défaut est False . |
| include_private |
si True , les ensembles de données privés seront inclus dans les résultats. Seuls les ensembles de données privés provenant des organisations de l'utilisateur seront renvoyés et les administrateurs système recevront tous les ensembles de données privés. Facultatif, la valeur par défaut est False . |
| use_default_schema |
utilise le schéma de package par défaut au lieu d'un schéma personnalisé défini avec un plugin IDatasetForm (par défaut: False) . |
Les paramètres Solr avancés suivants sont également pris en charge. Notez que certains d'entre eux ne sont disponibles que sur des versions particulières de Solr. Voir la documentation dismac et edismax de Solr pour plus de détails à leur sujet:
qf , wt , bf , boost , cravate , defType , mm
Exemples:
q = ensembles de données flood contenant le mot flood , floods ou flooding fq = tags: ensemble de données economy avec le tag economy facet.field = ["tags"] facet.limit = 10 rows = 0 top 10 tags
Résultats:
Le résultat de cette action est un dict avec les clés suivantes:
| Type de retour: |
Un dictionnaire avec les clés suivantes |
|---|---|
| Paramètres: |
|
Un exemple de résultat :
{
'count': 2,
'résultats': [{<snip>}, {<snip>}],
'search_facets':
{
u'tags ':
{
'items ':
[
{
' count ': 1,
'display_name': u'tolstoy ',
'nom': u'tolstoy '
},
{
'count': 2,
'display_name': u'russian ',
'nom': u'russien '
}
]
}
}
}
Trouver l'identifiant du jeu de données (package_id) :
Consulter un jeu de données
/d4c/api/datasets/2.0/DATASETID/
Description
Renvoie les jeux de données (packages) d'un groupe.
Paramètres
| id |
l'identifiant ou le nom du groupe |
|---|---|
| limit |
le nombre maximal de jeux de données à renvoyer (facultatif) |
| Type de retour: |
liste de dictionnaires |
|---|
Trouver l'identifiant de la ressource à partir de l'identifiant d'un jeu de données (id dans resources ou resource_id)
Il faut regarder l'entrée "resource" correspondante au fichier CSV (format: CSV).
Recherche d'enregistrement
/d4c/api/records/2.0/search/
Description
Rechercher une ressource DataStore.
L'action datastore_search vous permet de rechercher des données dans une ressource. Les ressources DataStore appartenant à une ressource CKAN privée ne peuvent être lues par vous que si vous avez accès à la ressource CKAN et envoyez l'autorisation appropriée.
Mode de consommation
Ce service se consomme en GET. Le POST est également supporté mais non recommandé pour des raisons de standards.
Les formats de sortie supportés sont CSV (par défaut), JSON (ou JSONP en spécifiant un callback) et GeoJSON (callback également possible).
Paramètres
| resource_id |
id ou alias de la ressource à rechercher |
|---|---|
| filtres |
conditions de sélection à sélectionner, par exemple {"key1": "a", "key2": "b"} (facultatif) |
| q |
requête en texte intégral. Si c'est une chaîne, elle va chercher sur tous les champs de chaque ligne. Si c'est un dictionnaire comme {"key1": "a", "key2": "b"}, il va chercher sur chaque champ spécifique (optionnel) |
| distinct |
renvoie uniquement les lignes distinctes (facultatif, par défaut: false) |
| plain |
traiter comme une requête en texte brut (optionnel, par défaut: vrai) |
| language |
langue de la requête de texte intégral (facultatif, par défaut: anglais) |
| limit |
nombre maximum de lignes à renvoyer (facultatif, par défaut: 100) |
| offset |
décale ce nombre de lignes (facultatif) |
| fields |
champs à renvoyer (facultatif, par défaut: tous les champs dans l'ordre original) |
| sort |
noms de champs séparés par des virgules avec la commande par exemple: "fieldname1, fieldname2 desc" |
| include_total |
True pour retourner le nombre total d'enregistrements correspondants (facultatif, par défaut: true) |
| records_format |
le format de la valeur de retour d'enregistrements: 'objects' (valeur par défaut) liste de {fieldname1: value1, ...} dicts, liste 'lists' de listes [value1, value2, ...], ' Chaîne csv 'contenant des valeurs séparées par des virgules sans en-tête, chaîne' tsv 'contenant des valeurs séparées par des tabulations sans en-tête |
Définir l' indicateur brut sur false active l'intégralité du langage de requête de recherche de texte intégral PostgreSQL .
Une liste de toutes les ressources disponibles peut être trouvée sur l'alias _table_metadata .
Si vous devez télécharger la ressource complète, lisez Ressources de téléchargement .
Résultats:
Le résultat de cette action est un dictionnaire avec les clés suivantes:
| Type de retour: |
Un dictionnaire avec les clés suivantes |
|---|---|
| Paramètres: |
|
Consultation de données
/d4c/api/records/2.0/resource/
Description
Consulter des données d'une ressource.
Paramètres
| resource_id |
l'identifiant de la ressource |
|---|---|
| format |
format du résultat (facultatif) |
| refine |
permet d'affiner les résultats par facettes |
Exemples
refine = adm_lb_nom=BPT ensembles de données contenant la valeur BPT pour la facette adm_lb_nom
| Type de retour |
Liste de dictionnaires |
|---|
Téléchargement de la Documentation