Domoscio Docs

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

Object resources

Property	Type	Description
id	Integer	identifier for the database of Domoscio's API
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)
created_at	DateTime	Date of creation of the object
updated_at	DateTime	Last time the object has been modified

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": 216,
    "uid": "mcq"
}

Get the response (JSON output example)

{
    "id": 1278,
    "name": "MCQ",
    "created_at": "2017-11-22T17:23:47.317Z",
    "updated_at": "2017-11-22T17:23:47.317Z",
    "tag_set_id": 216,
    "uid": "mcq"
}

Fetch (GET)

Method	GET
URL	/tags/{tag_id}

If no tag_id is provided it will fetch all the Tags for your instance. You can choose to filter the tags by providing the following 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)

Get the response (JSON output example)

With ID provided

{
    "id": 1278,
    "name": "MCQ",
    "created_at": "2017-11-22T17:23:47.317Z",
    "updated_at": "2017-11-22T17:23:47.317Z",
    "tag_set_id": 216,
    "uid": "mcq"
}

Without ID provided

[
    {
        "id": 1243,
        "name": "TUCQ",
        "created_at": "2017-09-20T14:15:34.135Z",
        "updated_at": "2017-09-20T14:15:34.135Z",
        "tag_set_id": 213,
        "uid": "Table Unique right answer multiple Choice Question"
    },
    {
        "id": 1278,
        "name": "MCQ",
        "created_at": "2017-11-22T17:23:47.317Z",
        "updated_at": "2017-11-22T17:23:47.317Z",
        "tag_set_id": 216,
        "uid": "mcq"
    }
]

Fetch all Tags by Tag Set

You can get all Tags relative to a given Tag Set.

Method	GET
URL	/v2/tag_sets/{tag_set_id}/tags

EDIT (PUT)

Method	PUT
URL	/tags/{tag_id}

Editable parameters

Property	Type	Description/expected values
name*	String	Custom data

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",
}

Get the response (JSON output example)

{
    "id": 1278,
    "name": "No  more MCQ",
    "created_at": "2017-11-22T17:23:47.317Z",
    "updated_at": "2017-11-24T08:37:33.383Z",
    "tag_set_id": 216,
    "uid": "mcq"
}

Domoscio Docs

User Tools

Site Tools

Object resources

Create (POST)

Parameters (*Requiered parameters)

Send the request (JSON input example)

Get the response (JSON output example)

Fetch (GET)

Get the response (JSON output example)

Fetch all Tags by Tag Set

EDIT (PUT)

Editable parameters

Send the request (JSON input example)

Get the response (JSON output example)

Page Tools