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.

Download OpenAPI description
api-v1.json
api-v1.yaml
Languages
Servers
Mock server

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

Production

https://api.cdq.com/knowledge-graph/rest/

Concepts

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

Operations

List Concepts

Request

Get concepts saved inside a model.

Security
apiKey
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
conceptIdinteger

Used to identify concept by passing the ID in the URL link.

Example: conceptId=1
searchedTextstring

Used to filter objects.

Example: searchedText=Searched Text
classTypeIdinteger

Used to filter concepts only of a specific type.

Example: classTypeId=1
sortstring

Sort concepts.

Enum"LAST_EDITOR""LAST_MODIFICATION""NAME""URL"
Example: sort=NAME
sortTypestring

Allows changing the default sorting order (ASC) to desire by user.

Default "ASC"
Enum ValueDescription
DESC

Sort in descending order.

ASC

Sort in ascending order.

Example: sortType=ASC
fetchModificationDateboolean

If enabled modification date will be determined against concept values.

Default false
Example: fetchModificationDate=false
publicationStatusstring

If enabled, start filtering based on publication status.

Enum ValueDescription
PUBLISHED

Published status.

UNPUBLISHED

Unpublished status.

Example: publicationStatus=PUBLISHED
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 \
  https://developer.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/concepts \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -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(Concept)required

List of concepts.

values[].​idstringrequired

Unique identifier of the concept.

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

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

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

Username of the last modifier.

Example: "user"
values[].​lastModificationDatestring

Date of the last modification.

Example: "2025-08-29T09:46:59Z"
values[].​publicationStatusstring

Publication status of the concept.

Example: "PUBLISHED"
totalinteger(PageTotal)required

Total number of items which can be paged.

Example: "67"
Response
application/json
{
  "summary": "Paginated response of concepts saved inside a model.",
  "value": "{\"pageSize\":10,\"page\":0,\"values\":[{\"id\":\"101\",\"url\":\"https://www.cdq.com/Configuration_parameters/CDQ_BASEURL\",\"lastModifier\":\"database-creation\",\"lastModificationDate\":\"2021-12-29T13:56:50\"},{\"id\":\"102\",\"url\":\"https://www.cdq.com/Has_value\",\"lastModifier\":\"database-creation\",\"lastModificationDate\":\"2021-12-29T13:56:50\"}],\"total\":2}\n"
}

Rules

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

Operations