Skip to content

Latest commit

 

History

History
71 lines (57 loc) · 4.65 KB

README.md

File metadata and controls

71 lines (57 loc) · 4.65 KB
Raw

Accès aux enrichissements

Toutes les URL suivantes sont accédées via la méthode HTTP GET.

La syntaxe des URL d'accès aux enrichissements est de la forme :

  • URI

    • https://api.istex.fr/document/{id}/enrichments/{type}

  • Paramètres

    • {id} : l'identifiant ISTEX du document auquel correspond la notice,
    • {type} : type de l'enrichissement (ex : "multicat" pour les catégories WOS et Science-Metrix).

  • Code de retour

    • 200 si OK,
    • 404 si le fichier n'est pas trouvé

  • Détails

    • La liste des enrichissements disponibles pour un objet documentaire est accessible si on ne précise pas de type. On obtiendra alors un JSON avec cette liste, par exemple :
    {
  id: "087661D669BF44CA05AA6CE08ADD6399F6A439C4",
  enrichments: {
    multicat: [{
      original: false,
      mimetype: "application/tei+xml",
      extension: "tei",
      uri: "https://api.istex.fr/document/087661D669BF44CA05AA6CE08ADD6399F6A439C4/enrichments/multicat"
    }]
  }
}

  • Si le document interrogé ne possède aucun enrichissement, l'API renverra un message JSON, comme :

    {
id: "0134F1716893F9118DCE7278BE3333CC40D50461",
_error: "Il n'existe actuellement aucun résultat pour ce type de data"
}

    Pour plus de détails sur les champs envoyés en réponse, consultez le chapitre correspondant.

    Il est possible de récupérer plusieurs types d'enrichissement en une seule fois en séparant les types voulus par des ,(virgules).
    Dans ce cas, l'API renverra une archive au format ZIP.

    Pour consolider les enrichissements avec le TEI présent dans le fulltext, il suffit d'activer l'option ?consolidate dans la requête.

{% hint style="info" %} Pour connaitre le shéma TEI (Text Encoding Initiative) utilisé pour le projet ISTEX (liste de notions textuelles admises par le plus grand nombre) voir https://tei.istex.fr/ {% endhint %}

La consolidation peut se combiner avec la récupération de plusieurs types d'enrichissement.