file.tag.cloud
The file.tag.cloud command is used to obtain an array of tags to generate a User tag cloud. Filtering by tags and/or keys will generate a tag cloud containing the different tags associated to the request params (tags/keys). For more detail use cases, see thing.tag.cloud.
TR50 Request
{
"cmd": {
"command": "file.tag.cloud",
"params": {
"global": true,
"tags": ["tag1", "tag2"]
}
}
}
Request Parameters
Name | Type | Required | Description |
---|---|---|---|
tags |
Array | An array of tags. The result will be limited to the tags associated with Things that already have the indicated tags. | |
thingKey | String | The Thing associated with the files. Defaults to the current session's Thing. | |
global | Boolean | If set to true, the files are global files and the thingKey parameter will be ignored. |
TR50 Response
{
"cmd": {
"success": true,
"params": {
"result": [
{
"tag3": 2
},
{
"tag4": 1
}
]
}
}
}
Response Parameters
Name | Type | Description |
---|---|---|
result | Array | An array of objects. Each object will list the tags count associated to the input tags and/or keys. In the above example, 2 things has tag3 along with tag1 or tag2, and 1 thing has tag4 along with tag1 or tag2. |