Skip to content

Metadata API (5)

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.

Download OpenAPI description
api-v5.json
api-v5.yaml
Languages
Servers
Production
https://api.cdq.com/metadata/rest

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.

Operations

List Data Source Metadata

Request

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.

Security
apiKey
Query
countryShortNamestring

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

Example: countryShortName=CH
managedConceptTechnicalKeystring

Technical key of a CDQ data model concept.

Example: managedConceptTechnicalKey=LEGAL_FORM
aleiPrefixstring

Prefix of the database name, according to ALEI standard.

Example: aleiPrefix=DE.RC
technicalKeystring

Technical key.

Example: technicalKey=DE_RC
implementationStatusstring

DEPRECATED, use 'releaseStatus' instead.

Example: implementationStatus=ACTIVE
releaseStatusArray of integers

According to CDLD-22386 list of 4,5,6,7, corresponds to active data sources.

Example: releaseStatus=4,5,6,7
primaryInCountrystring

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

Example: primaryInCountry=CH
preferredInCountrystring

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

Example: preferredInCountry=CH
unallowedInCountrystring

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

Example: unallowedInCountry=CH
curl -i -X GET \
  'https://api.cdq.com/metadata/rest/v3/datasources?countryShortName=CH&managedConceptTechnicalKey=LEGAL_FORM&aleiPrefix=DE.RC&technicalKey=DE_RC&implementationStatus=ACTIVE&releaseStatus=4%2C5%2C6%2C7&primaryInCountry=CH&preferredInCountry=CH&unallowedInCountry=CH' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)

< The size of the provided page, as specified in the request, or by the default value.

Example: "10"
pageinteger(Page)

< The number of the page, as specified in the request, or '0' as default.

Example: "1"
totalinteger(Total)

< Total number of elements across all pages.

Example: "100"
valuesArray of objects(DataSourceMetadata)

List of data source metadata.

Response
application/json
{
  "pageSize": "10",
  "page": "1",
  "total": "100",
  "values": [
    { … }
  ]
}