User Tools

Site Tools


api1:tag_system:tags

Once you have created your first Tag Set, you can start create the actual Tags.

Object resources

Property Type Description
name String Custom data
tag_set_id Integer The tag set this tag belongs to
uid String Custom Unique identifier for the tag (it 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 /tags
Parameters (*Requiered parameters)
Property Type Description
name* String Custom data
tag_set_id* Integer The tag set this tag belongs to
uid String Custom Unique identifier for the tag (it must be unique)
Send the request (JSON input example)
{
	name: « MCQ»,
	tag_set_id: 1,
	uid: “mcq”
}
Get the response (JSON output example)
{
	id: 1,
	name: « MCQ»,
	tag_set_id: 1,
	instance_id : 1,
	uid: “qcm”,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
}

Fetch (GET)

Method GET
URL /tags/{tag_id}

If no tag_id is provided it will fetch all the Tags for your instance.

Get the response (JSON output example)

With ID provided

{
	id: 1,
	name: « MCQ »,
	tag_set_id: 1,
	uid: “mcq”,
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
}

Without ID provided

[{
	id : 1,
	name : « QCM»,
	instance_id : 1,
	tag_set_id : 1,
	uid: “qcm”,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
},
{
	id : 2,
	name : « QCU»,
	instance_id : 1,
	tag_set_id : 1, 
	uid: “qcu”,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 09:21:03
}]

EDIT (PUT)

Method PUT
URL /tags/{tag_id}
Editable parameters
Property Type Description/expected values
name String Custom data
uid String Custom Unique identifier for the tag (it must be unique)

Please note that you cannot change the set_tag_id of a tag because it will henceforth break the structure of all the tag set.

Send the request (JSON input example)
{
	name: "No more MCQ",
	uid: "nomcq"
}
Get the response (JSON output example)
{
	id: 1,
	name: "No more MCQ",
	uid: "nomcq"
	tag_set_id: 1,
	instance_id : 1,
	created_at : 2014-09-17 09:21:03,
	updated_at : 2014-09-17 11:21:03
}
api1/tag_system/tags.txt · Last modified: 2017/10/17 11:52 by maries