We designed the Domoscio API in a Restful way, so that your user experience is simple and straightforward.
You will find in this documentation all the information necessary to interact with the API.
To keep in touch with the latest developments, check the Changelog just here!
The workflow to authentify is based on Oauth2 protocal. To have access to Domoscio functionalities the user should follow these steps:
AuthorizationToken:
The AuthorizationToken is given to the user when he starts working with the Domoscio API. This token must remain secret and used only once.
AccessToken and RefreshToken:
A KnowledgeGraph (KG) is the first object to instantiate while setting up your content on our API. It is the top level of aggregation for knowledge nodes and edges. You can use it to describe your course, a book or even your whole knowledge map.
Create KnowledgeGraphs with payload parameters
name | string (Name) Object name. |
uid | string (Uid) Object UID. |
Created
Unprocessable Entity
{- "name": "Corporate Finance",
- "uid": "fin101"
}
{- "id": 45,
- "name": "string",
- "created_at": "2020-03-25T13:33:57.640Z",
- "updated_at": "2020-03-25T13:33:57.640Z",
- "uid": "string"
}
Get KnowledgeGraphs with payload parameters (limit number of data in response is 20, use page parameter to get the following data).
id | integer or Array of integers (GetId) Fetch the object(s) with ID. |
ids | Array of integers (GetIds) Deprecated Fetch the object(s) with ID. |
uid | string or Array of strings (GetUid) Fetch the object(s) with UID. |
uids | Array of strings (GetUids) Deprecated Fetch the object(s) with UID. |
name | string or Array of strings (GetName) Fetch the object(s) with name. |
sort_by | string (GetSortBy) Parameter(s) to sort the response by. |
page | integer (GetPage) Response page number with index starting from 1 (default value is 1). One page contains 20 data points. |
OK
Bad Request
[ ]
[- {
- "id": 45,
- "name": "Corporate Finance",
- "created_at": "2020-04-06T11:33:34.756Z",
- "updated_at": "2020-04-06T11:33:34.883Z",
- "uid": "fin101"
}, - {
- "id": 46,
- "name": "Marketing",
- "created_at": "2020-04-06T11:33:56.814Z",
- "updated_at": "2020-04-06T11:33:56.865Z",
- "uid": "fin102"
}, - {
- "id": 47,
- "name": "Business Administration",
- "created_at": "2020-04-06T11:34:06.274Z",
- "updated_at": "2020-04-06T11:34:06.297Z",
- "uid": "fin103"
}
]
Get a specific knowledge graph
id required | integer <int64> Knowledge Graph ID |
OK
Bad Request
{- "id": 45,
- "name": "Corporate Finance",
- "uid": "fin101",
- "created_at": "2020-03-25T13:33:57.640Z",
- "updated_at": "2020-03-25T13:33:57.640Z"
}
Update a knowledge graph
id required | integer <int64> Knowledge Graph ID |
name | string (Name) Object name. |
uid | string (Uid) Object UID. |
OK
Bad Request
{- "name": "No more Corporate Finance",
- "uid": "fin101"
}
{- "id": 45,
- "name": "string",
- "created_at": "2020-03-25T13:33:57.640Z",
- "updated_at": "2020-03-25T13:33:57.640Z",
- "uid": "uid_object"
}
A KnowledgeNode (KN) is the second object to instantiate while setting up your content on our API. It is the central model of the application; it can be linked to multiple KnowledgeGraphs. You can use it to describe your content architecture, i.e skills, knowledges, know-hows, etc.
Create a KnowledgeNode object
name | string (Name) Object name. |
uid required | string (Uid) Object UID. |
knowledge_graph_id | integer Object related to a set of KnowledgeGraph ID. It will create automatically the KnowledgeGraphNode that correspond to this association. |
knowledge_graph_uid | String Object related to a set of KnowledgeGraph UID. It will create automatically the KnowledgeGraphNode that correspond to this association. |
knowledge_graph_ids | Array Object related to a set of KnowledgeGraph IDs. It will create automatically the KnowledgeGraphNodes that correspond to the associations. |
knowledge_graph_uids | Array Object related to a set of KnowledgeGraph UIDs. It will create automatically the KnowledgeGraphNodes that correspond to the associations. |
description | string (Description) Object description |
mean | number (Mean) Object's mean, default set to 60.0 |
standard_deviation | number (Standard_deviation) Object's standarddeviation, default set to 15.0 |
Created
Unprocessable Entity
{- "name": "Financial Assets",
- "uid": "fa",
- "knowledge_graph_id": 45
}
{- "id": 0,
- "knowledge_graph_id": 0,
- "created_at": "2020-03-25T13:33:57.640Z",
- "updated_at": "2020-03-25T13:33:57.640Z",
- "name": "string",
- "uid": "string",