api1:knowledge_structure:knowledge_graph
====== Differences ====== This shows you the differences between two versions of the page.
|
api1:knowledge_structure:knowledge_graph [2017/10/07 14:57] 127.0.0.1 external edit |
api1:knowledge_structure:knowledge_graph [2017/10/17 10:04] (current) maries |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | 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)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | name: "Corporate Finance" | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ==Get the response (JSON output example)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | id: 1, | ||
| + | name: « Corporate Finance », | ||
| + | instance_id: 1 | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ===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**\\ | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | id : 1, | ||
| + | name : "Corporate Finance", | ||
| + | instance_id : 1 | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | |||
| + | **Without ID provided**\\ | ||
| + | <code> | ||
| + | [ | ||
| + | { | ||
| + | id: 1, | ||
| + | name: "Corporate Finance", | ||
| + | instance_id: 1 | ||
| + | }, | ||
| + | { | ||
| + | id: 2, | ||
| + | name: "Mathematics", | ||
| + | instance_id: 1 | ||
| + | } | ||
| + | ] | ||
| + | </code> | ||
| + | |||
| + | ===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)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | name : « No more Corporate Finance » | ||
| + | } | ||
| + | </code> | ||
| + | |||
| + | ==Get the response (JSON output example)== | ||
| + | |||
| + | <code> | ||
| + | { | ||
| + | id: 1, | ||
| + | name: « No more Corporate Finance », | ||
| + | instance_id: 1 | ||
| + | } | ||
| + | </code> | ||
| + | |||
api1/knowledge_structure/knowledge_graph.1507381057.txt.gz · Last modified: 2017/10/07 14:57 by 127.0.0.1
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
