Requêtes sur les ressources de HAL

Remarques générales

Les champs retournés par défaut sont docid, label_s et uri_s

Les résultats sont limités à 30 lignes par défaut

Le format de retour par défaut est JSON (installer un visualiseur json dans son navigateur)

Les requêtes ci-dessous sont toutes appliquées à une collection (ou un portail), on peut donc changer cet identifiant pour appliquer la requête à son contexte

Requêtes simples pour récupérer des listes

Liste des dépôts d'une institution ou d'un regroupement

Dans ce cas on utilise simplement l'identifiant de l'institution. Dans Auréhal le niveau regroupement existe : https://doc.archives-ouvertes.fr/gerer-un-portail/referentiels/structures-de-recherche/.

La configuration du regroupement se fait donc dans Auréhal

Exemple pour le regroupement Comue Paris-Est (https://aurehal.archives-ouvertes.fr/structure/read/id/303512)

https://api.archives-ouvertes.fr/search/?q=structId_i:303512

Liste des documents en accès ouvert d'une structure

Documents en accès ouvert : soit le plein texte est dans Hal, soit il est sur le web via unpaywall, soit dans ArXiv soit dans Pubmed

https://api.archives-ouvertes.fr/search/?&wt=xml&fq=structId_i:303512&fq=(submitType_s:file OR linkExtId_s:(openaccess OR arxiv OR pubmedcentral))

Liste des documents qui ne sont pas en accès ouvert d'une structure

https://api.archives-ouvertes.fr/search/?fq=structId_i:81173&fq=-(submitType_s:file%20OR%20linkExtId_s:(arxiv%20OR%20pubmedcentral%20OR%20openaccess))&fl=uri_s

Export des 50 derniers dépôts faits dans une collection par date de publication descendante

le filtre de tri est producedDate_tdate = date de publication

https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=50&wt=csv&sort=producedDate_tdate%20desc 

Cette requête rapporte 50 résultats dans un export CSV

Si on fait la requête au format xml on voit le numreponse à 6122 => si on veut tout voir on peut mettre rows=6200.

Export des 50 derniers dépôts faits dans une collection par date de dépôt descendante

le filtre de tri est submittedDate_s = date de dépôt

https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=100&wt=csv&fl=submittedDate_s,producedDate_s,label_s&sort=submittedDate_s%20desc

Flux rss des dépôts faits dans une collection depuis 1 mois

Pour avoir la sortie sous la forme d'un flux RSS il faut indiquer wt=rss

https://api.archives-ouvertes.fr/search/hal/?q=collCode_s:UNIV-ORLEANS&fq=releasedDate_tdate:[NOW%2FDAY-1MONTH+TO+NOW%2FDAY%2B1DAY]&fq=&rows=30&sort=submittedDate_tdate+desc&wt=rss

le champ rows indique le nombre de résultat qu'on souhaite récupérer (30 ici)

Flux rss des 3 derniers dépôts avec texte intégral

https://api.archives-ouvertes.fr/search/pasteur/?wt=rss&q=*&sort=submittedDate_tdate+desc&fq=producedDate_tdate:[NOW-1YEARS%20TO%20NOW]&fq=submitType_s:file&fq=collCode_s%3APASTEUR&fq=NOT+status_i%3A111&rows=3

Dans le champ date, on récupère les 12 derniers mois (de moins 1 an à aujourd'hui) et on limite à 3 résultats (rows=3)

Liste des thèses d'une institution

http://api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%22Université%20d'Orléans%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

la liste des champs exportés est : halId_s,defenseDate_s,authFullName_s,thesisSchool_s,labStructAcronym_s,instStructAcronym_s,title_s,label_s

changer rows=2000 pour le nombre de réponses

Il faut indiquer le champ "authorityInstitution_s" : trouver le bon intitulé dans https://api.archives-ouvertes.fr/search/?q=*%3A*&rows=0&wt=xml&indent=true&facet=true&facet.field=authorityInstitution_s

Requêtes sur les collections

Récupérer la liste des collections rattachées à son institution

Il s'agit là de récupérer par l'API la même liste que celle possible sur le portail : https://hal-univ-orleans.archives-ouvertes.fr/browse/scollection

https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=*:*&rows=0&wt=xml&indent=true&facet=true&facet.field=collIsParentOfCategoryColl_fs&facet.prefix=UNIV-ORLEANS

Cette requête, comme la page du portail, liste les collections pour lesquelles dans leur configuration il a été complété le champ : Identifiant des collections supérieures.

Récupérer la liste des collections qui contiennent au moins un dépôt de son institution

https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=*%3A*&rows=0&wt=xml&indent=true&facet=true&facet.field=collIsParentOfCategoryColl_fs

Le champs collIsParentOfCategoryColl_fs contient les données suivantes : Collection parente + _FacetSep_ + type collection parente + _JoinSep_ + Code de la collection + _FacetSep_ + Nom de la collection

Récupérer la liste des dépôts d'une structure absents d'une collection (qui n'ont pas été tamponnés)

https://api.archives-ouvertes.fr/search/?q=*:*&wt=xml&fq=structId_i:2269&fq=-collCode_s:CREAAH

Cette dernière requête retourne la liste des dépôts de la structure 2269 qui n'ont pas été tamponnés dans la collection CREAAH.

Requêtes d'analyse du contenu par type de documents

Connaître le cumul des dépôts de sa collection répartis par type de document

Requête à facette affichant une collection, le nombre d’occurrence par type de document

 https://api.archives-ouvertes.fr/search/?q=*&fq=collCode_s:UNIV-ORLEANS&fq=NOT+status_i%3A111&start=0&rows=0&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.field=docType_s&facet.sort=count

Les cumuls sont calculés depuis 2011.

liste des types de documents dans HAL (41 en tout) : https://api.archives-ouvertes.fr/ref/doctype

Connaître le nombre total de dépôt année par année dans sa collection. Et pour chaque année la répartition des dépôts par type de document

Requête affichant le nombre de dépôt par année de publication

https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=*:*&wt=xml&rows=0&facet=true&facet.pivot=submittedDateY_i,submitType_s,docType_s

Pour chaque année l'arbre xml affiche le nombre total de dépôt, puis l’élément pivot détaille le contenu annuel type de document par type de document.

Connaître le nombre de dépôt pour une année donnée dans sa collection présenté par type de documents

https://api.archives-ouvertes.fr/search/univ-orleans/?q=*:*&rows=0&fq=submittedDateY_i:2019&facet=true&facet.field=docType_s&wt=xml

Méthode pour repérer les types d'articles (extractions HCERES)

Article du blog Carnet'IST. Proposition de requêtes sur le site web HAL pour distinguer, entre autres, les 4 types d’articles suivants : ACL; ACLN, ACSL, AV ou TRANSF

http://carnetist.hypotheses.org/240

Requêtes d'analyse du contenu par domaine

Connaître le cumul des dépôts de sa collection répartis par domaines

Requête affichant le nombre de notice par domaine pour sa collection

https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=%2A&fq=NOT+status_i%3A111&start=0&rows=0&wt=phps&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.field=level0_domain_s&facet.sort=count

Liste des domaines de HAL (393 en mai 2019) : http://api.archives-ouvertes.fr/ref/domain/?q=*:*&rows=400

Requêtes d'analyse du contenu des revues (journal)

Connaître le nombre d'articles déposés par titre de revue dans sa collection

La requête affiche pour chaque revue le nombre d'articles déposés dans la collection HAL.

 https://api.archives-ouvertes.fr/search/?q=*&fq=collCode_s:UNIV-ORLEANS&fq=NOT+status_i%3A111&start=0&rows=0&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.field=journalTitle_s&facet.sort=count

Le cumul est calculé depuis 2011 et ne concerne que le type "articles".

Requêtes d'analyse de ses structures

Liste des structures affiliées à une institution et pas à une autre

Il s'agit par exemple de récupérer la liste des laboratoires attachés à l'université de Nancy et pas à l'université de Lorraine

https://api.archives-ouvertes.fr/ref/structure/?fq=(parentDocid_i:300292%20AND%20NOT(parentDocid_i:413289))&fl=docid,name_s&wt=csv

Pour cette requêtes il faut récupérer dans Auréhal structure les identifiants des 2 structures à analyser

Liste de toutes les structures qui dépendent d'une structure

Requête sur le référentiel structure d'Auréhal

http://api.archives-ouvertes.fr/ref/structure/?q=parentDocid_i:"74911"&rows=300&fl=name_s,acronym_s,code_s,docid,address_s,url_s,country_s&sort=acronym_s asc 

• parentDocid = 74911 (université d'Angers)
• rows = 300. Permet d'avoir toutes les réponses, dans le résultat le numFound = 279.
• fl=name_s,acronym_s,code_s,docid,address_s,url_s,country_s : liste des champs demandé en réponse
• sort=acronym_s asc : trié par ordre alphabétique de l'acronyme

Requêtes d'analyse des contributions

Nombre de dépôt par contributeur dans un portail, classés par année de dépôt

Requête à facette affichant par année, la liste des contributeurs déposant et le nombre de dépôt associé à chaque contributeur

https://api.archives-ouvertes.fr/search/univ-orleans/?q=*:*&facet=true&facet.pivot=submittedDateY_i,contributorFullName_s&rows=0&wt=xml&facet.limit=1000

Requêtes d'analyse des auteurs

Liste des auteurs dont une publication au moins est affiliée à une structure avec indication de leur IDHAL ou de l'absence d'IDHAL

Requête à facette listant les auteurs affiliés par un ou plusieurs dépôt à une structure

https://api.archives-ouvertes.fr/search/?q=*:*&rows=0&wt=xml&facet=true&facet.query=structHasAuthIdHal_fs&facet.field=structHasAuthIdHal_fs&facet.prefix=129439_FacetSep_&facet.mincount=1&facet.limit=1000

ou

https://api.archives-ouvertes.fr/search/?q=*:*&rows=0&facet=true&facet.field=structHasAuthIdHal_fs&facet.prefix=226306_&wt=xml

Le champ facet.prefix indique l'identifiant de la structure d'affiliation voulue (à trouver dans Aurehal structure)

https://api.archives-ouvertes.fr/search/?q=*:*&rows=0&facet=true&facet.field=structHasAuthIdHal_fs&facet.prefix=245758_&wt=xml&fq=structId_i:245758

Pour ceux qui ont un idhal la chaine le représentant est entre _JoinSep_ et _FacetSep_

• Exemple avec Idhal : 226306_FacetSep_Maison des Sciences de l'Homme de Dijon_JoinSep_lsaligny_FacetSep_Saligny Laure
• Exemple sans Idhal : 226306_FacetSep_Maison des Sciences de l'Homme de Dijon_JoinSep__FacetSep_Alazard Céline

Nombre de publications scientifiques hors vulgarisation des auteurs d'une collection et d'un laboratoire spécifique par année universitaire de publication (2015-2016) en affichant uniquement les auteurs affiliés au laboratoire demandé et non pas tous les auteurs présents dans la collection

Requête indiquant le nombre de publications scientifiques par auteurs affiliés à une structure spécifique (&fq=authStructId_i:54305 et &facet.field=authIdHasPrimaryStructure_fs&facet.contains=_JoinSep_54305_FacetSep), pour une année universitaire donnée (&fq=producedDate_tdate:), hors vulgarisation (&fq=popularLevel_s:0)

https://api.archives-ouvertes.fr/search/UNIV-REUNION/?q=collection_t:LIM&fq=authStructId_i:54305&fq=popularLevel_s:0&fq=producedDate_tdate:[2015-07-31T00:00:00Z TO 2016-07-31T00:00:00Z]&rows=0&indent=true&facet=true&sort=producedDate_tdate%20asc&facet.field=authIdHasPrimaryStructure_fs&facet.contains=_JoinSep_54305_FacetSep&wt=xml

Détails des paramètres :

• q=collection_t:LIM
• fq=authStructId_i:54305
• fq=popularLevel_s:0
• fq=producedDate_tdate:[2015-07-31T00:00:00Z%20TO%202016-07-31T00:00:00Z]
• rows=0
• indent=true
• &sort=producedDate_tdate%20asc
• facet.field=authIdHasPrimaryStructure_f
• facet.contains=_JoinSep_54305_FacetSep
• wt=xml

Liste des auteurs ayant un dépôt ou plusieurs affilié à une structure ayant créé leur CV HAL

Attention, la requête est dans le référentiel auteur, donc n'a pas de rapport avec les documents. De plus structureId_i dans le référentiel auteur est l'organisme payeur - pas du tout la même chose que l'affiliation d'un auteur à une publication.

Requête effectuée dans le référentiel Auréhal Auteurs

http://api.archives-ouvertes.fr/ref/author/?q=structureId_i:198056 AND hasCV_bool:true&rows=10000&sort=lastName_s asc&fl=idHal_s,idHal_i,lastName_s,firstName_s

Il est également possible de faire cette recherche directement sur Auréhal (https://aurehal.archives-ouvertes.fr/author/index) en indiquant dans le champ de recherche les valeurs de la requête : structureId_i:198056 AND hasCV_bool:true

Autre solution

1. Trouver tous les auteurs affiliés à la structure :

https://api.archives-ouvertes.fr/search/?indent=true&facet.field=structHasAuthIdHal_fs&facet.prefix=44429_FacetSep_&facet=on&indent=on&q=*:*&rows=0&wt=json&facet.limit=5000&facet.mincount=1

dans le résultat prendre ceux qui ont un idhal eg 44429_FacetSep_Laboratoire Interdisciplinaire Solidarités, Sociétés, Territoires_JoinSep_michel-grossetti_FacetSep_Grossetti Michel"

2. chercher dans le référentiel auteur

pour chaque idhal chercher si l'auteur a un CV :

https://api.archives-ouvertes.fr/ref/author/?wt=xml&q=(idHal_s:michel-grossetti AND hasCV_bool:true)

si il y a 1 résultat: l'auteur a un CV

Requêtes sur le contrôle qualité du contenu

Liste des dépôts effectués dans un portail X mais non affiliés à une structure de la collection XX

L'objectif est d'avoir les dépôts qui sont passés par un portail mais qui ne sont pas affiliés à une structure relevant de ce portail (des erreurs de dépôt)

https://api.archives-ouvertes.fr/search/amu/?q=structure_t:*%20NOT%20%28%22Universit%C3%A9%20de%20Provence%20-%20Aix-Marseille%20I%22%20OR%20%22Universit%C3%A9%20de%20la%20M%C3%A9diterran%C3%A9e%20-%20Aix-Marseille%20II%22%20OR%20%22Universit%C3%A9%20Paul%20C%C3%A9zanne%20-%20Aix-Marseille%20III%22%20OR%20%22Universit%C3%A9%20de%20Provence%20-%20Aix-Marseille%201%22%20OR%20%20%22Universit%C3%A9%20de%20la%20M%C3%A9diterran%C3%A9e%20-%20Aix-Marseille%202%22%20OR%20%20%22Universit%C3%A9%20Paul%20C%C3%A9zanne%20-%20Aix-Marseille%203%22%20OR%20%22Aix-Marseille%20Universit%C3%A9%20-%20AMU%22%20OR%20%20%22PRES%20Aix%20Marseille%20Universit%C3%A9%22%20OR%20%22Aix%20Marseille%20Universit%C3%A9%22%29&wt=xml&fl=uri_s

Requêtes qui restent à créer ou finaliser

Récupérer la lise de tous les "codes de collection" (soit collCode_s) de type "REVUE" (soit collCategory_s:REVUE)

https://api.archives-ouvertes.fr/search/?q=*:*&rows=0&wt=xml&fq=collCategory_s:REVUE&facet=true&facet.field=collCode_s&facet.limit=10000

https://api.archives-ouvertes.fr/search/?q=(collCategory_s:REVUE%20NOT%20collCategory_s:(SET%20OR%20COLLOQUE%20OR%20ECOLE%20OR%20PRES%20OR%20UNIV%20OR%20LABO%20OR%20THEME%20OR%20INSTITUTION%20OR%20AUTRE))&rows=0&wt=json&facet=true&facet.field=collCode_s&facet.limit=10000&facet.mincount=1&facet.field=collCategory_s

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é

L'objectif est d'avoir les dépôts qui sont passés par un portail mais qui ne sont pas affiliés à une structure relevant de ce portail (des erreurs de dépôt)

https://api.archives-ouvertes.fr/search/

Liste des dépôts pour une plage entre 2 années d'une structure dont les labos sont en statut OLD

L'objectif est d'avoir les dépôts qui sont passés par un portail mais qui ne sont pas affiliés à une structure relevant de ce portail (des erreurs de dépôt)

https://api.archives-ouvertes.fr/search/hal/?omitHeader=true&wt=csv&q=*&fq=instStructId_i:300297&fq=labStructValid_s:OLD&fq=producedDateY_i:%5B2000%20TO%202014%5D

Liste des dépôts de texte intégral d'une institution pour une année

https://api.archives-ouvertes.fr/search/hal/?omitHeader=true&wt=xml&q=*&fq=instStructId_i:300297&fq=submittedDateY_i:2015&facet=true&facet.mincount=1&facet.pivot.mincount=1&facet.limit=10000&facet.pivot=labStructName_s,submittedDateM_i&rows=0

Liste des identifiants des revues des notices non valides d'une collection

https://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

Liste des identifiants des revues des notices non valides d'une collection

https://api.archives-ouvertes.fr/search/3774/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i

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

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

Liste des publications d'un auteur à partir de son idhal

Aller sur le site web du portail : 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