Retour : page principale > sommaire eFlore v5 > eFlore API v0.1

---

eFlore Api v0.1 : Ontologies

Ce service fournit des informations sur l'ensemble structuré des termes et concepts représentant les éléments d'un domaine de connaissances (dans notre cas d'un projet).
Le but étant de fournir un ensemble minimal d'information comprenant : un identifiant (numérique ou alphanumérique sous forme de ChatMot si possible), un nom, une description et éventuellement une relation hiérarchique avec un autre terme (=classe).

Nom de champs à utiliser quelque soit les projets

Voir les Ontologies des projets.

Descriptions des paramètres de requête du service

Ces paramètres sont optionnels et sont passés après le signe "?" dans l'URL.

• masque : filtre la liste en fonction d'un masque de recherche portant sur le code, le nom ou la description.
  • masque.code : filtre uniquement sur le code.
  • masque.nom : filtre uniquement sur le nom.
  • masque.description : filtre uniquement sur la description.

Nom de champs à utiliser quelque soit les projets

En gras, les champs obligatoires :

• id : identifiant numérique du terme. Si le projet n'en fournit pas, un identifiant alpha-numérique peut être utilisé à la place. Pour les codes alpha-numérique, privilégier l'utilisation de ChatMot.
• classe.id : l'identifiant de la classe (= catégorie) à laquelle le terme appartient.
• nom : le libellé du terme.
• description : la description du terme.
• code : le code numérique ou alpha-numérique principal pour ce terme. Pour les codes alpha-numérique, privilégier l'utilisation de ChatMot.
• complements : contient des informations complémentaires (cela devrait être exceptionnel). Format XML : <infos><nomDuChamp1>valeur1</nomDuChamp1><nomDuChamp2>valeur2</nomDuChamp2></infos>

/ontologies

Retourne une liste de termes et leur identifiant. Par défaut, retourne seulement les 100 premiers termes.

• Type de requête : GET
• Url : http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies
• Paramètres de requête disponibles :
• Format retour :

Défaut (=defaut) : JSON.

• "entete" : {
  • "depart" : "10",
  • "limite" : "10",
  • "total" : "28",
  • "href.precedent" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies?navigation.depart=0&navigation.limite=10" # URL pour obtenir les résultats précédents
  • "href.suivant" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies?navigation.depart=20&navigation.limite=10" # URL pour obtenir les résultats suivants
• },
• "resultats" : {
  • "11" : { # Identifiant du terme
    • "code" : "code du terme",
    • "nom" : "Libellé du terme",
    • "href" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/11"
  • },
  • "12" : { # Identifiant du terme
    • "code" : "code du terme",
    • "nom" : "Libellé du terme",
    • "href" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/12"
  • },...
• }

}

/ontologies/#id

Retourne toutes les informations sur le terme recherché

• Type de requête : GET
• URI : http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/#id
• Paramètres du chemin :
  • "#id" : identifiant d'un terme.
  • "#nom_classe:#code" : Il est possible d'utiliser le code et le nom de la classe comme identifiant pour les projets. Ex : "rangTaxo:290"
• Paramètres de requête disponibles : retour.format
• Format retour :

Défaut (=defaut) : JSON.
{

• "id" : "1",
• "code" : "codeDuTerme",
• "nom" : "Libellé du terme",
• "description" : "Description du terme.",
• "classe : "Libellé de la classe (= catégorie, collection...) du terme",
• "classe.id : "2",
• "classe.href : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/2"

}

/ontologies/#id/relations

Retourne la liste des relations de subsomption (relation de type "contient") du terme indiqué par son #id.

• Type de requête : GET
• Url : http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/#id/relations
• Paramètres du chemin :
  • "#id" : identifiant d'un terme dont on cherche les relations (uniquement relation hierarchique de type "contient" pour l'instant...).
• Paramètres de requête disponibles : retour.format

• "entete" : {
  • "depart" : "10",
  • "limite" : "10",
  • "total" : "28",
  • "href.precedent" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/#id/relations?navigation.depart=0&navigation.limite=10" # URL pour obtenir les résultats précédents
  • "href.suivant" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/#id/relations?navigation.depart=20&navigation.limite=10" # URL pour obtenir les résultats suivants
• },
• "resultats" : {
  • "11" : { # Identifiant du terme
    • "nom" : "Libellé du terme",
    • "href" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/11"
  • },
  • "12" : { # Identifiant du terme
    • "nom" : "Libellé du terme",
    • "href" : "http://tela-botanica.org/service:eflore:0.1/#projet/#version/ontologies/12"
  • },...
• }

}

---