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.
Knowledge Graph API (1)
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/
https://api.corporate-data-league.ch/knowledge-graph-api/
The number of the page to read. Parameter isn't required, by default, set to '0'.
Maximum number of elements on the page to read. Parameter isn't required. Can't be negative, by default, set to 10.
Filter knowledge graphs models by status value.
| Enum Value | Description |
|---|---|
| ACTIVE | Active status. |
| DEACTIVATED | Deactivated status. |
Additional options for fetching models.
| Items Value | Description |
|---|---|
| SHOW_PUBLICATION_STATUS | Show model release status. |
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'OK
List of models.
Status of the model.
| Enum Value | Description |
|---|---|
| ACTIVE | The model is active. |
| DEACTIVATED | The model is deactivated. |
| PENDING | The model is pending. |
Describes model published status.
| Enum Value | Description |
|---|---|
| CREATED | The model is created and initialized in Knowledge Graph browser but not published. |
| PUBLISHED | The model is published and does not contain any unreleased changes. |
| UNPUBLISHED | The model is created in Knowledge Graph browser but not published. |
| PUBLISHING_IN_PROGRESS | The model is being published at the moment. |
| PUBLISHED_HAS_UNPUBLISHED_CHANGES | The model is published but contains unpublished changes. |
| PUBLISHING_PROCESS_HAS_FAILED | Can't compute model release status. |
| UNKNOWN | Unknown status. |
Date of creation (ISO 8601-compliant).
Date of modification (ISO 8601-compliant).
{ "summary": "List of models inside Knowledge Graph.", "value": "{\"pageSize\":100,\"page\":0,\"values\":[{\"id\":1,\"knowledgeGraphId\":1,\"description\":\"CDQ main model\",\"creator\":\"demo_user\",\"status\":\"ACTIVE\",\"creationDate\":\"2021-12-29T12:56:48\",\"modificationDate\":\"2021-12-29T12:56:49\",\"modelConfigProperties\":[{\"key\":\"EXTERNAL_ID_TAG\",\"value\":\"recordId\"},{\"key\":\"CDQ_BASEURL\",\"value\":\"https://meta.cdq.com\"},{\"key\":\"BASEURL\",\"value\":\"https://www.cdq.com/\"},{\"key\":\"KNOWLEDGE_GRAPH_LABEL\",\"value\":\"kg_1_m_1\"},{\"key\":\"EXTERNAL_ID_SELECTOR\",\"value\":\"/recordId\"},{\"key\":\"ROOT_PREFIX\",\"value\":\"Record\"},{\"key\":\"VALIDATION_GRAPH\",\"value\":\"\"}]},{\"id\":2,\"knowledgeGraphId\":1,\"description\":\"CDQ secondary model\",\"creator\":\"demo_user\",\"status\":\"ACTIVE\",\"creationDate\":\"2021-12-29T12:56:55\",\"modificationDate\":\"2021-12-29T12:56:55\",\"modelConfigProperties\":[{\"key\":\"EXTERNAL_ID_TAG\",\"value\":\"recordId\"},{\"key\":\"CDQ_BASEURL\",\"value\":\"https://meta.cdq.com\"},{\"key\":\"BASEURL\",\"value\":\"https://www.cdq.com/\"},{\"key\":\"KNOWLEDGE_GRAPH_LABEL\",\"value\":\"kg_1_m_2\"},{\"key\":\"EXTERNAL_ID_SELECTOR\",\"value\":\"/recordId\"},{\"key\":\"ROOT_PREFIX\",\"value\":\"Record\"},{\"key\":\"VALIDATION_GRAPH\",\"value\":\"\"}]},{\"id\":3,\"knowledgeGraphId\":1,\"description\":\"CDQ test model\",\"creator\":\"demo_user\",\"status\":\"ACTIVE\",\"creationDate\":\"2021-12-29T12:56:58\",\"modificationDate\":\"2021-12-29T12:56:59\",\"modelConfigProperties\":[{\"key\":\"EXTERNAL_ID_TAG\",\"value\":\"recordId\"},{\"key\":\"CDQ_BASEURL\",\"value\":\"https://meta.cdq.com\"},{\"key\":\"BASEURL\",\"value\":\"https://www.cdq.com/\"},{\"key\":\"KNOWLEDGE_GRAPH_LABEL\",\"value\":\"kg_1_m_3\"},{\"key\":\"EXTERNAL_ID_SELECTOR\",\"value\":\"/recordId\"},{\"key\":\"ROOT_PREFIX\",\"value\":\"Record\"},{\"key\":\"VALIDATION_GRAPH\",\"value\":\"\"}]}],\"total\":3}\n" }
List of model configuration properties.
Key of the property.
| Enum Value | Description |
|---|---|
| BASEURL | URL of Knowledge Graph that created model belongs to. |
| CDQ_BASEURL | Constant value, points to CDQ's meta wiki. |
| EXTERNAL_ID_SELECTOR | Field used for extracting external ID out of records. |
| EXTERNAL_ID_TAG | Tag for records external ID. |
| KNOWLEDGE_GRAPH_LABEL | Label of Knowledge Graph. |
| ROOT_PREFIX | Prefix used to recognize records. |
| VALIDATION_GRAPH | Name of validation graph that records will be validated against to. |
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models
curl -i -X POST \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models \
-H 'Content-Type: application/json' \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
-d '{
"description": "CDQ primary-demo model"
}'Created
Status of the model.
| Enum Value | Description |
|---|---|
| ACTIVE | The model is active. |
| DEACTIVATED | The model is deactivated. |
| PENDING | The model is pending. |
Describes model published status.
| Enum Value | Description |
|---|---|
| CREATED | The model is created and initialized in Knowledge Graph browser but not published. |
| PUBLISHED | The model is published and does not contain any unreleased changes. |
| UNPUBLISHED | The model is created in Knowledge Graph browser but not published. |
| PUBLISHING_IN_PROGRESS | The model is being published at the moment. |
| PUBLISHED_HAS_UNPUBLISHED_CHANGES | The model is published but contains unpublished changes. |
| PUBLISHING_PROCESS_HAS_FAILED | Can't compute model release status. |
| UNKNOWN | Unknown status. |
Date of creation (ISO 8601-compliant).
Date of modification (ISO 8601-compliant).
{ "summary": "Response containing a newly created data model with its configuration parameters", "value": "{\"id\":1,\"knowledgeGraphId\":1,\"description\":\"CDQ test model\",\"creator\":\"demo_user\",\"status\":\"ACTIVE\",\"creationDate\":\"2021-12-29T12:56:58\",\"modificationDate\":\"2021-12-29T12:56:59\",\"modelConfigProperties\":[{\"key\":\"EXTERNAL_ID_TAG\",\"value\":\"recordId\"},{\"key\":\"CDQ_BASEURL\",\"value\":\"https://meta.cdq.com\"},{\"key\":\"BASEURL\",\"value\":\"https://www.cdq.com/\"},{\"key\":\"KNOWLEDGE_GRAPH_LABEL\",\"value\":\"kg_1_m_3\"},{\"key\":\"EXTERNAL_ID_SELECTOR\",\"value\":\"/recordId\"},{\"key\":\"ROOT_PREFIX\",\"value\":\"Record\"},{\"key\":\"VALIDATION_GRAPH\",\"value\":\"\"}]}\n" }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1 \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'Model updated successfully
Status of the model.
| Enum Value | Description |
|---|---|
| ACTIVE | The model is active. |
| DEACTIVATED | The model is deactivated. |
| PENDING | The model is pending. |
Describes model published status.
| Enum Value | Description |
|---|---|
| CREATED | The model is created and initialized in Knowledge Graph browser but not published. |
| PUBLISHED | The model is published and does not contain any unreleased changes. |
| UNPUBLISHED | The model is created in Knowledge Graph browser but not published. |
| PUBLISHING_IN_PROGRESS | The model is being published at the moment. |
| PUBLISHED_HAS_UNPUBLISHED_CHANGES | The model is published but contains unpublished changes. |
| PUBLISHING_PROCESS_HAS_FAILED | Can't compute model release status. |
| UNKNOWN | Unknown status. |
Date of creation (ISO 8601-compliant).
Date of modification (ISO 8601-compliant).
{ "summary": "List of models inside Knowledge Graph.", "value": "{\"id\":1,\"knowledgeGraphId\":1,\"description\":\"Test model description\",\"creator\":\"user\",\"status\":\"ACTIVE\",\"creationDate\":\"2022-01-19T15:44:28\",\"modificationDate\":\"2022-01-19T15:44:29\",\"modelConfigProperties\":[{\"key\":\"EXTERNAL_ID_TAG\",\"value\":\"recordId\"},{\"key\":\"CDQ_BASEURL\",\"value\":\"http://meta.cdq.com\"},{\"key\":\"BASEURL\",\"value\":\"http://www.cdq.com/\"},{\"key\":\"KNOWLEDGE_GRAPH_LABEL\",\"value\":\"kg_1_m_1\"},{\"key\":\"EXTERNAL_ID_SELECTOR\",\"value\":\"/recordId\"},{\"key\":\"ROOT_PREFIX\",\"value\":\"Record\"},{\"key\":\"VALIDATION_GRAPH\",\"value\":\"\"}]}\n" }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
curl -i -X PUT \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1 \
-H 'Content-Type: application/json' \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3' \
-d '{
"description": "CDQ model - updated description"
}'Model updated successfully
Status of the model.
| Enum Value | Description |
|---|---|
| ACTIVE | The model is active. |
| DEACTIVATED | The model is deactivated. |
| PENDING | The model is pending. |
Describes model published status.
| Enum Value | Description |
|---|---|
| CREATED | The model is created and initialized in Knowledge Graph browser but not published. |
| PUBLISHED | The model is published and does not contain any unreleased changes. |
| UNPUBLISHED | The model is created in Knowledge Graph browser but not published. |
| PUBLISHING_IN_PROGRESS | The model is being published at the moment. |
| PUBLISHED_HAS_UNPUBLISHED_CHANGES | The model is published but contains unpublished changes. |
| PUBLISHING_PROCESS_HAS_FAILED | Can't compute model release status. |
| UNKNOWN | Unknown status. |
Date of creation (ISO 8601-compliant).
Date of modification (ISO 8601-compliant).
{ "id": "1", "knowledgeGraphId": "1", "description": "Model", "creator": "johndoe", "status": "ACTIVE", "publicationStatus": "CREATED", "creationDate": "2020-08-31T16:47+00:00", "modificationDate": "2020-08-31T16:47+00:00", "modelConfigProperties": [ { … } ] }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}
curl -i -X DELETE \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1 \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/classes
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/classes
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/classes
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/classes \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'{ "results": [ { … } ] }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/models/active_models
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/models/active_models
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/models/active_models
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/models/active_models \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'{ "activeModels": [ "kg_1_m_2" ] }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/status
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/status
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/status
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/status \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'OK
Describes model published status.
| Enum Value | Description |
|---|---|
| CREATED | The model is created and initialized in Knowledge Graph browser but not published. |
| PUBLISHED | The model is published and does not contain any unreleased changes. |
| UNPUBLISHED | The model is created in Knowledge Graph browser but not published. |
| PUBLISHING_IN_PROGRESS | The model is being published at the moment. |
| PUBLISHED_HAS_UNPUBLISHED_CHANGES | The model is published but contains unpublished changes. |
| PUBLISHING_PROCESS_HAS_FAILED | Can't compute model release status. |
| UNKNOWN | Unknown status. |
{ "summary": "The model does not contain unpublished changes.", "value": "{ \"containsUnpublishedChanges\": false }\n" }
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/clear
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/clear
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/clear
curl -i -X POST \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/clear"{ \"status\" : \"SUCCESS\" }\n"
- Mock server
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/export/rdf
- Production SOAP
https://api.corporate-data-league.ch/knowledge-graph-api/soap/v1/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/export/rdf
- Production
https://api.corporate-data-league.ch/knowledge-graph-api/knowledgegraphs/{knowledgeGraphId}/models/{modelId}/export/rdf
curl -i -X GET \
-u <username>:<password> \
https://idp.cdq.com/_mock/apis/knowledge-graph-api/api-v1/knowledgegraphs/1/models/1/export/rdf \
-H 'X-Credential-Username: 87b1bdb1-ba87-4522-b363-c5a0e6e917b3'"{ \"linkToRDFPath\": \"C:\\\\Users\\\\userName\\\\kgFileStorage/release-user-2022-02-02T13-28-10.882424900.gz\" }\n"