Requêtes sur les ressources de HAL : Différence entre versions

De HAL
Sauter à la navigation Sauter à la recherche
 
(155 révisions intermédiaires par 4 utilisateurs non affichées)
Ligne 1 : Ligne 1 :
−
== 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 statistiques de HAL ===
+
=== Remarques générales ===
−
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) <br />
+
Les champs retournés par défaut sont docid, label_s et uri_s
−
Liste non exhaustive <br /> https://hal.archives-ouvertes.fr/section/statistiques
 
−
{| class="wikitable"
 
−
|-
 
−
! 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)
 
−
https://api.archives-ouvertes.fr/search/?q=%2A&fq=collCode_s%3AUNIV-ORLEANS&fq=NOT+status_i%3A111&start=0&rows=0&wt=phps&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.field=journalTitle_s&facet.sort=count
 
−
|| 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
 
−
https://api.archives-ouvertes.fr/search/?q=*&fq=collCode_s%3AUNIV-ORLEANS&fq=NOT+status_i%3A111&start=0&rows=0&wt=phps&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.field=docType_s&facet.sort=count
 
−
|| 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
 
−
https://api.archives-ouvertes.fr/search/?q=%2A&fq=collCode_s%3AUNIV-ORLEANS&fq=NOT+status_i%3A111&start=0&rows=0&wt=phps&omitHeader=true&facet.mincount=1&facet.limit=10000&facet=true&facet.pivot.mincount=1&facet.pivot={!key=pivot}producedDateY_i,submitType_s&facet.sort=count ERROR
 
−
|| 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
 
−
https://api.archives-ouvertes.fr/search/?q=%2A&fq=collCode_s%3AUNIV-ORLEANS&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
 
−
|| champ : level0_domain_s (Domaine racine / Code de domaines répartis par niveaux)
 
−
|}
 
−
=== Requêtes pour l'ESGBU ===
 
−
'''Le module statistiques permet de faire les requêtes pour l'ESGBU'''
 
