tagService

Provides a service to create, retrieve and delete tags.

Method	Description
addTag	Associates a tag with this object
createTag	Creates a tag in the database.
getTagByID	Returns a tag given a tag ID.
getTagByName	Returns a tag by tag name.
getTags	Return an Iterable for all the tags associated with this manager.
removeAllTags	Disassociates this object with all tags.
removeTag	Disassociates this object with the given tag.

addTag

Associates a tag with this object

POST http://domain:port/application_context/rpc/rest/tagService/objectTags

Arguments

Name	Type	Description
tag	xs:string	The object to add a tag for.
jiveObject	Contents of JiveObject	The tag, must be the unfiltered value.

Arguments Template

<addTag> 
    <tag>xs:string</tag>
    <jiveObject>
        <!-- Contents of JiveObject -->
    <jiveObject>
</addTag>

Errors

Error	When Returned
Unauthorized	if does not have permission to the tag @param tag The tag to add
NotFound

createTag

Creates a tag in the database.

POST http://domain:port/application_context/rpc/rest/tagService/tags

Arguments

Name	Type	Description
tagname	xs:string	the name of the tag to create.

Arguments Template

<createTag> 
    <tagname>xs:string</tagname>
</createTag>

Response

Type	Description
ContentTag	the newly created tag.

Response Template

<createTagResponse> 
    <return>
        <!-- Contents of ContentTag -->
    <return>
</createTagResponse>

Errors

Error	When Returned
Unauthorized	if not allowed to create tags.

getTagByID

Returns a tag given a tag ID.

GET http://domain:port/application_context/rpc/rest/tagService/tagsByID/{tagID}

Arguments

Name	Type	Description
tagID	xs:long	The id of the tag.

Arguments Template

<getTagByID> 
    <tagID>xs:long</tagID>
</getTagByID>

Response

Type	Description
ContentTag	the tag

Response Template

<getTagByIDResponse> 
    <return>
        <!-- Contents of ContentTag -->
    <return>
</getTagByIDResponse>

Errors

Error	When Returned
com.jivesoftware.community.TagObjectNotFoundException	if no tag exists with that ID.

getTagByName

Returns a tag by tag name.

GET http://domain:port/application_context/rpc/rest/tagService/tags/{tagname}

Arguments

Name	Type	Description
tagname	xs:string	the name of the tag to lookup.

Arguments Template

<getTagByName> 
    <tagname>xs:string</tagname>
</getTagByName>

Response

Type	Description
ContentTag	the tag

Response Template

<getTagByNameResponse> 
    <return>
        <!-- Contents of ContentTag -->
    <return>
</getTagByNameResponse>

Errors

Error	When Returned
com.jivesoftware.community.TagObjectNotFoundException	if no tag exists with that name.

getTags

Return an Iterable for all the tags associated with this manager.

GET http://domain:port/application_context/rpc/rest/tagService/objectTags/{objectID}/{objectType}

Arguments

Name	Type	Description
objectType	xs:int	of object that has tags
objectID	xs:long	of object that has tags

Arguments Template

<getTags> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</getTags>

Response

Type	Description
List of ContentTag	an Iterable for all tags associated with this manager.

Response Template

<getTagsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ContentTag -->
    <return>
</getTagsResponse>

Errors

Error	When Returned
NotFound	if the object with that id and type isn't found

removeAllTags

Disassociates this object with all tags.

DELETE http://domain:port/application_context/rpc/rest/tagService/removeAllTags/{objectID}/{objectType}

Arguments

Name	Type	Description
objectType	xs:int	of object that has tags
objectID	xs:long	of object that has tags

Arguments Template

<removeAllTags> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</removeAllTags>

Errors

Error	When Returned
Unauthorized	if user does not have administrator permissions.
NotFound	if the object with that id and type isn't found

removeTag

Disassociates this object with the given tag.

DELETE http://domain:port/application_context/rpc/rest/tagService/objectTags/{tag}/{objectID}/{objectType}

Arguments

Name	Type	Description
tag	xs:string	The tag, must be the unfiltered value.
objectType	xs:int	of object that has tags
objectID	xs:long	of object that has tags

Arguments Template

<removeTag> 
    <tag>xs:string</tag>
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</removeTag>

Errors

Error	When Returned
Unauthorized	if does not have permission to remove tag to remove from this object
NotFound	if the object with that id and type isn't found