The content’s structure is gathered into Knowledge Graphs. A Knowledge Graph is the first object to instantiate while setting up your content on our API.
{{ :api1:knowledge_structure:graph_v1.png?600 |Graph example}}
===Object resources===
^ Property ^ Type ^ Description ^
| name | String | Custom data |
| id | Integer | The Knowledge Graph identifier |
| instance_id | Integer | The instance the knowledge graph belongs to |
===Create (POST)===
^ Method | POST |
^ URL | /knowledge_graphs |
==Parameters (*Requiered parameters)==
^ Property ^ Type ^ Description ^
| name | String | Custom data |
==Send the request (JSON input example)==
{
name: "Corporate Finance"
}
==Get the response (JSON output example)==
{
id: 1,
name: « Corporate Finance »,
instance_id: 1
}
===Fetch (GET)===
^ Method | GET|
^ URL | /knowledge_graphs/{knowledge_graph_id} |
If no knowledge_graph_id is provided it will fetch all the knowledge graphs for your instance.
==Get the response (JSON output example)==
**With ID provided**\\
{
id : 1,
name : "Corporate Finance",
instance_id : 1
}
**Without ID provided**\\
[
{
id: 1,
name: "Corporate Finance",
instance_id: 1
},
{
id: 2,
name: "Mathematics",
instance_id: 1
}
]
===EDIT (PUT)===
^ Method | PUT |
^ URL | /knowledge_graphs/{knowledge_graph_id} |
==Editable parameters==
^ Property ^ Type ^ Description/expected values |
| name | String | Custom data (<255 characters) |
==Send the request (JSON input example)==
{
name : « No more Corporate Finance »
}
==Get the response (JSON output example)==
{
id: 1,
name: « No more Corporate Finance »,
instance_id: 1
}