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

List Knowledge Graphs

Request

Provides a list of knowledge graphs, paged by optional query parameters. The metadata provided includes the knowledge graph ID, base URL, wiki URL, RDFication root prefix, data mapping definition ID, root concept, sandbox mirror ID, and production mirror ID.

Security

basicAuth

Query

pageinteger

Page number.

Default 0

Example: page=1

pageSizeinteger

Page size

Default 10

Example: pageSize=100

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

Responses

OK

Bodyapplication/json

pageSizeinteger

Number of items per page.

Example: "100"

pageinteger

Current page number.

Example: "1"

valuesArray of objects(KnowledgeGraph)

List of knowledge graphs.

Response

application/json

{
  "pageSize": "100",
  "page": "1",
  "values": [
    { … }
  ]
}

Read Knowledge Graph

Request

Provides a knowledge graph by ID. The metadata provided includes the knowledge graph ID, base URL, wiki URL, RDFication root prefix, data mapping definition ID, root concept, sandbox mirror ID, and production mirror ID.

Security

basicAuth

Path

idstringrequired

Knowledge graph ID.

Example: cdl

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/knowledgegraphs/cdl

Responses

OK

Bodyapplication/json

idstring

Knowledge graph ID.

Example: "cdl"

baseUrlstring

Base URL.

Example: "https://meta.cdq.com"

wikiUrlstring

Wiki URL.

Example: "https://meta.cdq.com"

rdficationRootPrefixstring

RDFication root prefix.

Example: "Record"

dataMappingDefinitionIdstring

Data mapping definition ID.

Example: "678dgh4j2s834a37s74744784"

rootConceptobject(Concept)

Concept for RDFication.

sandboxMirrorIdstring

Sandbox mirror ID.

Example: "0015b56f17be0d0a955ea900b7d50346"

productionMirrorIdstring

Production mirror ID.

Example: "0015b00f17be3d0a955ea070b7d50346"

Response

application/json

{
  "id": "cdl",
  "baseUrl": "https://meta.cdq.com",
  "wikiUrl": "https://meta.cdq.com",
  "rdficationRootPrefix": "Record",
  "dataMappingDefinitionId": "678dgh4j2s834a37s74744784",
  "rootConcept": {
    "idSelector": "/partner/header/objectInstance/bpartner",
    "name": "bpartner"
  },
  "sandboxMirrorId": "0015b56f17be0d0a955ea900b7d50346",
  "productionMirrorId": "0015b00f17be3d0a955ea070b7d50346"
}

Download Knowledge Graph

Request

Provides a download of a knowledge graph by ID. The metadata provided includes the knowledge graph ID, base URL, wiki URL, RDFication root prefix, data mapping definition ID, root concept, sandbox mirror ID, and production mirror ID.

Security

basicAuth

Path

idstringrequired

Knowledge graph ID.

Example: cdl

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/knowledgegraphs/cdl/validationgraph

Responses

OK

Bodyapplication/x-turtle

string(binary)

List Business Rules

Request

Provides a list of business rules, paged by optional query parameters. The metadata provided includes the business rule name, URL, business rule type, SPARQL rule, rule status, violation level, violation message, qualification target, description, primary data source, secondary data source, categories, managed identifiers, country short name, and release date.

Security

basicAuth

Path

idstringrequired

Knowledge graph ID.

Example: cdl

Query

pageinteger

Page number.

Default 0

Example: page=1

pageSizeinteger

Page size.

Default 10

Example: pageSize=100

countryShortNameArray of strings

Country code.

Example: countryShortName=CH

ruleStatusArray of strings

Rule status.

Example: ruleStatus=RELEASED

releaseDatestring

Each released rule is marked with release date. If the rule has DEACTIVATED status now, then this indicates the last release date before it was deactivated. The param string should contain a date described in ISO-8601 format.

Example: releaseDate=2020-07-06T12:14:03.204Z

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/knowledgegraphs/cdl/businessrules

Responses

OK

Bodyapplication/json

pageSizeinteger

Number of items per page.

Example: "100"

pageinteger

Current page number.

Example: "1"

totalinteger

Total number of items which can be paged.

Example: "67"

numberOfPagesinteger

Number of pages.

Example: "7"

valuesArray of objects(BusinessRule)

List of business rules.

Response

application/json

{
  "pageSize": "100",
  "page": "1",
  "total": "67",
  "numberOfPages": "7",
  "values": [
    { … }
  ]
}

Read Custom Validation Settings

Request

Provides custom validation settings by ID. The metadata provided includes the ID, criticalities, and ignored rules.

Security

basicAuth

Path

idstringrequired

Knowledge graph ID.

Example: bayer

curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/metadata-api/api-v5/knowledgegraphs/bayer/dataValidationSettings

Responses

OK

Bodyapplication/json

idstring

Knowledge graph ID.

Example: "bayer"

criticalitiesArray of objects(Criticality)

List of criticalities.

ignoredRulesArray of strings(BusinessRuleUrl)

List of ignored rules.

Example: ["https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"]

Response

application/json

{
  "id": "bayer",
  "criticalities": [
    { … }
  ],
  "ignoredRules": [
    "https://meta.cdq.com/Identifier_unknown_(European_value_added_tax_identifier_(The_Netherlands))"
  ]
}

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

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

Metadata API (5)