Metadata API (3)

Download OpenAPI specification:Download

A comprehensive suite of services that provides access to CDQ metadata. It is designed to offer basic services to apply such a metadata, for instance, for parsing.

APIs

-> Categorize the API endpoints related to operations on APIs. These operations include reading API metadata. The metadata provided includes endpoint descriptions, related features, and use cases.

Character Sets

-> Categorize the API endpoints related to operations on character sets. These operations include reading character sets metadata. The metadata provided includes character set names and technical keys.

Concepts

-> Categorize the API endpoints related to operations on concepts. These operations include reading concept metadata. The metadata provided includes concept names, technical keys, and parent concept technical keys.

Counties

-> Categorize the API endpoints related to operations on counties. These operations include reading county metadata. The metadata provided includes county names, region short names, and region values.

Countries

-> Categorize the API endpoints related to operations on countries. These operations include reading country metadata. The metadata provided includes country names, country short names, and country technical keys.

DataSources

-> Categorize the API endpoints related to operations on data sources. These operations include reading data source metadata. The metadata provided includes data source names, data source technical keys, and data source categories.

Read Data Source Metadata

Provides metadata on external data sources such as legal forms, address data, or legal entity data. Results are paged by optional query parameters and filtered by additional parameters such as country short name or concepts provided by the particular data source.

SecurityapiKey
Request
query Parameters
aleiPrefix
string

Prefix of the database name, according to ALEI standard.

Example: aleiPrefix=DE.RC
countryShortName
string

Country short name, i.e., the 2-digit ISO code.

Example: countryShortName=CH
implementationStatus
string

DEPRECATED, use 'releaseStatus' instead.

Example: implementationStatus=ACTIVE
managedConceptTechnicalKey
string

Technical key of a CDQ data model concept.

Example: managedConceptTechnicalKey=LEGAL_FORM
preferredInCountry
string

ISO code of a country this data source is used in as a preferred data source for compiling golden records.

Example: preferredInCountry=CH
primaryInCountry
string

ISO code of a country this data source is used in as a primary data source for compiling golden records.

Example: primaryInCountry=CH
releaseStatus
Array of integers

See https://meta.cdq.com/Property:Release_status for semantics. According to CDLD-22386 list of 4,5,6,7, corresponds to active data sources

Example: releaseStatus=4,5,6,7
technicalKey
string

Technical key.

Example: technicalKey=DE_RC
unallowedInCountry
string

ISO code of a country this data source is not allowed to be used in for compiling golden records.

Example: unallowedInCountry=CH
Responses
200

OK

get/v3/datasources
Request samples
Response samples
application/json
{
  • "pageSize": "10",
  • "page": "1",
  • "total": "100",
  • "values": [
    ]
}

Identifiers

-> Categorize the API endpoints related to operations on identifiers. These operations include reading identifier metadata. The metadata provided includes identifier names, identifier technical keys, and identifier issuing bodies.

Languages

-> Categorize the API endpoints related to operations on languages. These operations include reading language metadata. The metadata provided includes language names, language technical keys, and language codes.

LegalForms

-> Categorize the API endpoints related to operations on legal forms. These operations include reading legal form metadata. The metadata provided includes legal form names, legal form technical keys, and legal form categories.

Linkage Strategies

-> Categorize the API endpoints related to operations on linkage strategies. These operations include reading linkage strategy metadata. The metadata provided includes linkage strategy names, linkage strategy technical keys, and linkage strategy categories.

Postal Delivery Points

-> Categorize the API endpoints related to operations on postal delivery points. These operations include reading postal delivery point metadata. The metadata provided includes postal delivery point names, postal delivery point technical keys, and postal delivery point categories.

Premises

-> Categorize the API endpoints related to operations on premises. These operations include reading premise metadata. The metadata provided includes premise names, premise technical keys, and premise categories.

Regions

-> Categorize the API endpoints related to operations on regions. These operations include reading region metadata. The metadata provided includes region names, region short names, and region values.

Regular Expressions

-> Categorize the API endpoints related to operations on regular expressions. These operations include reading regular expressions metadata. The metadata provided includes regular expression names, regular expression technical keys, and regular expression categories.

Terms

-> Categorize the API endpoints related to operations on terms. These operations include reading term metadata. The metadata provided includes term names, term technical keys, and term categories.

Thoroughfares

-> Categorize the API endpoints related to operations on thoroughfares. These operations include reading thoroughfare metadata. The metadata provided includes thoroughfare names, thoroughfare technical keys, and thoroughfare categories.