api2:adaptive:objectives
====== Differences ====== This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
api2:adaptive:objectives [2017/10/16 11:10] maries |
api2:adaptive:objectives [2018/07/23 10:06] (current) maries |
||
|---|---|---|---|
| Line 4: | Line 4: | ||
| ===Object resources=== | ===Object resources=== | ||
| ^ Property ^ Type ^ Description ^ | ^ Property ^ Type ^ Description ^ | ||
| + | | id | Integer | identifier for the database of Domoscio's API | | ||
| + | | uid | String | The ID of this knowledge node in your Database. Useful if you cannot store the ID returned by the API | | ||
| | name | String | Custom data | | | name | String | Custom data | | ||
| | objects | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | | objects | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | ||
| | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective | | | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective | | ||
| + | | created_at | DateTime | Date of creation of the object | | ||
| + | | updated_at | DateTime | Last time the object has been modified | | ||
| ===Create (POST)=== | ===Create (POST)=== | ||
| Line 17: | Line 21: | ||
| ^ Property ^ Type ^ Description ^ | ^ Property ^ Type ^ Description ^ | ||
| | name | String | Custom data | | | name | String | Custom data | | ||
| + | | uid* | String | The ID of this knowledge node in your Database. Useful if you cannot store the ID returned by the API | | ||
| | objects* | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | | objects* | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | ||
| - | | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective | | + | | target_only | Boolean | This parameter can be used to restrict the objective: if true, the reviews and the instruction will be kept to the objects declared in the objective. Otherwise we will use our knowledge to extend the objective. | |
| ==Send the request (JSON input example)== | ==Send the request (JSON input example)== | ||
| Line 24: | Line 29: | ||
| <code> | <code> | ||
| { | { | ||
| - | name: “Maths1”, | + | "name": "learn_the_world", |
| - | objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]}, | + | "objects": {"knowledge_nodes": [2715, 2716, 2716], "tags": [1234]}, |
| - | target_only: FALSE | + | "target_only": true, |
| + | "uid": "Obj1" | ||
| } | } | ||
| </code> | </code> | ||
| Line 34: | Line 40: | ||
| <code> | <code> | ||
| { | { | ||
| - | id: 1, | + | "id": 319, |
| - | name: “Maths1”, | + | "name": "learn_the_world", |
| - | target_only: FALSE, | + | "uid": "Obj1", |
| - | objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} | + | "objects": { |
| + | "knowledge_nodes": [ | ||
| + | 2715, | ||
| + | 2716, | ||
| + | 2716 | ||
| + | ], | ||
| + | "tags": [ | ||
| + | 1234 | ||
| + | ] | ||
| + | }, | ||
| + | "created_at": "2017-11-27T16:44:45.409Z", | ||
| + | "updated_at": "2017-11-27T16:44:45.409Z", | ||
| + | "target_only": true | ||
| } | } | ||
| </code> | </code> | ||
| Line 54: | Line 72: | ||
| <code> | <code> | ||
| { | { | ||
| - | id: 1, | + | "id": 319, |
| - | name: “Maths1”, | + | "name": "learn_the_world", |
| - | target_only: FALSE, | + | "uid": "Obj1" |
| - | objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} | + | "objects": { |
| + | "knowledge_nodes": [ | ||
| + | 2715, | ||
| + | 2716, | ||
| + | 2716 | ||
| + | ], | ||
| + | "tags": [ | ||
| + | 1234 | ||
| + | ] | ||
| + | }, | ||
| + | "created_at": "2017-11-27T16:44:45.409Z", | ||
| + | "updated_at": "2017-11-27T16:44:45.409Z", | ||
| + | "target_only": true | ||
| } | } | ||
| </code> | </code> | ||
| Line 65: | Line 95: | ||
| <code> | <code> | ||
| [ | [ | ||
| - | { | + | { |
| - | id: 1, | + | "id": 319, |
| - | name: “Maths1”, | + | "name": "learn_the_world", |
| - | target_only: FALSE | + | "uid": "Obj1" |
| - | objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} | + | "objects": { |
| - | }, | + | "knowledge_nodes": [ |
| - | { | + | 2715, |
| - | id: 2, | + | 2716, |
| - | name: “day2 - English”, | + | 2716 |
| - | target_only: TRUE, | + | ], |
| - | objects: {“knowledge_nodes”: [35,36,37]} | + | "tags": [ |
| - | } | + | 1234 |
| + | ] | ||
| + | }, | ||
| + | "created_at": "2017-11-27T16:44:45.409Z", | ||
| + | "updated_at": "2017-11-27T16:44:45.409Z", | ||
| + | "target_only": true | ||
| + | } | ||
| ] | ] | ||
| </code> | </code> | ||
| Line 90: | Line 126: | ||
| ^ Property ^ Type ^ Description/expected values | | ^ Property ^ Type ^ Description/expected values | | ||
| | name | String | Custom data | | | name | String | Custom data | | ||
| + | | objects* | Json | Set of Knowledge Nodes, and/or Tags to be mastered | | ||
| ==Send the request (JSON input example)== | ==Send the request (JSON input example)== | ||
| Line 95: | Line 132: | ||
| <code> | <code> | ||
| { | { | ||
| - | name: “Mathematics1” | + | "name": "learn_everything" |
| } | } | ||
| </code> | </code> | ||
| Line 103: | Line 140: | ||
| <code> | <code> | ||
| { | { | ||
| - | id: 1, | + | "id": 319, |
| - | name: “Mathematics1”, | + | "name": "learn_everything", |
| - | target_only: FALSE, | + | "uid": "Obj1" |
| - | objects: {“tags”: [1,2,3], “knowledge_nodes”: [17]} | + | "objects": { |
| + | "knowledge_nodes": [ | ||
| + | 2715, | ||
| + | 2716, | ||
| + | 2716 | ||
| + | ], | ||
| + | "tags": [ | ||
| + | 1234 | ||
| + | ] | ||
| + | }, | ||
| + | "created_at": "2017-11-27T16:44:45.409Z", | ||
| + | "updated_at": "2017-11-27T16:49:15.834Z", | ||
| + | "target_only": true | ||
| } | } | ||
| </code> | </code> | ||
api2/adaptive/objectives.1508145005.txt.gz · Last modified: 2017/10/16 11:10 by maries
Page Tools
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 4.0 International
