Knowledge Graph API (1.0-master)

Download OpenAPI specification:Download

This API provides services to manage Knowledge Graphs.

Concepts

Read concepts

SecurityapiKey
Request
path Parameters
knowledgeGraphId
required
integer

Used to identify Knowledge Graph and objects inside of it.

modelId
required
integer

Used to identify model and objects inside of it.

query Parameters
classTypeId
integer

Used to filter concepts only of specific type.

conceptId
integer

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

fetchModificationDate
boolean
Default: false

If enabled modification date will be determined against concept values.

page
integer >= 0
Default: 0

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

pageSize
integer >= 0
Default: 10

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

publicationStatus
string

If enabled will enable filtering based on publication status.

Enum: "PUBLISHED" "UNPUBLISHED"
searchedText
string

Used to filter objects.

sort
string

Sort concepts

Enum: "LAST_EDITOR" "LAST_MODIFICATION" "NAME" "URL"
sortType
string
Default: "ASC"

Allows to change default sorting order (ASC) to desired by user. Available options:

  • ASC - ascending sorting (natural order)
  • DESC - descending sorting
Enum: "DESC" "ASC"
header Parameters
X-Credential-Username
required
string

Username that is passed as header parameter with the name X-Credential-Username.

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 cocnepts saved inside 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"
}