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.

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/metadata-api/api-v5/

Production SOAP

https://api.corporate-data-league.ch/metadata-api/soap/v5/

Production

https://api.corporate-data-league.ch/metadata-api/

Knowledge Graphs

-> Categorize the API endpoints related to operations on Knowledge Graphs. These operations include reading Knowledge Graphs, reading a Knowledge Graph by ID, downloading a Knowledge Graph, reading Business Rules, and getting custom validation settings.

Operations

SAP mappings

-> Categorize the API endpoints related to operations on SAP identifier mappings. These operations include reading SAP identifier mappings and analyzing SAP identifier mappings.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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
basicAuth
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

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
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 \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/datasources

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": [
    { … }
  ]
}

Read Data Sources

Request

Provides data sources for golden record.

Security
basicAuth
Query
countryShortNamestringrequired

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

Example: countryShortName=CH
releaseStatusArray 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
curl -i -X GET \
  -u <username>:<password> \
  'https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/datasources/goldenrecord?countryShortName=CH'

Responses

OK

Bodyapplication/json
countryShortNamestring(CountryShortName)

Country code (ISO 3166-1 alpha-2).

Example: "CH"
primaryArray of objects(DataSourceGoldenRecord)

List of primary data sources.

preferredArray of objects(DataSourceGoldenRecord)

List of preferred data sources.

unallowedArray of objects(DataSourceGoldenRecord)

List of unallowed data sources.

otherArray of objects(DataSourceGoldenRecord)

List of other data sources.

Response
application/json
{
  "countryShortName": "CH",
  "primary": [
    { … }
  ],
  "preferred": [
    { … }
  ],
  "unallowed": [
    { … }
  ],
  "other": [
    { … }
  ]
}

List Data Source Access Data.

Request

Provides information about accessing to an external source.

Security
basicAuth
Query
releaseStatusArray of integers

See https://meta.cdq.com/Property:Release_status for semantics.

Example: releaseStatus=4,5,6,7
categoryArray of strings

See https://meta.cdq.com/Property:Has_data_source_category for semantics.

Example: category=BUSINESS_PARTNER
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/datasources/accessdata

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(DataSourceAccessData)

List of data source access data.

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

Read Data Source Managed Identifiers

Request

Provides managed identifiers of an external data source.

Security
basicAuth
Path
aleiPrefixstringrequired

Prefix of the database name, according to ALEI standard.

Example: DE.RC
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/datasources/DE.RC/managedidentifiers

Responses

OK

Bodyapplication/json
managedIdentifierTypesArray of objects(ManagedIdentifier)

List of managed identifier types.

Response
application/json
{
  "managedIdentifierTypes": [
    { … }
  ]
}

Identifiers

-> Categorize the API endpoints related to operations on identifiers. These operations include getting a list of identifier issuing bodies, which can be filtered and paged by optional query parameters. The metadata provided includes technical keys, names, descriptions, jurisdictions, and associated identifier types among others.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

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.

Operations

Service Quotas

Operations

Release Notes

Operations

Compliance Lists

Operations