Requêtes sur les ressources de HAL
Sommaire
- 1 Dictionnaire commenté de requêtes API HAL et AUREHAL
- 1.1 Requêtes possibles avec le module statistique de HAL
- 1.2 Listes de dépôts ou publications
- 1.3 Extraction de dépôts ou publications de types particuliers
- 1.4 Recherches et extractions de revues (référentiel revues Auréhal)
- 1.5 Recherches et extractions d'auteurs (référentiel auteur Auréhal)
- 1.6 Recherches et extractions de structures (référentiel structures Auréhal)
- 1.7 Autres types de requêtes
Dictionnaire commenté de requêtes API HAL et AUREHAL
Ces requêtes sont en cours de test et de correction
Requêtes possibles avec le module statistique de HAL
Ces requêtes sont à faire sur le portail HAL avec son compte admin (graphiques + export), il s'agit ici des statistiques "PORTAIL" (auteur, déposant, structure, collection, portail)
Liste non exhaustive
https://hal.archives-ouvertes.fr/section/statistiques
| Objectif de la requête | Requête API | champ interrogé |
|---|---|---|
| Evolution des dépôts | Le module stat donne : le nombre de dépôts de notices, le nombre de dépôts avec texte ou le cumul des 2 (cela corresponds aux widgets qu'on retrouve sur la majorité des portails) | |
| Répartition des articles dans les revues | les stats sont caclulées depuis 2011 et concernent bien les types articles uniquement (pas tous les dépôts du portail) | champ : journalTitle_s (revue : titre) |
| Répartition des (articles) / dépôts par type de publications | les stats sont caclulées depuis 2011 et concernent tous les types de publications donc tous les dépôts du portail | champ : docType_s (Type de document) |
| Répartition des dépôts par année de publication | les stats sont caclulées depuis 2011 et concernent tous les dépôts dur portail | champ : producedDateY_i (Date de publication : année) |
| Répartition des dépôts par domaine | les stats sont caclulées depuis 2011 et concernent tous les dépôts dur portail ? -> il rapporte même plus dans le cas présent | champ : level0_domain_s (Domaine racine / Code de domaines répartis par niveaux) |
Le module stat permet de faire les requêtes pour l'ESGBU
| Intitulé ESGBU | Action dans le module stats | champ/filtre à modifier |
|---|---|---|
| Nombre d'unités documentaires référencées dans le système de collecte sous forme de notices uniquement | Lancer la requête Evolution des dépôts de notices (4) avec l'année voulue | submittedDateY_i:2015 AND submitType_s:notice |
| Nombre d'unités documentaires référencées dans le système de collecte et déposées en texte intégral | Lancer la requête Evolution des dépôts de documents (5) avec l'année voulue | submittedDateY_i:2015 AND submitType_s:file |
| Accroissement annuel des unités documentaires référencées dans le système de collecte sous forme de notices uniquement | Lancer la requête Evolution des dépôts de notices (4) avec la plage de dates voulue | submittedDateY_i:[2000 TO 2015] AND submitType_s:notice |
| Accroissement annuel des unités documentaires référencées dans le système de collecte et déposées en texte intégral | Lancer la requête Evolution des dépôts de documents (5) avec la plage de dates voulue | submittedDateY_i:[2000 TO 2015] AND submitType_s:file |
| Nombre de visites sur le portail d'accès des archives ouvertes | Cette donnée n'est pas disponible par le module, demander au support les stats piwick : hal.support@ccsd.cnrs.fr | |
| Nombre de téléchargements sur le portail d'accès des archives ouvertes | Espace de sélection : dépôts du portail Entrer le filtre : submitType_s:file |
Listes de dépôts ou publications
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste de tous les dépôts d'une COMUE | Utiliser le formulaire du site web de HAL avec export plutôt ? Dans auréhal structure le niveau de structure type Comue n'est pas "encore" prévue à ce jour (4 niveaux de prévus : https://hal.archives-ouvertes.fr/page/le-referentiel-des-structures-de-recherche) |
|
| Liste des x derniers dépôts faits dans une collection par date de publication descendante
Format de réponse : csv |
Requête : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=BBB&sort=producedDate_tdate desc
Exemple (collection SIC / 30 lignes) |
AAA : code de la collection
BBB : nombre de lignes de résultats voulues |
| Liste des dépôts par labo d'une université (et uniquement des labos affiliés à l'université), par année de dépôt et par type de document déposé | Il s'agit de l'intitulé de la requête tel que formulé par le GT5 : à mon avis il n'est pas possible d'avoir tous ces résultats dans un seul export, je remplace par (voir ligne suivante) :
nombre de dépôts pour un laboratoire ou une collection pour une année par type de document Si on veut une liste : quels champs on veut ? (titre/auteur de chaque publi ?) |
|
| Nombre des dépôts présents dans une collection/portail trié par type de document
Format de réponse : XML |
Requête : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=0&facet=true&facet.field=docType_s&wt=xml
Exemple (portail/collection ens-lyon]
|
AAA : code de la collection ou du portail
BBB : année de dépôt |
| Liste des dépôts par labo d'une université (et uniquement des labos affiliés à l'université), par année de publication et par type de document déposé | Il s'agit de l'intitulé de la requête tel que formulé par le GT5 : à mon avis il n'est pas possible d'avoir tous ces résultats dans un seul export, je remplace par (voir ligne suivante) : | |
| Nombre des dépôts présents dans une collection/portail trié par type de document par date de dépôt ou de publication
Format de réponse : XML |
Requête pour une année de dépôt : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=0&fq=submittedDateY_i:BBB&facet=true&facet.field=docType_s&wt=xml
Exemple (portail/collection ens-lyon, année de dépôt 2015)
|
AAA : code de la collection ou du portail
BBB : année de dépôt (submittedDateY_i)
|
| Liste des dépôts pour une plage entre 2 années d'une structure dont les labos sont en statut OLD Format : export CSV |
Requête : api.archives-ouvertes.fr/search/hal/?omitHeader=true&wt=csv&q=*&fq=instStructId_i:AAA&fq=labStructValid_s:OLD&fq=producedDateY_i:[BBB TO CCC] |
AAA = instStructId_i BBB = année de départ CCC = année de fin |
| Liste des labos affiliés à une université (ancienne par exemple) et pas à une autre (nouvelle par exemple) Format : export CSV |
Requête : api.archives-ouvertes.fr/ref/structure/?fq=(parentDocid_i:AAA%20AND%20NOT(parentDocid_i:BBB))&fl=docid,name_s&wt=csv Exemple (Ancienne = Nancy2, Nouvelle = Lorraine) |
AAA = parentDocid_i de l'université voulue
|
| Liste des dépôts de texte intégral d'une institution pour une année Format : sortie XML |
Requête : api.archives-ouvertes.fr/search/hal/?omitHeader=true&wt=xml&q=*&fq=instStructId_i:AAA&fq=submittedDateY_i:BBB&facet=true&facet.mincount=1&facet.pivot.mincount=1&facet.limit=10000&facet.pivot=labStructName_s,submittedDateM_i&rows=0 | AAA = instStructId_i
|
| Flux rss des dépôts faits dans une collection depuis 1 mois
Format : sortie RSS Réponse limitée à 30 résultats |
Requête : api.archives-ouvertes.fr/search/hal/?q=collCode_s:(AAA)&fq=releasedDate_tdate:[NOW%2FDAY-1MONTH+TO+NOW%2FDAY%2B1DAY]&fq=submitType_s:file&fq=&rows=30&sort=submittedDate_tdate+desc&wt=rss
[NOW%2FDAY-1MONTH+TO+NOW%2FDAY%2B1DAY&fq=submitType_s:file&fq=&rows=30&sort=submittedDate_tdate+desc&wt=rss Exemple] |
AAA : le code de la collection |
Extraction de dépôts ou publications de types particuliers
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste des thèses d'une institution
Format : export csv champs exportés : halId_s,defenseDate_s,authFullName_s,thesisSchool_s,labStructAcronym_s,instStructAcronym_s,title_s,label_s Export porté à 2000 réponses |
Requête : api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%22AAA%22&wt=csv&sort=producedDate_s%20desc&rows=2000&fl=halId_s,defenseDate_s,authFullName_s,thesisSchool_s,labStructAcronym_s,instStructAcronym_s,title_s,label_s | AAA : authorityInstitution_s copier/coller la chaîne de caractère dans la liste ci-jointe |
| Des exemples pour repérer certains types de publications (ceux demandés lors des évaluations HCERES en particulier) | http://carnetist.hypotheses.org/240 | Texte de la cellule |
| Extraction des notices dont l'auteur n'a pas de lien avec la structure mais tamponnées dans la collection tout de même | Exemple |
Recherches et extractions de revues (référentiel revues Auréhal)
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste des identifiants des revues des notices non valides d'une collection Format : sortie XML |
Requête : api.archives-ouvertes.fr/search/AAA/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i | AAA = l'identifiant de la collection |
| Liste, triée par ordre de dépôt décroissante des dépôts, des articles publiées en revue, tamponnés par une collection, avec pour chacun la liste des auteurs, l'année de publication, le nom de la revue, ainsi que toutes les informations de RoMEO/SHERPA à propos de la politique éditoriale de la revue
Format : sortie XML |
Requête : api.archives-ouvertes.fr/search/?q=collCode_s:AAA%20AND%20docType_s:ART&wt=xml&sort=producedDate_s%20desc&rows=2000&fl=authFullName_s,journalTitle_s,submitType_s,journalSherpaColor_s,journalSherpaCondition_s,journalSherpaDate_s,journalSherpaPostPrint_s,journalSherpaPostRest_s,
journalSherpaPrePrint_s,journalSherpaPreRest_s,producedDateY_i [https://api.archives-ouvertes.fr/search/?q=collCode_s:3774%20AND%20docType_s:ART&wt=xml&sort=producedDate_s%20desc&rows=2000&fl=authFullName_s,journalTitle_s,submitType_s,journalSherpaColor_s,journalSherpaCondition_s,journalSherpaDate_s,journalSherpaPostPrint_s,journalSherpaPostRest_s, journalSherpaPrePrint_s,journalSherpaPreRest_s,producedDateY_i Exemple] |
AAA : collCode_s : identifiant de la collection |
Recherches et extractions d'auteurs (référentiel auteur Auréhal)
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste des chercheurs d'une structure avec indication de leur idhal ou non dans les balises xml
Format : sortie XML |
Requête : api.archives-ouvertes.fr/search/?q=AAA&rows=0&wt=xml&facet=true&facet.query=structHasAuthIdHal_fs&facet.field=structHasAuthIdHal_fs&facet.prefix=BBB_FacetSep_&facet.mincount=1&facet.limit=1000
Exemple |
AAA : le corpus de documents (*:* pour tout) BBB : structHasAuthIdHal_fs : identifiant HAL de la structure) |
| Liste de tous les chercheurs ayant créé leur CV HAL
Format : sortie XML |
Requête : api.archives-ouvertes.fr/ref/author/?q=hasCV_bool:true&rows=10000&sort=lastName_s%20asc&fl=idHal_s,idHal_i,lastName_s,firstName_s&wt=xml | Pas d'options dans la requête |
| Liste des publications d'un auteur à partir de son idhal | Entrer dans la recherche avancée de HAL la chaîne de caractère de l'idhal de l'auteur / champ IDHAL Exporter le résultat (exporte l'ensemble des résultats) : formats d'exports = ceux proposés par HAL |
Pas d'options |
Recherches et extractions de structures (référentiel structures Auréhal)
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste de toutes les structures qui dépendent d'une structure dont l'identifiant HAL est XXX | Requête : api.archives-ouvertes.fr/ref/structure/?wt=xml&q=parentDocid_i:%22AAA%22&rows=2000&fl=name_s,acronym_s,code_s,docid,address_s,url_s,country_s&sort=acronym_s%20asc | AAA : parentDocid_i |
Autres types de requêtes
| Objectif de la requête | Requête et exemple | Champs à remplacer |
|---|---|---|
| Liste des dépôts effectués dans un portail X mais non affiliés à une structure de la collection XX
Format de réponse : XML |
Requête : https://api.archives-ouvertes.fr/search/X/?q=structure_t:*%20NOT%20(XX)&wt=xml&fl=uri_s | X : code du portail XX : tous les éléments de la collection |
