Skip to content

Knowledge Graph API (1)

A Knowledge Graph is a graph-based data model representation of knowledge within a domain. In other words, it contains nodes and edges that represent entities and the relationships between them. The API should then enable the creation, update, or query with regard to these graphs and their models.

Languages
Servers
Mock server

https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/

Production SOAP

https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/

Production

https://api.corporate-data-league.ch/knowledge-graph-api/

Concepts

Operations related to Concepts. A concept is a unit of knowledge that is created and managed within a model.

Operations

Concept history

Operations related to Concept history. A concept history is a record of changes made to a concept.

Operations

List History Records

Request

Returns all edits related to concept.

Security
basicAuth
Path
knowledgeGraphIdintegerrequired

Used to identify Knowledge Graph and objects inside it.

Example: 1
modelIdintegerrequired

Used to identify model and objects inside it.

Example: 1
conceptIdintegerrequired

Used to identify concept.

Example: 1
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johnjoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/concepts/1/history \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
object

List of edits related to concept.

Response
application/json
{ "summary": "Returns list of edits related does concept.\n", "value": "[{\"id\":2,\"status\":\"FINISHED\",\"startDate\":\"2021-12-30T08:51:45\",\"endDate\":\"2021-12-30T08:51:45\",\"demo_user\":\"demo_user\",\"description\":\"string\",\"log\":null},{\"id\":3,\"status\":\"FINISHED\",\"startDate\":\"2021-12-30T08:51:47\",\"endDate\":null,\"demo_user\":\"demo_user\",\"description\":\"Add concept values\",\"log\":null},{\"id\":4,\"status\":\"FINISHED\",\"startDate\":\"2021-12-30T08:52:14\",\"endDate\":null,\"demo_user\":\"demo_user\",\"description\":\"Change concept description\",\"log\":null}]\n" }

Read Concept Entry

Request

Gets state of concept and related values of historical point in time.

Security
basicAuth
Path
knowledgeGraphIdintegerrequired

Used to identify Knowledge Graph and objects inside it.

Example: 1
modelIdintegerrequired

Used to identify model and objects inside it.

Example: 1
conceptIdintegerrequired

Used to identify concept.

Example: 1
editIdintegerrequired

Used to identify edit.

Example: 1
Headers
X-Credential-Usernamestringrequired

Username that is passed as header parameter with the name X-Credential-Username. The header can take a form of:

  • username (e.g. "johnjoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
curl -i -X GET \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/concepts/1/history/1 \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
conceptobject(Concept)

The Concept is a part of the CDQ data model. For example, Address is a concept of the Business Partner and have many subconcepts as Locality, Thoroughfare, Administrative Area etc.

conceptValuesArray of objects(ConceptValue)
Response
application/json
{ "summary": "Status of a concept at point of time", "value": "{\"concept\":{\"id\":\"110\",\"url\":\"https://cdq.com/concept/2\",\"lastModifier\":\"demo_user\",\"lastModificationDate\":\"2021-12-30T08:52:14\"},\"conceptValues\":[{\"propertyConcept\":{\"id\":111,\"url\":\"https://nowar.com/hasName\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:51:47\",\"deletionDate\":null},\"urlPropertyValues\":null,\"literalPropertyValues\":{\"value\":[{\"id\":136,\"literal\":\"John\",\"datatypeUrl\":\"xsd:string\",\"lang\":\"pl\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:51:47\",\"deletionDate\":\"2021-12-30T08:52:14\"}]}},{\"propertyConcept\":{\"id\":114,\"url\":\"https://cdq.com/value/hasSurname\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null},\"urlPropertyValues\":null,\"literalPropertyValues\":{\"value\":[{\"id\":138,\"literal\":\"Smith\",\"datatypeUrl\":\"xsd:string\",\"lang\":\"en\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null}]}},{\"propertyConcept\":{\"id\":115,\"url\":\"https://cdq.com/value/hasSecondName\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null},\"urlPropertyValues\":null,\"literalPropertyValues\":{\"value\":[{\"id\":139,\"literal\":\"Pablo\",\"datatypeUrl\":\"xsd:string\",\"lang\":\"pl\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null}]}},{\"propertyConcept\":{\"id\":112,\"url\":\"https://cdq.com/hasName\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null},\"urlPropertyValues\":{\"value\":[{\"id\":137,\"url\":\"https://cdq.com/propertyNames\",\"creator\":\"demo_user\",\"creationDate\":\"2021-12-30T08:52:14\",\"deletionDate\":null}]},\"literalPropertyValues\":null}]}\n" }

Imports

Operations related to Imports. An import is a process of bringing data from an external source into the system.

Operations

Knowledge Graphs

Operations related to Knowledge Graphs and their management. A Knowledge Graph is a graph-based data model

Operations

Models

Operations related to Models. A model is a collection of concepts and their relationships.

Operations

Query

Operations related to Query. A query is a request for information from a database.

Rules

Operations related to Rules. A rule is a statement that defines or constrains some aspect of the business.

Operations

Translation

Operations related to Translation. Translation is the communication of a source language text's meaning through an equivalent target language text.

Operations

Validation Graph

Operations related to Validation Graphs. A Validation Graph is a graph-based data model representation of knowledge within a domain.

Operations

Values

Operations related to Values. A value is a piece of information that is stored in a database.

Operations