Resources
Tag Resource
This resource represents tag inside of an tag store.
Available HTTP-Methods for Tag Resource
PUT - Url
.../tags/ID?_method=PUT
PUT - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | defaultName (mandatory) | This is the name of tag. |
| string | description | This is the description of tag. |
| string | languageCode | This is the language code of tag. |
| string | name | This is the name of tag. |
| boolean | renameTag | If set, it is only possible to edit the default name. Also only managers and system users may use this. |
| long | tagId | Is the identifier of the tag. |
| string | tagStoreAlias | This is the identifier of the tagstore. |
| string | tagStoreTagId | This is the identifier of tag inside tagstore. |
| string | tagStoreType | Type of tag store (BLOG, NOTE, ENTITY). Default type is NOTE. |
By sending a HTTP-GET request, the server returns the requested the specified tag resource. There are two ways to get the tag. When the tag identifier in the url was set, the api search for this tag in the database. But when the tag identifier is set 0 then tagStoreTagId and tagStoreAlias must been specified to find the tag.
Please notice the documentation for Resources Tunneling, if you encounter any problems invoking get requests on your server.
GET - Url
.../tags/ID
GET - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| string | defaultName | This is the name of tag. |
| string | description | This is the description of tag. |
| boolean | isFollow | Indicates whether the topic is followed by the user. |
| string | languageCode | This is the language code of tag. |
| string | name | This is the name of tag. |
| long | tagId | Is the identifier of the tag. |
| string | tagStoreAlias | This is the identifier of the tagstore. |
| string | tagStoreTagId | This is the identifier of tag inside tagstore. |
LIST - Url
.../tags/
LIST - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| boolean | isFollow | Indicates whether the topic is followed by the user. |
DELETE - Url
.../tags/ID?_method=DELETE
DELETE - Attributes
Attributes are part of the entity send or requested.
| Type | Name | Description |
|---|---|---|
| long | newTagId | Used, when a tag is removed to assing all notes to the new tag. |
| long | tagId | Is the identifier of the tag. |