Language selection

Search

Nomenclature API 1.0.0 Documentation

On this page

General Information

Owner
Canadian Heritage Information Network (CHIN)
Contact us
Contact the Canadian Heritage Information Network
License
Apache 2.0 Terms of Service

API Server

https://nomenclature.info/api/v1 - Nomenclature API server

Schema file

Get all concepts

GET /concepts

Returns all concept resources, sorted by descending modified date.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.
deprecated No boolean
  • true
  • false
 Deprecating status that need to be considered for filter. If not specified, response includes both active and deprecated concepts.
limit No int32 -
  • Default: 100
  • Max: 500

Number of items to return at one time (max 500)
offset No int32 - The first number of items to be excluded from a response

RESPONSE

HTTP response code
200 - Successful

Example files

Get a concept by ID

GET /concepts/{conceptId}

Returns a concept resource based on concept ID.

REQUEST

Path Parameters
Parameter Required Type Description
conceptId Yes string

Identifier of a concept

  • Examples: 1090
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get all labels of a concept

GET /concepts/{conceptId}/labels

Returns all label resources of a concept based on concept ID.

REQUEST

Path Parameters
Parameter Required Type Description
conceptId Yes string

Identifier of a concept

  • Examples: 1090
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get all siblings of a concept

GET /concepts/{conceptId}/siblings

Returns all sibling resources of a concept based on concept ID.

REQUEST

Path Parameters
Parameter Required Type Description
conceptId Yes string

Identifier of a concept

  • Examples: 1090
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get all term contributors

GET /contributors

Returns all term contributor resources, sorted by ascending identifiers.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get a term contributor by ID

GET /contributors/{agentId}

Returns a term contributor resource based on agent ID.

REQUEST

Path Parameters
Parameter Required Type Description
agentId Yes string

Identifier of an agent (term contributor)

  • Examples: 2
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get all bibliographic citations

GET /citations

Returns all bibliographic resources, sorted by alphabetical order of bibliographic citation's literal value.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.
limit No int32 -
  • Default: 100
  • Max: 500

Number of items to return at one time (max 500)
offset No int32 - The first number of items to be excluded from a response

RESPONSE

HTTP response code
200 - Successful

Example files

Get a bibliographic citation by ID

GET /citations/{bibId}

Returns a bibliographic resource based on its ID.

REQUEST

Path Parameters
Parameter Required Type Description
bibId Yes string

Zotero identifier of a bibliographic resource

  • Examples: H2E7VWRI
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Get all change notes

GET /revisions

Returns all change notes resources, sorted by descending created date of change note.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.
startDate No date -

Earliest date from which changes were made

  • Examples: 2023-10-01
endDate No date -

Latest date to which changes were made

  • Examples: 2023-12-31
nomId No string -

Identifier of a concept

  • Examples: 1090
changeType No enum
  • create
  • remove
  • update
  • move
 Type of changes
limit No int3 -
  • Default: 100
  • Max: 500

Number of items to return at one time (max 500)
offset No int32 - The first number of items to be excluded from a response

RESPONSE

HTTP response code
200 - Successful

Example files

Get a change note by ID

GET /revisions/{changeNoteId}

Returns a change note resource based on its ID.

REQUEST

Path Parameters
Parameter Required Type Description
changeNoteId Yes string

Identifier of a change note (revision)

  • Examples: 995592fe-017d-4929-a1fd-48f5e5e033f8
Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Search concepts by keyword

GET /search

Returns minimized concept resources when searching for a keyword across either all labels or all text fields (i.e. all labels, scope notes and definitions), sorted by descending Lucene index score.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
termSearch Yes string -

Search keyword

  • Examples: chair
lang No enum
  • en
  • en‑CA
  • fr
  • fr‑CA
  • es
  • iu
  • iu‑Latn
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.
scope No enum -
  • Default: allLabels
  • Allowed:
    • allLabels
    • allText

Scope of a search, either all labels or all text fields (i.e. all labels, scope notes and definitions)
limit No int32 -
  • Default: 100
  • Max: 500

Number of items to return at one time (max 500)
offset No int32 - The first number of items to be excluded from a response

RESPONSE

HTTP response code
200 - Successful

Example files

Get dataset description

GET /void

Returns a dataset description resource.

REQUEST

Query-String Parameters
Parameter Required Type Allowed Description
lang No enum
  • en
  • fr
 Language tag(s) that need to be considered for filter. If not specified, response includes literal values in all languages. Response includes values in all variants of specified language, e.g. lang=en returns both values in en and en‑CA. If the CA variant is targeted but doesn't exist, response includes the international form. If the Latn script is targeted but doesn't exist, response includes the default script.

RESPONSE

HTTP response code
200 - Successful

Example files

Date modified:

Questions or comments

The answers to many common questions are found in the Nomenclature User Guide. Please review the User Guide before submitting a question. If you would still like to submit a question or comment, contact us.