−
{| class="wikitable"
 
−
|-
 
−
! 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
 
−
Voir le chiffre qui se met à jour "Nombre de ressources répondant aux critères : XXX"
 
  
−
|submittedDateY_i:2015 AND submitType_s:notice
+
Les résultats sont limités à 30 lignes par défaut
−
|-
 
−
|'''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
 
−
Voir le chiffre qui se met à jour "Nombre de ressources répondant aux critères : XXX"
 
−
|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
 
−
Voir le chiffre qui se met à jour "Nombre de ressources répondant aux critères : XXX"
 
−
|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
 
−
Voir le chiffre qui se met à jour "Nombre de ressources répondant aux critères : XXX"
 
−
|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 piwik : 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 <br />
 
−
Entrer le filtre : submitType_s:file <br />
 
−
Aller sur l'onglet Consultation des ressources <br />
 
−
Sélectionner : type=téléchargement du fichier principal <br />
 
−
Période : pour l'année 2015 complète, sélectionner dans le widget du 31/12/2014 au 31/12/2015
 
−
|
 
−
|}
 
  
−
=== Listes de dépôts ou publications ===
+
Le format de retour par défaut est JSON (installer un visualiseur json dans son navigateur)
−
{| class="wikitable"
 
−
|-
 
−
! 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 ? <br />
 
−
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)<br />
 
−
Recherche avancée de HAL : sélectionner le champ d'interrogation "Structure : Identifiant HAL de la structure" : entrer par exemple "300297 OR 300298". Exporter le résultat.<br />
 
−
PB la requête rapporte 6303 résultat, l'export compte 2000 lignes (export limité en nombre de lignes peut être ?)
 
−
||
 
−
|-
 
−
|'''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&wt=csv&sort=producedDate_tdate desc
 
−
[https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=30&wt=csv&sort=producedDate_tdate%20desc 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
 
−
[https://api.archives-ouvertes.fr/search/ens-lyon/?q=*:*&rows=0&facet=true&facet.field=docType_s&wt=xml Exemple] (portail/collection ens-lyon]
 
−
<br />
 
−
[https://hal.archives-ouvertes.fr/page/les-types-de-publication-acceptes-dans-hal liste des types de documents]
 
−
|| 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
 
−
[https://api.archives-ouvertes.fr/search/ens-lyon/?q=*:*&rows=0&fq=submittedDateY_i:2015&facet=true&facet.field=docType_s&wt=xml Exemple] (portail/collection ens-lyon, année de dépôt 2015)
 
−
<br />
 
−
'''Requête pour les dépôts publiés une année précise (O réponses / pb requête)''' : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=0&fq=producedDateY_i=CCC&facet=true&facet.field=docType_s&wt=xml
 
−
<br />
 
−
[https://api.archives-ouvertes.fr/search/ens-lyon/?q=*:*&rows=0&fq=producedDateY_i=2015&facet=true&facet.field=docType_s&wt=xml Exemple] (portail/collection ens-lyon, année de publication 2015)
 
−
|| AAA : code de la collection ou du portail
 
−
BBB : année de dépôt (submittedDateY_i)
 
−
<br />
 
−
CCC : année de publication (producedDateY_i)
 
−
|-
 
−
|-
 
−
|| '''Liste des dépôts pour une plage entre 2 années d'une structure dont les labos sont en statut OLD''' <br /> 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] <br />
 
−
[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 Exemple]
 
−
|| AAA = instStructId_i <br /> BBB = année de départ <br /> CCC = année de fin
 
−
|-
 
−
| '''Liste des labos affiliés à une université (ancienne par exemple) et pas à une autre (nouvelle par exemple)''' <br>
 
−
Format : export CSV <br />
 
−
Champs du fichier : docid, name_s
 
−
|| Requête : api.archives-ouvertes.fr/ref/structure/?fq=(parentDocid_i:AAA%20AND%20NOT(parentDocid_i:BBB))&fl=docid,name_s&wt=csv <br />
 
−
[https://api.archives-ouvertes.fr/ref/structure/?fq=(parentDocid_i:300292%20AND%20NOT(parentDocid_i:413289))&fl=docid,name_s&wt=csv Exemple] (Ancienne = Nancy2, Nouvelle = Lorraine)
 
−
|| AAA = parentDocid_i de l'université voulue
 
−
<br /> BBB = parentDocid_i de l'université non voulue
 
−
|-
 
−
| '''Liste des dépôts de texte intégral d'une institution pour une année''' <br />
 
−
Format : sortie XML <br />
 
−
limitation du résultat à 10000 lignes <br />
 
−
||'''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
 
−
[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 Exemple]
 
−
|| AAA = instStructId_i
 
−
<br /> BBB = Année voulue
 
−
|-
 
−
|'''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
 
−
[https://api.archives-ouvertes.fr/search/hal/?q=collCode_s:(UNIV-ORLEANS)&fq=releasedDate_tdate:[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
 
−
|}
 
  
−
=== Recherche et extraction de dépôts ou publications ===
+
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
−
==== Liste des thèses d'une institution ====
 
−
==== Repérer certains types de publications (ex HCERES) ====
 
−
==== Dépôts effectués dans un portail X mais non affiliés à une structure de la collection XX ====
 
  
−
{| class="wikitable"
+
== Requêtes simples pour récupérer des listes ==
−
|-
+
=== Liste des dépôts d'une institution ou d'un regroupement ===
−
! Objectif de la requête !!  Requête et exemple !!  Champs à remplacer
+
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/.
−
|-
 
−
|''' 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
 
−
[http://api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%Université%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 Exemple]
 
−
|| AAA : [https://api.archives-ouvertes.fr/search/?q=*%3A*&rows=0&wt=xml&indent=true&facet=true&facet.field=authorityInstitution_s 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 http://carnetist.hypotheses.org/240] || Texte de la cellule
 
−
|-
 
−
|'''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
 
−
[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 Exemple]
 
−
|| X : code du portail<br /> XX : tous les éléments de la collection
 
−
|}
 
  
−
=== Recherches et extractions de revues (référentiel revues Auréhal) ===
+
La configuration du regroupement se fait donc dans Auréhal
−
{| class="wikitable"
 
−
|-
 
−
! Objectif de la requête !!  Requête et exemple !!  Champs à remplacer
 
−
|-
 
−
| '''Liste des identifiants des revues des notices non valides d'une collection''' <br />
 
−
Format : sortie XML <br />
 
−
||  Requête : api.archives-ouvertes.fr/search/AAA/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i
 
−
[https://api.archives-ouvertes.fr/search/3774/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i Exemple]
 
−
|| 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 <br />
 
−
limitation du résultat à 2000 lignes <br />
 
−
|| 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) ===
+
Exemple pour le regroupement Comue Paris-Est (https://aurehal.archives-ouvertes.fr/structure/read/id/303512)
−
{| class="wikitable"  
+
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/?q=structId_i:303512</pre>
−
|-  
+
 
−
! Objectif de la requête !!  Requête et exemple !!  Champs à remplacer
+
=== 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
−
| '''Liste des chercheurs d'une structure avec indication de leur idhal ou non dans les balises xml'''  
+
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/?&wt=xml&fq=structId_i:303512&fq=(submitType_s:file OR linkExtId_s:(openaccess OR arxiv OR pubmedcentral))</pre>
−
Format : sortie XML <br />  
+
 
−
limitation du résultat à 10000 lignes <br />
+
=== Liste des documents qui ne sont pas en accès ouvert d'une structure===
−
|| 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
+
<pre style="white-space:pre-wrap;">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</pre>
−
[http://api.archives-ouvertes.fr/search/?q=*:*&rows=0&wt=xml&facet=true&facet.query=structHasAuthIdHal_fs&facet.field=structHasAuthIdHal_fs&facet.prefix=226306_FacetSep_&facet.mincount=1&facet.limit=1000 Exemple] <br />
+
 
−
''Lecture des résultats'' <br />
+
 
−
Pour les auteurs qui ont un idhal la chaine le représentant est entre _JoinSep_ et _FacetSep_ <br />
+
=== Export des 50 derniers dépôts faits dans une collection par date de publication descendante ===
−
Exemple avec Idhal : 226306_FacetSep_Maison des Sciences de l'Homme de Dijon_JoinSep_'''lsaligny'''_FacetSep_Saligny Laure<br />
+
le filtre de tri est producedDate_tdate = date de publication
−
Exemple sans Idhal : 226306_FacetSep_Maison des Sciences de l'Homme de Dijon_JoinSep__FacetSep_Alazard Céline
+
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=50&wt=csv&sort=producedDate_tdate%20desc </pre>
−
||AAA : le corpus de documents (*:* pour tout) <br />
+
 
−
BBB : structHasAuthIdHal_fs : identifiant HAL de la structure)
+
Cette requête rapporte 50 résultats dans un export CSV
−
|-
+
 
−
|'''Liste de tous les chercheurs ayant créé leur CV HAL'''
+
Si on fait la requête au format xml on voit le numreponse à 6122 => si on veut tout voir on peut mettre rows=6200.
−
Format : sortie XML <br />
+
 
−
limitation du résultat à 10000 lignes <br />
+
=== Export des 50 derniers dépôts faits dans une collection par date de dépôt descendante ===
−
|| 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
+
le filtre de tri est submittedDate_s = date de dépôt
−
[http://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 Exemple]
+
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=100&wt=csv&fl=submittedDate_s,producedDate_s,label_s&sort=submittedDate_s%20desc</pre>
−
|| Pas d'options dans la requête
+
 
−
|-
+
=== Flux rss des dépôts faits dans une collection depuis 1 mois ===
−
| Liste des publications d'un auteur à partir de son idhal
+
Pour avoir la sortie sous la forme d'un flux RSS il faut indiquer wt=rss
−
|| Entrer dans la recherche avancée de HAL la chaîne de caractère de l'idhal de l'auteur / champ IDHAL <br />
+
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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 ===
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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 ===
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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 ===
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=*%3A*&rows=0&wt=xml&indent=true&facet=true&facet.field=collIsParentOfCategoryColl_fs</pre>
 +
 
 +
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) ===
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/?q=*:*&wt=xml&fq=structId_i:2269&fq=-collCode_s:CREAAH</pre>
 +
 
 +
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
 +
<pre style="white-space:pre-wrap;"> 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</pre>
 +
 
 +
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
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/UNIV-ORLEANS/?q=*:*&wt=xml&rows=0&facet=true&facet.pivot=submittedDateY_i,submitType_s,docType_s</pre>
 +
 
 +
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 ===
 +
 
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/univ-orleans/?q=*:*&rows=0&fq=submittedDateY_i:2019&facet=true&facet.field=docType_s&wt=xml</pre>
 +
 
 +
=== 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
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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.
 +
<pre style="white-space:pre-wrap;"> 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</pre>
 +
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
 +
 
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/ref/structure/?fq=(parentDocid_i:300292%20AND%20NOT(parentDocid_i:413289))&fl=docid,name_s&wt=csv</pre>
 +
 
 +
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
 +
<pre style="white-space:pre-wrap;">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 </pre>
 +
 
 +
*  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
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/univ-orleans/?q=*:*&facet=true&facet.pivot=submittedDateY_i,contributorFullName_s&rows=0&wt=xml&facet.limit=1000</pre>
 +
 
 +
== 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
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
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)
 +
 
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
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
 +
 
 +
[[File:Hal_requête_CV.png|800px]]
 +
 
 +
 
 +
=== 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)
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
== 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) ===
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/?q=*:*&rows=0&wt=xml&fq=collCategory_s:REVUE&facet=true&facet.field=collCode_s&facet.limit=10000</pre>
 +
 
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
=== 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)
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/</pre>
 +
 
 +
=== 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)
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
=== Liste des dépôts de texte intégral d'une institution pour une année ===
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
=== Liste des identifiants des revues des notices non valides d'une collection ===
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
=== Liste des identifiants des revues des notices non valides d'une collection ===
 +
<pre style="white-space:pre-wrap;">https://api.archives-ouvertes.fr/search/3774/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i</pre>
 +
 
 +
=== 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 ===
 +
<pre style="white-space:pre-wrap;">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</pre>
 +
 
 +
=== 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 <br />
 
Exporter le résultat (exporte l'ensemble des résultats) : formats d'exports = ceux proposés par HAL
 
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) ===
 
−
{| class="wikitable"
 
−
|-
 
−
! 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
 
−
[http://api.archives-ouvertes.fr/ref/structure/?wt=xml&q=parentDocid_i:%22XXX%22&rows=2000&fl=name_s,acronym_s,code_s,docid,address_s,url_s,country_s&sort=acronym_s%20asc Exemple]
 
−
|| AAA : parentDocid_i
 
−
|}
 

Version actuelle datée du 11 janvier 2022 à 13:53

Sommaire

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

Hal requête CV.png


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

Récupérée de « https://wiki.ccsd.cnrs.fr/wikis/hal/index.php?title=Requêtes_sur_les_ressources_de_HAL&oldid=1299 »