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

De HAL
Sauter à la navigation Sauter à la recherche
Ligne 1 : Ligne 1 :
 
== Dictionnaire commenté de requêtes API HAL et AUREHAL (29/04/2016 En construction)==
 
== Dictionnaire commenté de requêtes API HAL et AUREHAL (29/04/2016 En construction)==
 
+
=== Listes de dépôts ou publications ===
 
{| class="wikitable"  
 
{| class="wikitable"  
 
|-  
 
|-  
Ligne 10 : Ligne 10 :
 
|| Pas d'options
 
|| Pas d'options
 
|-
 
|-
|'''Liste des x dernières publications déposées pour une structure donnée'''  
+
|'''Liste des x derniers dépôts faits dans une collection par date de publication descendante'''  
Format de réponse :  
+
Format de réponse : csv
 
|| Requête : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=BBB&sort=producedDate_tdate desc  
 
|| Requête : api.archives-ouvertes.fr/search/AAA/?q=*:*&rows=BBB&sort=producedDate_tdate desc  
[https://api.archives-ouvertes.fr/search/SIC/?q=*:*&rows=30&wt=csv&sort=producedDate_tdate desc Exemple]
+
[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
 
|| AAA : code de la collection
 
BBB : nombre de lignes de résultats voulues
 
BBB : nombre de lignes de résultats voulues
Ligne 41 : Ligne 41 :
 
[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]  
 
[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
 
|| AAA = instStructId_i <br /> BBB = Année voulue
 +
|-
 +
|'''Flux rss des dépôts faits dans une collection depuis 1 mois'''
 +
Format : sortie RSS
 +
||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]
 +
|| AAA : le code de la collection
 +
|}
 +
 +
=== Listes de dépôts ou publications de types particuliers ===
 +
{| class="wikitable"
 +
|-
 +
|'''Liste de toutes les thèses de doctorat d'une université'''
 +
|| Requête : api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%22AAA%22&wt=xml&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:%22300297%22&wt=xml&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 : authorityInstitution_s
 +
|-
 +
| 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
 +
|}
 +
 +
=== Recherches et extractions de revues (référentiel revues Auréhal) ===
 +
{| class="wikitable"
 
|-
 
|-
 
| '''Liste des identifiants des revues des notices non valides d'une collection''' <br />
 
| '''Liste des identifiants des revues des notices non valides d'une collection''' <br />
Ligne 47 : Ligne 68 :
 
[http://api.archives-ouvertes.fr/search/3774/?q=*&rows=0&wt=xml&fq=journalValid_s:INCOMING&facet=true&facet.field=journalId_i Exemple]  
 
[http://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
 
|| 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
 +
[http://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) ===
 +
{| class="wikitable"
 
|-
 
|-
 
| '''Liste des chercheurs d'une structure avec indication de leur idhal ou non dans les balises xml'''  
 
| '''Liste des chercheurs d'une structure avec indication de leur idhal ou non dans les balises xml'''  
Ligne 59 : Ligne 92 :
 
||AAA : le corpus de documents (*:* pour tout) <br />
 
||AAA : le corpus de documents (*:* pour tout) <br />
 
BBB : structHasAuthIdHal_fs : identifiant HAL de la structure)
 
BBB : structHasAuthIdHal_fs : identifiant HAL de la structure)
|-
 
|'''Liste de toutes les thèses de doctorat d'une université'''
 
|| Requête : api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%22AAA%22&wt=xml&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:%22300297%22&wt=xml&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 : authorityInstitution_s
 
|-
 
|  '''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
 
[http://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
 
 
|-
 
|-
 
|'''Liste de tous les chercheurs ayant créé leur CV HAL'''
 
|'''Liste de tous les chercheurs ayant créé leur CV HAL'''
Ligne 80 : Ligne 99 :
 
[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]  
 
[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]  
 
|| Pas d'options dans la requête
 
|| Pas d'options dans la requête
|-
 
|'''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
 
|-
 
| 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 publications d'un auteur à partir de son idhal
 
| Liste des publications d'un auteur à partir de son idhal
Ligne 92 : Ligne 104 :
 
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
 
|| Pas d'options
 +
|}
 +
 +
=== Recherches et extractions de structures (référentiel structures Auréhal) ===
 +
{| class="wikitable"
 
|-
 
|-
|'''Flux rss des dépôts faits dans une collection depuis 1 mois'''
+
|'''Liste de toutes les structures qui dépendent d'une structure dont l'identifiant HAL est XXX'''  
Format : sortie RSS
+
|| 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
||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
+
[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]  
[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]
+
|| AAA : parentDocid_i
|| AAA : le code de la collection
 
 
|}
 
|}

Version du 11 mai 2016 à 09:09

Dictionnaire commenté de requêtes API HAL et AUREHAL (29/04/2016 En construction)

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 ?

Désigner une comue = simplement univA+univB+univC etc... ? Dans auréhal structure la structure 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)

Pas d'options
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é
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é Texte de la cellule Texte de la cellule
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]

Exemple

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
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

Exemple (Ancienne = Nancy2, Nouvelle = Lorraine)

AAA = parentDocid_i de l'université voulue
BBB = parentDocid_i de l'université non voulue
Liste des dépôts de texte intégral pour tous les labos dépendant d'une institution pour une année donnée

Format : sortie XML
limitation du résultat à 10000 lignes

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

Exemple

AAA = instStructId_i
BBB = Année voulue
Flux rss des dépôts faits dans une collection depuis 1 mois

Format : sortie RSS

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]

AAA : le code de la collection

Listes de dépôts ou publications de types particuliers

Liste de toutes les thèses de doctorat d'une université Requête : api.archives-ouvertes.fr/search/?q=docType_s:THESE%20AND%20authorityInstitution_s:%22AAA%22&wt=xml&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 : authorityInstitution_s
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

Recherches et extractions de revues (référentiel revues Auréhal)

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

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
limitation du résultat à 2000 lignes

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 [http://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)

Liste des chercheurs d'une structure avec indication de leur idhal ou non dans les balises xml

Format : sortie XML
limitation du résultat à 10000 lignes

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
Lecture des résultats
Pour les auteurs 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

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
limitation du résultat à 10000 lignes

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

Exemple

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)

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

Exemple

AAA : parentDocid_i