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

List Country Metadata

Request

Provides a list of country metadata, paged by optional query parameters. The optional short name can be used to get metadata for a specific country.

Security
basicAuth
Query
pageinteger

The number of the page to read, starting with '0'.

Default 0
Example: page=1
pageSizeinteger

Maximum number of elements on the page to read.

Default 10
Example: pageSize=10
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/countries

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

List of country metadata.

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

Read Country ISO Metadata

Request

Provides metadata for a specific country, by its country short name, i.e., the 2-digit ISO code.

Security
basicAuth
Path
shortNamestringrequired

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

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

Responses

OK

Bodyapplication/json
urlstring

URL of the country metadata.

Example: "https://meta.cdq.com/Category:Country"
countryShortNamestring(CountryShortName)

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

Example: "CH"
continentobject

The continent the country belongs to.

Example: "Europe"
officialTermsArray of objects(TermMetadata)

List of official terms for the country.

alternativeTermsArray of objects(TermMetadata)

List of alternative terms for the country.

shortNamesArray of objects(TermMetadata)

List of short names for the country.

shortNationalitiesArray of objects(TermMetadata)

List of short nationalities for the country.

nationalitiesArray of objects(TermMetadata)

List of nationalities for the country.

languagesArray of strings(LanguageName)

List of languages spoken in the country.

Example: ["German"]
Response
application/json
{
  "url": "https://meta.cdq.com/Category:Country",
  "countryShortName": "CH",
  "continent": "Europe",
  "officialTerms": [
    { … }
  ],
  "alternativeTerms": [
    { … }
  ],
  "shortNames": [
    { … }
  ],
  "shortNationalities": [
    { … }
  ],
  "nationalities": [
    { … }
  ],
  "languages": [
    "German"
  ]
}

Read Country Metadata

Request

Provides country metadata for a given search term, e.g., the country short name, a language-specific label or another known abbreviation.

Security
basicAuth
Bodyapplication/json
searchTermstringrequired

Search term to find countries by.

Example: "Switzerland"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/v3/countries/find \
  -H 'Content-Type: application/json' \
  -d '{
    "searchTerm": "Switzerland"
  }'

Responses

OK

Bodyapplication/json
urlstring

URL of the country metadata.

Example: "https://meta.cdq.com/Category:Country"
countryShortNamestring(CountryShortName)

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

Example: "CH"
continentobject

The continent the country belongs to.

Example: "Europe"
officialTermsArray of objects(TermMetadata)

List of official terms for the country.

alternativeTermsArray of objects(TermMetadata)

List of alternative terms for the country.

shortNamesArray of objects(TermMetadata)

List of short names for the country.

shortNationalitiesArray of objects(TermMetadata)

List of short nationalities for the country.

nationalitiesArray of objects(TermMetadata)

List of nationalities for the country.

languagesArray of strings(LanguageName)

List of languages spoken in the country.

Example: ["German"]
Response
application/json
{
  "url": "https://meta.cdq.com/Category:Country",
  "countryShortName": "CH",
  "continent": "Europe",
  "officialTerms": [
    { … }
  ],
  "alternativeTerms": [
    { … }
  ],
  "shortNames": [
    { … }
  ],
  "shortNationalities": [
    { … }
  ],
  "nationalities": [
    { … }
  ],
  "languages": [
    "German"
  ]
}

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

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