Domoscio Docs

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
In parallel of creating your knowledge’s structure, you can create any Tag that you want. To structure those Tags, they can be grouped by Tag Set.

{{ :api1:tag_system:tag_set_v1.png?600 | Tag Set example}}

===Object resources===
^ Property     ^ Type      ^ Description         ^
| name | String     | Custom data |
| uid | String | Tag Set identifier (must be unique) |
| instance_id  | Integer | The instance the knowledge graph belongs to |
| created_at | Timestamp | The creation date of the object |
| updated_at | Timestamp | The last update date of the object |

===Create (POST)===

^ Method | POST |
^ URL | /tag_sets |

==Parameters (*Requiered parameters)==

^ Property     ^ Type      ^ Description         ^
| name    | String     | Custom data        |
| uid | String | Tag Set identifier (must be unique) |

==Send the request (JSON input example)==

<code>
{
	name: « Typology »,
	uid: “typo”
}
</code>

==Get the response (JSON output example)==

<code>
{
	id: 1,
	name: « Typology »,
	uid: “typo”,
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
}
</code>

===Fetch (GET)===

^ Method | GET|
^ URL | /tag_sets/{tag_set_id} |

If no tag_set_id is provided it will fetch all the Tag Sets for your instance.

==Get the response (JSON output example)==

**With ID provided**\\

<code>
{
	id: 1,
	name: « Typology »,
	uid: “typo”,
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
}
</code>


**Without ID provided**\\
<code>
[{
	id: 1,
	name: "Typology",
	uid: "typo",
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
},
{
	id: 2,
	name: "Skills",
	uid: "skills",
	instance_id : 1,
	created_at : 2014-09-17 09:21:15,
	updated_at : 2014-09-17 09:21:15
}]
</code>


===EDIT (PUT)===

^ Method | PUT |
^ URL | /tag_sets/{tag_set_id} |

==Editable parameters==

^ Property ^ Type ^ Description/expected values |
| name | String | Custom data (<255 chars) |
| uid | String | Tag Set identifier |

==Send the request (JSON input example)==

<code>
{
	name: « No more typology »,
	uid: “notypo”
}
</code>

==Get the response (JSON output example)==

<code>
{
	id: 1,
	name: « No more typology »,
	uid: “notypo”,
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 11:21:03
}
</code>
Domoscio Docs

User Tools

Site Tools

Page Tools
