Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015
Transcript of Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015
![Page 1: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/1.jpg)
JOURNÉE DE "FAMILIARISATION" AVEC LES
NOUVELLES API DE HAL V3
Organisée par le réseau métier ARAMIS
Villeurbanne - 2015-02-25 http://aramis.resinfo.org/wiki/doku.php?id=ateliers:halv3
![Page 2: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/2.jpg)
HAL - https://hal.archives-ouvertes.fr L'archive ouverte pluridisciplinaire HAL, est destinée au dépôt et à la diffusion d'articles scientifiques de niveau recherche, publiés ou non, et de thèses.
TEL - http://tel.archives-ouvertes.fr Le serveur TEL (thèses-en-ligne) promotion de l'auto-archivage en ligne des thèses de doctorat et habilitations à diriger des recherches (HDR).
Sciencesconf.org - http://www.sciencesconf.org Plateforme Web ouverte aux organisateurs de colloques, workshops ou réunions scientifiques.
MédiHAL - https://medihal.archives-ouvertes.fr MédiHAL, archive ouverte d’images scientifiques et des documents iconographiques de science.
ISIDORE - http://www.rechercheisidore.fr Moteur de recherche unifié des SHS, moissonnant une grande quantité de liens émanant des s bibliothèques numériques. MOA : TGE Adonis.
Episciences.org - http://episciences.org Plateforme d'"épi-revues". (en cours)
HELOISE - http://heloise.ccsd.cnrs.fr Le système Héloïse permet d'informer sur la politique des éditeurs en matière de diffusion en open access des publications scientifiques.
Créé en 2000 Missions :
Développement des archives ouvertes pour la communauté ESR
ainsi que des services connexes
Basé dans les locaux du Centre de Calcul de l'IN2P3
Partenaire de projets européens :
MedOANet, DARIAH-EU, PEER Equipex DILOH, ANR Campus AAR
CCSD (Centre pour la Communication Scientifique Directe - UMS3668)
http://ccsd.cnrs.fr/
![Page 3: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/3.jpg)
API.ARCHIVES-OUVERTES.FR
![Page 4: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/4.jpg)
LES API DE RECHERCHE
Raphaël Tournoy
![Page 5: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/5.jpg)
• API Recherche HAL = documents en ligne * • API Recherche Référentiels :
• Auteurs* • Structures de recherche* • Domaines* • Liste de métadonnées* • Revues* • Projets ANR* • Projets européens* • Affiliations des auteurs • Types de documents • Métadonnées
* Servis par Apache Solr 5
API - RECHERCHE
Via les API de type Solr vous accédez aux même données/fonctionnalités que le CCSD
![Page 6: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/6.jpg)
Apache Solr
Serveur recherche/indexation avec API REST
Recherche texte intégral + facettes
Réponses aux formats JSON ; XML ; CSV ; etc.
Logiciel libre
https://lucene.apache.org/solr/
6
API - RECHERCHE
![Page 7: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/7.jpg)
Solr au CCSD : HAL
Recherche / pages consultation Autocomplétion Exports Flux syndication Statistiques API
Auréhal Recherche / pages consultation
Episciences Recherche / pages consultation
7
API - RECHERCHE
![Page 8: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/8.jpg)
FONCTIONNEMENT INDEXATION
Application [HAL ; Auréhal ; episciences.org]
• Demande indexation
File d’attente
• Lecture de la file d’indexation (+/- 60 secondes)
1 Machine d’indexation
• Indexation
4 Machines d’interrogation
• Réplication (+/- 60 secondes)
![Page 9: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/9.jpg)
API DE RECHERCHE HAL
HTTPS://API.ARCHIVES-OUVERTES.FR/DOCS/SEARCH
![Page 10: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/10.jpg)
Tous les dépôts de HAL en ligne
+/- toutes les métadonnées d’un dépôt sous différentes formes
+ version des métas aux formats :
Bibtex
XML-TEI
COinS
Endnote
Texte intégral indexé mais pas stocké
10
CONTENU API DE RECHERCHE HAL
![Page 11: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/11.jpg)
11
CONTENU API DE RECHERCHE HAL
Exemple de métadonnées renvoyées par l’API de recherche HAL au format XML
![Page 12: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/12.jpg)
12
RECHERCHE DANS HAL
Types de métadonnées accessibles
Pour la recherche (indexées)
Pour l’affichage (stockées)
Pour les facettes (listes de valeurs)
Pour le tri (pas de champs multivalués pour le tri)
![Page 13: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/13.jpg)
API RECHERCHE – TYPES DE CHAMPS
http://api.archives-ouvertes.fr/docs/search/schema/field-types
![Page 14: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/14.jpg)
API RECHERCHE – EXEMPLES DE CHAMPS http://api.archives-ouvertes.fr/docs/search/schema/fields/#fields
![Page 15: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/15.jpg)
Pré-requis client http
Point d’entrée pour HAL : http://api.archives-ouvertes.fr/search/
15
API RECHERCHE - REQUÊTES
![Page 16: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/16.jpg)
Point d’entrée pour un portail : http://api.archives-ouvertes.fr/search/<instance>
Exemple :
http://api.archives-ouvertes.fr/search/in2p3/
NB : Dans le cas d’un portail/instance, si un dépôt a plusieurs versions, on ne trouve que la dernière.
16
API RECHERCHE - REQUÊTES
![Page 17: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/17.jpg)
Point d’entrée pour une collection : http://api.archives-ouvertes.fr/search/<TAMPON>
Exemple :
http://api.archives-ouvertes.fr/search/FRANCE-GRILLES/
NB : Dans le cas d’une collection, si un dépôt a plusieurs versions, on ne voit que la version tamponnée
17
API RECHERCHE - REQUÊTES
![Page 18: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/18.jpg)
Nom paramètre/usage Description exemple Valeur par défaut
q Requête de recherche q=exemple * :*
Chercher dans un champ NomDuChamp:valeur q=title_t:test text
wt Format de réponse Json
Equation de recherche Termes + opérateurs booléens avec des paranthèses Journal AND (Histoire OR History)
Intervalles Recherche d'intervalles submittedDateY_i:[2000 TO *]
Opérateur booléens AND OR NOT + - && || AND
fq Filtres fq=submitType_s:file
rows Nombre de résultats rows=5 30
start Décalage des résultats Start=10 0
fl Champs à retourner fl=auth*,docid,label_s docid,label_s
sort Tri : nom du champ + asc ou desc sort=submittedDateY_i desc score
facet Construire des facettes facet=true false
facet.field Un champ pour faire des facettes facet.field=docType_s
facet.mincount Nombre minimum de valeurs pour retourner une facette facet.mincount=1 0
facet.sort Tri des facettes [count ou index] facet.sort=index count
PRINCIPAUX PARAMÈTRES Valeurs + paramètres sensibles à la casse
![Page 19: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/19.jpg)
19
API RECHERCHE - REQUÊTES
Ajouter des paramètres :
q=test
![Page 20: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/20.jpg)
Exemples en ligne de requêtes sur l’API de recherche HAL
![Page 21: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/21.jpg)
##Da
LES REFERENTIELS DE HAL
![Page 22: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/22.jpg)
##Da
1 - Les types de dépôts par instance 2 - Les métadonnées attendues par type de dépôt 3 - Les données de type liste fermée 4 - Les données de type complexes
LES DONNÉES
![Page 23: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/23.jpg)
##Da
Tous les modèles de données sont accessibles via l’API api.archives-ouvertes.fr/ref/referentiel Format de réponse SOLR (like)
<reponse> <result …>
Les formats de sortie json ou xml
RECHERCHE
![Page 24: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/24.jpg)
##Da
DOCUMENTATION
![Page 25: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/25.jpg)
##Da
LES REFERENTIELS
![Page 26: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/26.jpg)
##Da
DOCTYPE
![Page 27: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/27.jpg)
##Da
METADONNEES PAR TYPE
Tableau json du type ART : - 30 méta. possibles dont 11 obligatoires (dont 1 si domaine SHS) et 10 de type liste
![Page 28: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/28.jpg)
##Da
Liste des métadonnées avec le nombre de valeurs disponibles (Avec les facettes)
ref/metadatalist/q/*/facet/true/facet.field/metaName_s/rows/0
Recherche directe des valeurs pour une métadonnées
ref/metadatalist/q/nom
LISTE DES MÉTADONNÉES DE TYPE LISTE FERMÉE
![Page 29: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/29.jpg)
##Da
METADONNEES , EXEMPLE AVEC LISTE FERMÉE
Type : liste
http://api.archives-ouvertes.fr/ref/metadata/q/*/docType_s/LECTURE/wt/xml
![Page 30: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/30.jpg)
##Da
VALEURS DE LECTURETYPE
http://api.archives-ouvertes.fr/ref/metadataList/ ?q=metaName_s:lectureType&wt=xml
![Page 31: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/31.jpg)
##Da
TYPE COMPLEXE
Auteurs, Structures, Disciplines (domaine), Revues (journal), Projet ANR, Projet européens
![Page 32: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/32.jpg)
##Da
TYPE DE DONNÉES COMPLEXES
Champ de type Journal: http://api.archives-ouvertes.fr/ref/journal/q/critere/fl/*
CHAMPS
![Page 33: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/33.jpg)
##Da
Recherche sur les données validées
EXEMPLE RECHERCHE
api.archives-ouvertes.fr/référentiel/ q/critère/ fq/valid_s:VALID/wt/xml
![Page 34: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/34.jpg)
##Da
Définition de Structure Ensemble de métadonnées propres Type :
Institution Laboratoire Département Equipe
Nom …Adresse Relation avec d’autres structures
STRUCTURE
![Page 35: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/35.jpg)
##Da
REPRÉSENTATION D’UN ENSEMBLE DE STRUCTURES
Institution
Laboratoire
Département
Équipe
Équipe
Laboratoire
Département
Laboratoire
Toutes les structures doivent être affiliées à au moins une structure sauf celle de type institution
![Page 36: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/36.jpg)
##Da
AFFILIATIONS VALIDES
Equipe
Laboratoire
Equipe
Département
Equipe
Institution
Département
Laboratoire
Département
Institution
Laboratoire
Institution Institution Institution
![Page 37: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/37.jpg)
##Da
EXEMPLE STRUCTURE DANS AURÉHAL
![Page 38: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/38.jpg)
##Da
REPRÉSENTATION AU FORMAT XML
http://api.archives-ouvertes.fr/ref/structure/q/docid:1897/fl/*/wt/xml
![Page 39: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/39.jpg)
TEI POUR L’IMPORT HAL
![Page 40: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/40.jpg)
Text encoding Ini-a-ve Basé sur XML, Langage de marquage qui permet d’échanger des données textuelles informa-sées.
Format standard choisit pour l’import/export dans HAL
TEI - PRÉSENTATION
![Page 41: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/41.jpg)
STRUCTURE FICHIER TEI
<TEI xmlns="http://www.tei-c.org/ns/1.0" xmlns:hal="http://hal.archives-ouvertes.fr"> <text> <body> //Partie principale <listBibl> <biblFull> //Référence bibliographique structurée <titleStmt>...</titleStmt> //Mention de titre (titre, personnes, responsables) <editionStmt>...</editionStmt> //Edition (Fichiers) <publicationStmt>...</publicationStmt> //Publication (Licence) <seriesStmt>...</seriesStmt> //Collection <notesStmt>...</notesStmt> //Mention de Notes <sourceDesc>...</sourceDesc> //Description de la source <profileDesc>...</profileDesc> //Description des aspects non bibliographiques </biblFull> </listBibl> </body> <back> //Annexe <listOrg type="laboratories">...</listOrg> //Définition de nouvelles structures <listOrg type="projects">...</listOrg> //Définition de nouveaux projets (ANR, Eur) </back> </text></TEI>
TEI export HAL plus complet que pour l’import
![Page 42: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/42.jpg)
Titre
Sous-‐Titre
MENTION DE TITRE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:titleStmt
<title xml:lang="en">Titre en anglais</title><title xml:lang="fr">Titre en français</title>
<title type="sub" xml:lang="fr">Sous-titre en français</title><title type="sub" xml:lang="de">Sous titre en allemand</title>
![Page 43: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/43.jpg)
Auteur
MENTION DE TITRE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:titleStmt
<author role="aut"> <persName> <forename type="first">Prénom</forename> <forename type="middle">Autre prénom</forename> <surname>Nom de famille</surname> </persName> <email>Adresse mail</email> <ptr type="url" target="URL du site web"/> <idno type="idhal">IdHal de l'auteur dans HAL</idno> <idno type="halauthor">Identifiant de la forme auteur</idno> <idno type="http://www.idref.fr/">Identifiant de l'auteur sur IdRef</idno> <idno type="http://arxiv.org/a/">Identifiant de l'auteur sur arXiv</idno> <idno type="http://www.researcherid.com/rid/">Identifiant ResearcherID</idno> <idno type="http://orcid.org/">Identifiant ORCID</idno> <orgName ref="#struct-Identifiant d’une structure connue dans HAL"/> <affiliation ref="#struct-Identifiant d’une structure connue dans HAL"/> <affiliation ref="#localStruct-Identifiant d’une nouvelle structure de recherche à définir dans la partie back du fichier"/> </author>
![Page 44: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/44.jpg)
U-lisa-on de l’API pour rechercher : Rôles u-lisateurs :
hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:relator&wt=xml IdHAL ou forme auteur :
hMp://api.archives-‐ouvertes.fr/ref/author?q=*&fl=*&wt=xml Structure de recherche :
hMp://api.archives-‐ouvertes.fr/ref/structure?q=*&fl=*&wt=xml
MENTION DE TITRE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:titleStmt
![Page 45: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/45.jpg)
Exemple d’ajout d’auteur : À par-r d’un IdHAL
MENTION DE TITRE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:titleStmt
<author role="crp"> <idno type="halauthor">49567</idno></author>
<author role="aut"> <idno type="idhal">laurentromary</idno> <affiliation ref="#struct-5687"/></author>
Nouvel auteur
<author role="aut"> <persName> <forename type="first">Laurent</forename> <surname>Romary</surname> </persName> <email>[email protected]</email> <affiliation ref="#localStruct-1"/></author>
À par-r d’une forme auteur HAL
![Page 46: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/46.jpg)
Financement Projet ANR
Accès au référen-el des projets ANR : hMp://api.archives-‐ouvertes.fr/ref/anrProject?q=*&fl=*&wt=xmll
Projet européen
Accès au référen-el des projets européens: hMp://api.archives-‐ouvertes.fr/ref/europeanProject?q=*&fl=*&wt=xml
MENTION DE TITRE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:titleStmt
<funder ref="#projanr-Identifiant du projet ANR dans le référentiel de HAL"/><funder ref="#localProjanr-Identifiant du projet ANR définit dans la partie back du fichier"/>
<funder ref="#projeurop-Identifiant du projet européen dans le référentiel de HAL"/><funder ref="#localProjeurop-Identifiant du projet européen définit dans la partie back du fichier"/>
![Page 47: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/47.jpg)
Date d’écriture
Fichiers associés au dépôt
Accès au référen-el type de fichier (type) hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:fileType&wt=xml Accès au référen-el « origine du fichier » (subtype)
hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:fileSource&wt=xml
MENTION D’EDITION /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:editionStmt
<date type="whenWritten">Date d'écriture (ex: 2014-09-08)</date>
<ref type="file" subtype="author" target="Lien vers le pdf" n="1(principal)"> <desc>Description du fichier</desc> <date notBefore="Date d'embargo (2015-02-14)"/></ref>
![Page 48: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/48.jpg)
Licence
Accès au référen-el des licences hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:licence&wt=xml
MENTION DE PUBLICATION /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:publicationStmt
<availability> <licence target="Licence"/></availability>
![Page 49: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/49.jpg)
Collec-ons du document
Accès à la liste des collec-ons de HAL hMp://api.archives-‐ouvertes.fr/search/?q=*&rows=0&wt=xml&facet=true&facet.field=collCode_s
COLLECTIONS /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:seriesStmt
<idno type="stamp" n="Identifiant de la collection"/>
![Page 50: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/50.jpg)
Accès aux référen-els : Audience : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:audience&wt=xml Conférence invitée : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:invitedCommunica-on&wt=xml
Vulgarisa-on : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:popularLevel&wt=xml Comité de lecture : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:peerReviewing&wt=xml
Acte : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:proceedings&wt=xml Type de rapport : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:reportType&wt=xml
Type d’image : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:imageType&wt=xml Niveau du cours : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:lectureType&wt=xml
NOTES /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:notesStmt
<note type="commentary">Commentaire</note><note type="description">Description</note>
<note type="audience" n="Audience"/><note type="invited" n="Conférence invitée"/><note type="popular" n="Vulgarisation"/><note type="peer" n="Comité de lecture"/><note type="proceedings" n="Acte"/><note type="report" n="Type de rapport"/><note type="image" n="Type d'image"/><note type="lecture" n="Niveau du cours"/>
![Page 51: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/51.jpg)
DESCRIPTION DE LA SOURCE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc
<biblStruct> //Référence bibliographique structurée <analytic>...</analytic> //Niveau analitique (reprise titre, sous titre, auteurs) <monogr>...</monogr> //Niveau monographique <series>...</series> //Informations sur la série <idno type="doi">...</idno> //Liste d’identifiants du document <ref type="seeAlso">...</ref> // Complément sur le dépôt <ref type="publisher">...</ref> //Lien vers le publisher <relatedItem>...</relatedItem> //Ressources liées</biblStruct>
![Page 52: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/52.jpg)
DESCRIPTION ANALYTIQUE DE LA SOURCE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:sourceDesc/tei:analytic
<analytic> <title xml:lang="en">Improved Analysis of Deterministic Load-Balancing Schemes</title> <author role="aut"> <persName> <forename type="first">Petra</forename> <surname>Berenbrink</surname> </persName> <affiliation ref="#struct-117565"/> </author> <author role="aut"> <idno type="halAuthorId">98062</idno> <affiliation ref="#struct-3102"/> </author></analytic>
Exemple
![Page 53: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/53.jpg)
DESCRIPTION MONOGRAPHIQUE DE LA SOURCE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:sourceDesc/tei:monogr
<idno type="nnt">Numéro National de Thèse</idno><idno type="isbn">ISBN</idno><idno type="eisbn">eISBN</idno><idno type="patentNumber">Numéro de brevet</idno><idno type="reportNumber">Numéro de rapport</idno><idno type="localRef">Référence interne</idno><idno type="halJournalId">Identifiant du journal dans HAL</idno><idno type="issn">ISSN</idno><idno type="eissn">eISSN</idno><title level="j">Nom du journal</title><title level="m">Titre de l'ouvrage</title><title level="m">Source</title><title level="u">Nom du cours</title>
Accès aux référen-els des journaux : hMp://api.archives-‐ouvertes.fr/ref/journal?q=*&fl=*&wt=xml
Ajout d’un journal À par-r de l’iden-fiant HAL
En créant un nouveau journal <idno type="halJournalId">27948</idno>
<idno type="issn">98527</idno><title level="j">Nature reviews. Neuroscience</title>
![Page 54: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/54.jpg)
DESCRIPTION MONOGRAPHIQUE DE LA SOURCE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:sourceDesc/tei:monogr
<meeting> <title>Titre de la conférence</title> <date type="start">Date de début de la conférence</date> <date type="end">Date de fin de la conférence</date> <settlement>Ville</settlement> <country key="Code Pays"/></meeting><respStmt> <name>Organisateur de la conférence</name></respStmt><settlement>Ville</settlement><country key="Code Pays"/><editor>Editeur scientifique</editor><imprint> <publisher>Editeur commercial</publisher> <biblScope unit="serie">Série</biblScope> <biblScope unit="volume">Volume</biblScope> <biblScope unit="issue">Issue</biblScope> <biblScope unit="pp">Numéro de page</biblScope> <date type="datePub">Date de publication</date> <date type="dateDefended">Date de soutenance</date> <date type="dateEpub">Date de publication electronique</date></imprint><authority type="institution">Organisme de thèse, mémoire</authority><authority type="school">Ecole doctorale</authority><authority type="supervisor">Directeur de thèse</authority><authority type="jury">Jury</authority>
![Page 55: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/55.jpg)
SÉRIES /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:series
<editor>Editeur de collection</editor>
Editeur de collec-on
Nom du cours <title>Nom du cours</title>
![Page 56: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/56.jpg)
IDENTIFIANTS, LIENS, RESSOURCES LIÉES /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:idno | tei:ref
Iden-fiants externes Types possibles:
doi, arxiv, bibcode, ird, pubmed, ads, pubmedcentral, irstea, sciencespo, oatao, ensam, prodinra
Complément sur le dépôt
Ressources liées dans HAL
Types de rela-on : hMp://api.archives-‐ouvertes.fr/ref/metadataList?q=metaName_s:relatedType&wt=xml
<idno type="Type d’identifiant">Identifiant</idno>
<ref type="seeAlso">Lien vers la ressource complémentaire</ref>
<relatedItem type="Type de relation" target="Lien vers le document" > Descriptif de la relation</relatedItem>
![Page 57: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/57.jpg)
DESCRIPTION NON BIBLIOGRAPHIQUE /tei:TEI/tei:text/tei:body/tei:listBibl/tei:biblFull/tei:sourceDesc/tei:biblStruct/tei:profileDesc
Codes disciplines HAL hMp://api.archives-‐ouvertes.fr/ref/domain?q=*&wt=xml Type de dépôt
hMp://api.archives-‐ouvertes.fr/ref/doctype?q=*&wt=xml
<profileDesc> <langUsage> <language ident="Code langue du texte"/> </langUsage> <textClass> <keywords scheme="author"> <term xml:lang="Code langue du mot clé">Mot clé</term> </keywords> <classCode scheme="classification">Classification (pacs, msc, ...)</classCode> <classCode scheme="acm">Code ACM</classCode> <classCode scheme="mesh">Mot clé MESH</classCode> <classCode scheme="jel">Mot clé JEL</classCode> <classCode scheme="halDomain" n="Code discipline HAL"/> <classCode scheme="halTypology" n="Type de dépôt"/> </textClass> <abstract xml:lang="Code langue du résumé">Résumé</abstract> <particDesc>
<org type="consortium">Collaboration</org> </particDesc></profileDesc>
![Page 58: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/58.jpg)
Défini-on des structures de recherches et projets (ANR, européens) non connus du référen-el HAL
ANNEXES /tei:TEI/tei:text/tei:back
<back> <listOrg type="laboratories"> <org type="researchteam" xml:id="localStruct-Identifiant de la structure">...</org> <org type="institution" xml:id="localStruct-Identifiant de la structure">...</org> </listOrg> <listOrg type="projects"> <org type="anrProject" xml:id="localProjanr-Identifiant du projet">...</org> <org type="europeanProject" xml:id="localProjeurope-Identifiant du projet">...</org> </listOrg></back>
![Page 59: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/59.jpg)
CRÉATION D’UNE STRUCTURE DE RECHERCHE /tei:TEI/tei:text/tei:back/tei:listOrg[@type="laboratories" ]
<org type="laboratory" xml:id="localStruct-Identifiant de la structure"> <orgName>Nom de la structure</orgName> <orgName type="acronym">Acronyme</orgName> <desc> <address> <addrLine>Adresse postale</addrLine> <country key="Code Pays"/> </address> <ref type="url">URL du site de la structure</ref> </desc> <listRelation> <relation type="Type d'unité (UMS, EA, ...)" name="Code unité" active="#struct-Identifiant de la structure connue de HAL"/> <relation type="Type d'unité (UMS, EA, ...)" name="Code unité" active="#localStruct-Identifiant de la structure dans la partie back du fichier"/> </listRelation></org>
Types de structure : researchteam, department, laboratory, ins-tu-on
![Page 60: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/60.jpg)
CRÉATION D’UNE STRUCTURE DE RECHERCHE /tei:TEI/tei:text/tei:back/tei:listOrg[@type="laboratories" ]
<org type="laboratory" xml:id="localStruct-1"> <orgName>Centre pour la Communication Scientifique Directe</orgName> <orgName type="acronym">CCSD</orgName> <desc> <address> <addrLine>25 bd Pierre de Coubertin, 69100 Villeurbanne</addrLine> <country key="FR"/> </address> <ref type="url">http://ccsd.cnrs.fr</ref> </desc> <listRelation> <relation name="UMS3668" active="#struct-100000"/> <relation active="#struct-100001"/> <relation active="#localStruct-2"/> </listRelation></org><org type="institution" xml:id="localStruct-2"> <orgName>Université de Lyon</orgName> <orgName type="acronym">PRES de Lyon</orgName> <desc> <address> <country key="FR"/> </address> <ref type="url">http://www.univ-lyon.fr</ref> </desc></org>
Exemple de structure
![Page 61: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/61.jpg)
CRÉATION D’UN PROJET ANR /tei:TEI/tei:text/tei:back/tei:listOrg[@type="project" ]
<org type="anrProject" xml:id="localProjanr-Identifiant du projet européen"> <idno type="anr">Numéro du projet</idno> <orgName>Nom</orgName> <orgName type="program">Programme</orgName> <desc>Description</desc> <date>Année</date></org>
Exemple : <org type="anrProject" xml:id="localProjanr-1"> <idno type="anr">ANR-05-PADD-001</idno> <orgName>VIN</orgName> <orgName type="program">Programme fédérateur Agriculture et Développement Durable</orgName> <desc>Quelles interventions publiques et privées pour réduire l'utilisation des traitements phytosanitaires dans le secteur du vin ?</desc> <date>2005</date></org>
![Page 62: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/62.jpg)
CRÉATION D’UN PROJET EUROPÉEN /tei:TEI/tei:text/tei:back/tei:listOrg[@type="project" ]
<org type="europeanProject" xml:id="localProjeurope-Identifiant du projet européen"> <idno type="program">Programme</idno> <idno type="number">Numéro de projet</idno> <idno type="call">Code</idno> <orgName>Nom</orgName> <desc>Description</desc> <date type="start">Date de début</date> <date type="end">Date de fin</date></org>
Exemple : <org type="europeanProject" xml:id="localProjeurope-1"> <idno type="program">REGPOT</idno> <idno type="number">204727</idno> <idno type="call">FP7-REGPOT-2007-1</idno> <orgName>ESTSPACE</orgName> <desc>Expose capacity of the Estonian Space Research and Technology through High Quality Partnership in Europe</desc> <date type="start">2008-03-01</date> <date type="end">2011-02-28</date></org>
![Page 63: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/63.jpg)
Schéma XML : hMp://api.archives-‐ouvertes.fr/documents/aofr-‐sword.xsd
Format XML complet :
hMp://api.archives-‐ouvertes.fr/documents/all.xml
Exemples: Ar-cle dans une revue :
hMp://api.archives-‐ouvertes.fr/documents/art.xml Thèse :
hMp://api.archives-‐ouvertes.fr/documents/these.xml Communica-on :
hMp://api.archives-‐ouvertes.fr/documents/comm.xml Document non publié :
hMp://api.archives-‐ouvertes.fr/documents/submit.xml
RESSOURCES UTILES
![Page 64: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/64.jpg)
IMPORT SWORD
![Page 65: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/65.jpg)
API REST HTTPverbe GET, POST, PUT et DELETEentête HTTP
On-Behalf-OfX-PackagingContent-TypeContent-DispositionContent-MD5Export-To-Arxiv, Export-To-PMC, Hide-For-RePEc, Hide-In-OAI
2
IMPORT SWORD
![Page 66: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/66.jpg)
GET
api.archives-ouvertes.fr/sword/identifiant
Statut de la ressource
HTTP/1.1 200 OK
<document>
<status>accept|verify|update|delete</stat
us>
<comment></comment>
</document>3
IMPORT SWORD
![Page 67: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/67.jpg)
DELETE
api.archives-ouvertes.fr/sword/identifiant
Suppression de la ressource
HTTP/1.1 204 No Content
4
IMPORT SWORD
![Page 68: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/68.jpg)
POSTapi.archives-ouvertes.fr/sword/portail
Dépôt d’une ressourcenotice : text/xmlfichier ou annexe : application/zip
Format pivot basée sur la TEIapi.archives-ouvertes.fr/documents/aofr-sword.xsd
HTTP/1.1 202 AcceptedHTTP/1.1 201 Created
5
IMPORT SWORD
![Page 69: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/69.jpg)
PUT
api.archives-ouvertes.fr/sword/identifiant
Modification|Nouvelle version d’une ressource
HTTP/1.1 200 OK
HTTP/1.1 201 Created
6
IMPORT SWORD
![Page 70: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/70.jpg)
Gestion des erreursHTTP/1.1 4XX
406 Not Acceptable412 Precondition Failed403 Forbidden405 Method Not Allowed413 Request Entity Too Large400 Bad Request
Xpath : sword:error/summary
7
IMPORT SWORD
![Page 71: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/71.jpg)
exemple dépôt notice
curl -v -u test_ws:test https://api.archives-ouvertes.fr/sword/hal -H "X-Packaging:http://purl.org/net/sword-types/AOfr" -X POST -H "Content-Type:text/xml" --data-binary@Desktop/tei2.xml
8
IMPORT SWORD
![Page 72: Réseau Aramis : journée de familiarisation aux API de HAL - 25 février 2015](https://reader033.fdocument.pub/reader033/viewer/2022042818/55b6ffa3bb61eba5238b4691/html5/thumbnails/72.jpg)
exemple nouvelle version
curl -v -u test_ws:test https://api.archives-ouvertes.fr/sword/hal-00000001 -H "X-Packaging:http://purl.org/net/sword-types/AOfr" -X PUT -H "Content-Type:application/zip" –H "Content-Disposition:inline, filename=aa12.xml" --data-binary@Desktop/Archive.zip
9
IMPORT SWORD