API de Nomenclature

Sur cette page


L’API de Nomenclature offre aux développeurs de systèmes une méthode plus conventionnelle pour interroger l’ensemble des données de Nomenclature, sans nécessiter de connaissances approfondies du modèle de données sémantiques. Les 12 points terminaux énumérés ci-dessous renvoient des réponses prédéfinies au format JSON ou XML.

Information générale

Propriétaire
Réseau canadien d’information sur le patrimoine (RCIP)
Contactez-nous
Communiquez avec le Réseau canadien d’information sur le patrimoine
Licence
Conditions générales d’utilisation d’Apache 2.0

Serveur API

https://nomenclature.info/api/v1 - Serveur API de Nomenclature

Fichier du schéma

Obtenir tous les concepts

GET /concepts

Renvoie toutes les ressources des concepts, triées par date de modification décroissante.

REQUÊTE

Obtenir tous les concepts - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.
deprecated Non boolean
  • true
  • false
 Statut obsolète qui doit être pris en compte pour le filtre. Si rien n’est spécifié, la réponse comprend à la fois les concepts actifs et les concepts obsolètes.
limit Non int32 -
  • Défaut : 100
  • Maximum : 500

Nombre d’éléments à renvoyer en une seule fois (max. 500)
offset Non int32 - Le premier nombre d’éléments à exclure d’une réponse.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir un concept par ID

GET /concepts/{conceptId}

Renvoie une ressource d’un concept basé sur l’ID du concept.

REQUÊTE

Obtenir un concept par ID - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
conceptId Oui string

Identifiant d’un concept

  • Exemple : 1090
Obtenir un concept par ID - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir toutes les étiquettes d’un concept

GET /concepts/{conceptId}/labels

Renvoie toutes les ressources d’étiquettes d’un concept sur la base de l’identifiant du concept.

REQUÊTE

Obtenir toutes les étiquettes d’un concept - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
conceptId Oui string

Identifiant d’un concept

  • Exemple : 1090
Obtenir toutes les étiquettes d’un concept - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir toutes les ressources apparentées d’un concept

GET /concepts/{conceptId}/siblings

Renvoie toutes les ressources apparentées à un concept sur la base de l’ID du concept.

REQUÊTE

Obtenir toutes les ressources apparentées d’un concept - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
conceptId Oui string

Identifiant d’un concept

  • Exemple : 1090
Obtenir toutes les ressources apparentées d’un concept - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir tous les contributeurs de termes

GET /contributors

Renvoie toutes les ressources des contributeurs de termes, triées par identifiants croissants.

REQUÊTE

Obtenir tous les contributeurs de termes - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir un contributeur de termes par ID

GET /contributors/{agentId}

Renvoie une ressource de contributeur de termes basée sur l’ID de l’agent.

REQUÊTE

Obtenir un contributeur de termes par ID - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
agentId Oui string

Identifiant d’un agent (contributeur de termes)

  • Exemple : 2
Obtenir un contributeur de termes par ID - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir toutes les citations bibliographiques

GET /citations

Renvoie toutes les ressources bibliographiques, triées par ordre alphabétique de la valeur littérale de la citation bibliographique.

REQUÊTE

Obtenir toutes les citations bibliographiques - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.
limit Non int32 -
  • Défaut : 100
  • Maximum : 500

Nombre d’éléments à renvoyer en une seule fois (max. 500)
offset Non int32 - Le premier nombre d’éléments à exclure d’une réponse.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir une citation bibliographique par ID

GET /citations/{bibId}

Renvoie une ressource bibliographique sur la base de son ID.

REQUÊTE

Obtenir une citation bibliographique par ID - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
bibId Oui string

Identifiant Zotero d’une ressource bibliographique

  • Exemple : H2E7VWRI
Obtenir une citation bibliographique par ID - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir toutes les notes de modification

GET /revisions

Renvoie toutes les ressources de notes de modification, triées par ordre décroissant de la date de création de la note de modification.

REQUÊTE

Obtenir toutes les notes de modification - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.
startDate Non date -

Date la plus ancienne à partir de laquelle des modifications ont été apportées

  • Exemple : 2023-10-01
endDate Non date -

Date la plus tardive à laquelle les changements ont été effectués

  • Exemple : 2023-12-31
nomId Non string -

Identifiant d’un concept

  • Exemple : 1090
changeType Non enum
  • create
  • remove
  • update
  • move
 Type de changements
limit Non int3 -
  • Défaut : 100
  • Maximum : 500

Nombre d’éléments à renvoyer en une seule fois (max. 500)
offset Non int32 - Le premier nombre d’éléments à exclure d’une réponse.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir une note de modification par ID

GET /revisions/{changeNoteId}

Renvoie une ressource de note de modification sur la base de son ID.

REQUÊTE

Obtenir une note de modification par ID - Paramètres de chemin d’accès
Paramètre Obligatoire Type Description
changeNoteId Oui string

Identifiant d’une note de modification (révision)

  • Exemple : 995592fe-017d-4929-a1fd-48f5e5e033f8
Obtenir une note de modification par ID - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Recherche de concepts par mot-clé

GET /search

Renvoie les ressources des concepts minimisées lors de la recherche d’un mot-clé dans toutes les étiquettes ou tous les champs de texte (c.-à-d. toutes les étiquettes, les notes d’application et les définitions), triées par score d’index Lucene décroissant.

REQUÊTE

Recherche de concepts par mot-clé - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
termSearch Oui string -

Recherche par mot-clé

  • Exemple : chair
lang Non enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.
scope Non enum -
  • Défaut : allLabels
  • Permis :
    • allLabels
    • allText

Champ d’application d’une recherche, soit toutes les étiquettes, soit tous les champs de texte (c.-à-d. toutes les étiquettes, notes d’application et définitions).
limit Non int32 -
  • Défaut : 100
  • Maximum : 500

Nombre d’éléments à renvoyer en une seule fois (max. 500
offset Non int32 - Le premier nombre d’éléments à exclure d’une réponse.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples

Obtenir la description du jeu de données

GET /void

Renvoie une ressource de description d’un jeu de données.

REQUÊTE

Obtenir la description du jeu de données - Paramètres de la chaîne d’interrogation
Paramètre Obligatoire Type Permis Description
lang Non enum
  • en
  • fr
 Étiquette(s) de langue à prendre en compte pour le filtre. Si elle n’est pas spécifiée, la réponse comprend des valeurs littérales dans toutes les langues. La réponse inclut les valeurs dans toutes les variantes de la langue précisée, par exemple lang=en renvoie les deux valeurs en en et en‑CA. Si la variante CA est ciblée mais n’existe pas, la réponse inclut la forme internationale. Si l’écriture romaine est ciblée mais n’existe pas, la réponse inclut l'écriture par défaut.

RÉPONSE

Code de réponse HTTP
200 - Réussie

Fichiers d’exemples