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

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

List Values.

Request

Get values stored in a model. NOT IMPLEMENTED. TODO - check if needed. Read existing values out of a model.

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
Query
pageinteger>= 0

The number of the page to read. Parameter isn't required, by default, set to '0'.

Default 0
Example: page=0
pageSizeinteger>= 0

Maximum number of elements on the page to read. Parameter isn't required. Can't be negative, by default, set to 10.

Default 10
Example: pageSize=10
valueIdinteger

Used to identify value (url or literal), by passing the ID in URL link.

Example: valueId=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/values \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

OK

Bodyapplication/json
pageSizeinteger(PageSize)[ 1 .. 1000 ]required

Number of items per page.

Default 10
Example: "100"
pageinteger(Page)>= 0required

Current page number.

Default 0
Example: "1"
valuesArray of objects(Value)required

List of values.

values[].​idstringrequired

Unique identifier of the value.

Example: "1"
values[].​subjectConceptobject(Concept)required

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.

values[].​subjectConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
values[].​subjectConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
values[].​subjectConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
values[].​subjectConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
values[].​subjectConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
values[].​propertyConceptobject(Concept)required

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.

values[].​propertyConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
values[].​propertyConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
values[].​propertyConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
values[].​propertyConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
values[].​propertyConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
values[].​objectobject(ValueObject)required

Represents value of:

  • an RDF object property (value refers to another concept by its URL)
  • an RDF data property/literal value
values[].​object.​idinteger

Unique identifier of the concept.

Example: "1"
values[].​object.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
values[].​object.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
values[].​object.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
values[].​object.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
values[].​object.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
values[].​object.​literalstring

Value of the literal.

Example: "Berlin"
values[].​object.​datatypeUrlstring

URL of the literal's datatype.

Example: "http://www.w3.org/2001/XMLSchema#string"
values[].​object.​langstring

Language of the literal.

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

Create Value

Request

Create model values. NOT IMPLEMENTED. TODO - check if needed

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
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
Bodyapplication/jsonrequired
subjectConceptobject(ConceptParam)required

To be used when creating/editing of a new concept (or its associated values). It is expected in most cases only either of the properties will be set.

subjectConcept.​idinteger

Unique identifier of the concept.

Example: "1"
subjectConcept.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
subjectConcept.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
subjectConcept.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
subjectConcept.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
subjectConcept.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
propertyConceptobject(ConceptParam)required

To be used when creating/editing of a new concept (or its associated values). It is expected in most cases only either of the properties will be set.

propertyConcept.​idinteger

Unique identifier of the concept.

Example: "1"
propertyConcept.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
propertyConcept.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
propertyConcept.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
propertyConcept.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
propertyConcept.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
valueobject(ValueObject)required

Represents value of:

  • an RDF object property (value refers to another concept by its URL)
  • an RDF data property/literal value
value.​idinteger

Unique identifier of the concept.

Example: "1"
value.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
value.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
value.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
value.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
value.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
value.​literalstring

Value of the literal.

Example: "Berlin"
value.​datatypeUrlstring

URL of the literal's datatype.

Example: "http://www.w3.org/2001/XMLSchema#string"
value.​langstring

Language of the literal.

Example: "en"
curl -i -X POST \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/values \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "subjectConcept": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true
    },
    "propertyConcept": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true
    },
    "value": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true,
      "literal": "Berlin",
      "datatypeUrl": "http://www.w3.org/2001/XMLSchema#string",
      "lang": "en"
    }
  }'

Responses

Created

Bodyapplication/json
idstringrequired

Unique identifier of the value.

Example: "1"
subjectConceptobject(Concept)required

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.

subjectConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
subjectConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
subjectConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
subjectConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
subjectConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
propertyConceptobject(Concept)required

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.

propertyConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
propertyConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
propertyConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
propertyConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
propertyConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
objectobject(ValueObject)required

Represents value of:

  • an RDF object property (value refers to another concept by its URL)
  • an RDF data property/literal value
object.​idinteger

Unique identifier of the concept.

Example: "1"
object.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
object.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
object.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
object.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
object.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
object.​literalstring

Value of the literal.

Example: "Berlin"
object.​datatypeUrlstring

URL of the literal's datatype.

Example: "http://www.w3.org/2001/XMLSchema#string"
object.​langstring

Language of the literal.

Example: "en"
Response
application/json
{
  "id": "1",
  "subjectConcept": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "lastModifier": "user",
    "lastModificationDate": "2020-07-06T12:14:03.204Z",
    "publicationStatus": "PUBLISHED"
  },
  "propertyConcept": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "lastModifier": "user",
    "lastModificationDate": "2020-07-06T12:14:03.204Z",
    "publicationStatus": "PUBLISHED"
  },
  "object": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "creator": "johndoe",
    "creationDate": "2020-08-31T16:47+00:00",
    "deletionDate": "2020-08-31T16:47+00:00",
    "unmodifiable": true,
    "literal": "Berlin",
    "datatypeUrl": "http://www.w3.org/2001/XMLSchema#string",
    "lang": "en"
  }
}

