Documentation de l'API de Nomenclature 1.0.0
Sur cette page
- Information générale
- Serveur API
- Obtenir tous les concepts
- Obtenir un concept par ID
- Obtenir toutes les étiquettes d’un concept
- Obtenir toutes les ressources apparentées d’un concept
- Obtenir tous les contributeurs de termes
- Obtenir un contributeur de termes par ID
- Obtenir toutes les citations bibliographiques
- Obtenir une citation bibliographique par ID
- Obtenir toutes les notes de modification
- Obtenir une note de modification par ID
- Recherche de concepts par mot-clé
- Obtenir la description du jeu de données
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
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 |
|
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 | - |
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 tous les concepts - exemple (version XML – 17 ko)
- Obtenir tous les concepts - exemple (version JSON – 14 ko)
Obtenir un concept par ID
GET /concepts/{conceptId}
Renvoie une ressource d’un concept basé sur l’ID du concept.
REQUÊTE
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
conceptId | Oui | string | Identifiant d’un concept
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 concept par ID - exemple (version XML – 11 ko)
- Obtenir un concept par ID - exemple (version JSON – 12 ko)
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
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
conceptId | Oui | string | Identifiant d’un concept
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 - exemple (version XML – 3 ko)
- Obtenir toutes les étiquettes d’un concept - exemple (version JSON - 2 ko)
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
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
conceptId | Oui | string | Identifiant d’un concept
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 - exemple (format XML – 51 ko)
- Obtenir toutes les ressources apparentées d’un concept - exemple (format JSON – 57 ko)
Obtenir tous les contributeurs de termes
GET /contributors
Renvoie toutes les ressources des contributeurs de termes, triées par identifiants croissants.
REQUÊTE
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 - exemple (version XML – 3 ko)
- Obtenir tous les contributeurs de termes - exemple (version JSON – 3 ko)
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
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
agentId | Oui | string | Identifiant d’un agent (contributeur de termes)
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 - exemple (version XML – 1 ko)
- Obtenir un contributeur de termes par ID - exemple (version JSON – 1 ko)
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
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 | - |
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 toutes les citations bibliographiques - exemple (version XML – 3 ko)
- Obtenir toutes les citations bibliographiques - exemple (version JSON – 3 ko)
Obtenir une citation bibliographique par ID
GET /citations/{bibId}
Renvoie une ressource bibliographique sur la base de son ID.
REQUÊTE
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
bibId | Oui | string | Identifiant Zotero d’une ressource bibliographique
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 une citation bibliographique par ID - exemple (version XML – 2 ko)
- Obtenir une citation bibliographique par ID - exemple (version JSON – 2 ko)
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
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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
|
endDate | Non | date | - | Date la plus tardive à laquelle les changements ont été effectués
|
nomId | Non | string | - | Identifiant d’un concept
|
changeType | Non | enum |
|
Type de changements |
limit | Non | int3 | - |
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 toutes les notes de modification - exemple (version XML – 3 ko)
- Obtenir toutes les notes de modification - exemple (version JSON – 3 ko)
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
Paramètre | Obligatoire | Type | Description |
---|---|---|---|
changeNoteId | Oui | string | Identifiant d’une note de modification (révision)
|
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 une note de modification par ID - exemple (version XML – 2 ko)
- Obtenir une note de modification par ID - exemple (version JSON – 2 ko)
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
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
termSearch | Oui | string | - | Recherche par mot-clé
|
lang | Non | enum |
|
É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 | - |
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 | - |
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
- Recherche de concepts par mot-clé - exemple (version XML – 5 ko)
- Recherche de concepts par mot-clé - exemple (version JSON – 6 ko)
Obtenir la description du jeu de données
GET /void
Renvoie une ressource de description d’un jeu de données.
REQUÊTE
Paramètre | Obligatoire | Type | Permis | Description |
---|---|---|---|---|
lang | Non | enum |
|
É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 la description du jeu de données - exemple (version XML – 11 ko)
- Obtenir la description du jeu de données - exemple (version JSON – 12 ko)
- Date de modification :