Concepts

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

Read concepts

Get concepts saved inside a model.

SecurityapiKey
Request
path Parameters
knowledgeGraphId
required
integer

Used to identify Knowledge Graph and objects inside of it.

Example: 1
modelId
required
integer

Used to identify model and objects inside it.

Example: 1
query Parameters
classTypeId
integer

Used to filter concepts only of specific type.

Example: classTypeId=1
conceptId
integer

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

Example: conceptId=1
fetchModificationDate
boolean
Default: false

If enabled modification date will be determined against concept values.

Example: fetchModificationDate=false
page
integer >= 0
Default: 0

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

Example: page=0
pageSize
integer >= 0
Default: 10

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

Example: pageSize=10
publicationStatus
string

If enabled will enable filtering based on publication status.

Enum: Description
PUBLISHED

Published status.

UNPUBLISHED

Unpublished status.

Example: publicationStatus=PUBLISHED
searchedText
string

Used to filter objects.

Example: searchedText=Searched Text
sort
string

Sort concepts.

Enum: "LAST_EDITOR" "LAST_MODIFICATION" "NAME" "URL"
Example: sort=NAME
sortType
string
Default: "ASC"

Allows to change the default sorting order (ASC) to desired by user.

Enum: Description
DESC

Sort in descending order.

ASC

Sort in ascending order.

Example: sortType=ASC
header Parameters
X-Credential-Username
required
string

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

  • username (e.g. "johnjoe")
  • user id (e.g. "87b1bdb1-ba87-4522-b363-c5a0e6e917b3")
Example: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3
Responses
200

OK

401

Unauthorized

403

Forbidden

404

Not Found

get/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/concepts
Request samples 
Response samples 
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"
}