Update Value

Request

Update value inside a model. NOT IMPLEMENTED. TODO - check if needed.

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
valueIdintegerrequired

Used to identify value (url or literal).

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
Bodyapplication/jsonrequired
subjectConceptobject(ConceptParam)required

To be used when creating/editing of a new concept (or its associated values). It is expected in most cases only either of the properties will be set.

subjectConcept.​idinteger

Unique identifier of the concept.

Example: "1"
subjectConcept.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
subjectConcept.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
subjectConcept.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
subjectConcept.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
subjectConcept.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
propertyConceptobject(ConceptParam)required

To be used when creating/editing of a new concept (or its associated values). It is expected in most cases only either of the properties will be set.

propertyConcept.​idinteger

Unique identifier of the concept.

Example: "1"
propertyConcept.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
propertyConcept.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
propertyConcept.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
propertyConcept.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
propertyConcept.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
valueobject(ValueObject)required

Represents value of:

  • an RDF object property (value refers to another concept by its URL)
  • an RDF data property/literal value
value.​idinteger

Unique identifier of the concept.

Example: "1"
value.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
value.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
value.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
value.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
value.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
value.​literalstring

Value of the literal.

Example: "Berlin"
value.​datatypeUrlstring

URL of the literal's datatype.

Example: "http://www.w3.org/2001/XMLSchema#string"
value.​langstring

Language of the literal.

Example: "en"
curl -i -X PUT \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/values/1 \
  -H 'Content-Type: application/json' \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
  -d '{
    "subjectConcept": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true
    },
    "propertyConcept": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true
    },
    "value": {
      "id": "1",
      "url": "https://meta.cdq.com/Business_partner",
      "creator": "johndoe",
      "creationDate": "2020-08-31T16:47+00:00",
      "deletionDate": "2020-08-31T16:47+00:00",
      "unmodifiable": true,
      "literal": "Berlin",
      "datatypeUrl": "http://www.w3.org/2001/XMLSchema#string",
      "lang": "en"
    }
  }'

Responses

Value updated successfully

Bodyapplication/json
idstringrequired

Unique identifier of the value.

Example: "1"
subjectConceptobject(Concept)required

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.

subjectConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
subjectConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
subjectConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
subjectConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
subjectConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
propertyConceptobject(Concept)required

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.

propertyConcept.​idstringrequired

Unique identifier of the concept.

Example: "1"
propertyConcept.​urlstring(ConceptUrl)required

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
propertyConcept.​lastModifierstring

Username of the last modifier.

Example: "user"
propertyConcept.​lastModificationDatestring

Date of the last modification.

Example: "2020-07-06T12:14:03.204Z"
propertyConcept.​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
objectobject(ValueObject)required

Represents value of:

  • an RDF object property (value refers to another concept by its URL)
  • an RDF data property/literal value
object.​idinteger

Unique identifier of the concept.

Example: "1"
object.​urlstring(ConceptUrl)

URL to the documentation which summarizes all details of the Business Partner Concepts.

Example: "https://meta.cdq.com/Business_partner"
object.​creatorstring(UserId)

Unique ID of a user.

Example: "johndoe"
object.​creationDatestring(CreatedAt)

Date of creation (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
object.​deletionDatestring(DeletedAt)

Date of deletion (ISO 8601-compliant).

Example: "2020-08-31T16:47+00:00"
object.​unmodifiableboolean

Indicates if the concept is unmodifiable. If true, the concept is unmodifiable.

Example: true
object.​literalstring

Value of the literal.

Example: "Berlin"
object.​datatypeUrlstring

URL of the literal's datatype.

Example: "http://www.w3.org/2001/XMLSchema#string"
object.​langstring

Language of the literal.

Example: "en"
Response
application/json
{
  "id": "1",
  "subjectConcept": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "lastModifier": "user",
    "lastModificationDate": "2020-07-06T12:14:03.204Z",
    "publicationStatus": "PUBLISHED"
  },
  "propertyConcept": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "lastModifier": "user",
    "lastModificationDate": "2020-07-06T12:14:03.204Z",
    "publicationStatus": "PUBLISHED"
  },
  "object": {
    "id": "1",
    "url": "https://meta.cdq.com/Business_partner",
    "creator": "johndoe",
    "creationDate": "2020-08-31T16:47+00:00",
    "deletionDate": "2020-08-31T16:47+00:00",
    "unmodifiable": true,
    "literal": "Berlin",
    "datatypeUrl": "http://www.w3.org/2001/XMLSchema#string",
    "lang": "en"
  }
}

Delete Values

Request

Delete value inside a model.

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
valueIdintegerrequired

Used to identify value (url or literal).

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 DELETE \
  -u <username>:<password> \
  https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/values/1 \
  -H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'

Responses

Value deleted successfully