Clearspace Documentation : REST Web Services Reference

This document list the web services that Clearspace exposes via REST, or Representational State Transfer. This guide includes the following sections:

Reading This Reference

Example

Web Services

Complex Types

Reading This Reference

As with other REST-style web services, methods here are each in one of four forms, similar to database operations.

GET -- Like a select statement, GET retrieves information, returning XML. The method's parameters are typically appended to the request URI as shown in the syntax examples.
POST -- You can use a POST method to create, update, or delete data. When calling POST, you pass in XML that contains your methods parameters.
PUT -- With a PUT, you can create or update data. As with POST, you pass in XML with your method's parameters.
DELETE -- Use a DELETE method to delete data. The method's parameters are typically appended to the request URI as shown in the syntax examples.

The method descriptions here give the method type (also known as the HTTP "verb,"), such as GET, PUT, POST, or DELETE. They also give the resource endpoint. The endpoint is merely the end of the resource URI, which begins with the URL of your Clearspace instance and includes the general address of REST web services in Clearspace. Taken together, the complete URI's form is what you should use when requesting resources. That form looks like this:

http://<host_name>:<port_number>/<context>/rpc/rest/<endpoint>

So if your domain was at example.com and you had code to find out if avatars were enabled, you might end up with a resource URI like the following:

http://example.com:8080/ourspace/rpc/rest/avatarService/isAvatarsEnabled

Example

Here's a brief client example in Java for getting a Clearspace REST resource. REST services in Clearspace use basic authentication, so you'll need to pass in user credentials that have sufficient permission to get the resource you're requesting.

This example uses DOM4J and Apache's HttpClient, but there aren't any implementation restrictions on how you request the resource and manipulate XML parameter or return values.

import java.io.InputStream;

import org.apache.commons.httpclient.Credentials;
import org.apache.commons.httpclient.HttpClient;
import org.apache.commons.httpclient.UsernamePasswordCredentials;
import org.apache.commons.httpclient.auth.AuthScope;
import org.apache.commons.httpclient.methods.GetMethod;
import org.dom4j.Document;
import org.dom4j.io.OutputFormat;
import org.dom4j.io.SAXReader;
import org.dom4j.io.XMLWriter;

// Code omitted.

// Use apache commons-httpclient to create the request/response
HttpClient client = new HttpClient();
Credentials defaultcreds = new UsernamePasswordCredentials("joe_admin",
    "mypassword");
client.getState().setCredentials(AuthScope.ANY, defaultcreds);

// GET a community by its ID number, which is "1".
GetMethod method = new GetMethod(
    "http://example.com:8080/clearspace/rpc/rest/communityService/communities/1");
client.executeMethod(method);
InputStream in = method.getResponseBodyAsStream();

// Use dom4j to parse the response and print nicely to the output stream
SAXReader reader = new SAXReader();
Document document = reader.read(in);
XMLWriter writer = new XMLWriter(System.out, OutputFormat
    .createPrettyPrint());
writer.write(document);

Note that to use any of the web services exposed by Clearspace, you'll need to first enable web services for your Clearspace instance. You can do that in the admin console at System > Settings > Web Services. On the Web Services page, enable the type of web services you want exposed by Clearspace, then click Save Settings.

Web Services

Service	Description
addressBookService	Provides ability to interact with the Private Message addressbook.
attachmentService	<p> A web service for managing attachment settings.
auditService	Provides a webservice for auditing actions from remote services.
avatarService
blogService	A web service interface for managing blogs.
commentService
communityService	Provides the ability to manipulate communities.
documentService	This service provides methods to load and manipulate documents, comments.
forumService	Provides the ability to manipulate forum messages.
groupService	Provides a the ability for managing groups and group membership.
iMService	Provides a the ability for managing real time comunication.
permissionService	Provides a webservice for managing permissions on users and groups.
pluginService
pollService
privateMessageService	Provides the ability to manipulate private messages.
profileFieldService	Defines methods used to create, access, update, and remove profile fields data.
profileSearchService	Provides the ability to search users.
profileService	Manages user profile data.
projectService	This service provides methods to load tasks by ID and to retrieve lists of projects.
ratingsService
referenceService	Manager used to create references between different kind of jive objects.
searchService	Provides the ability to search for content.
socialGroupService	Provides a the ability for managing social groups and group membership.
statusLevelService	Manages status level feature.
systemPropertiesService	Provides a web service for managing Jive System Properties.
tagService	Provides a service to create, retrieve and delete tags.
taskService
userService	Provides a webservice for managing user's, avatar's, and status levels.
watchService	A service for manipulating a user's watches on objects.

addressBookService

Provides ability to interact with the Private Message addressbook. Retrieve, add and remove users.

Method	Description
addUser	Adds a specified username to users addressbook.
addUsers	Adds a list of users to the Private Message addressbook of the specified user.
getRoster	Retrieves a list of users contained within the specified users addressbook.
removeUser	Removes the specified username from a users Private Message addressbook.
removeUsers	Removes the specified list of users from a users Private Message addressbook.

addUser

Adds a specified username to users addressbook.

POST http://domain:port/clearspace_context/rpc/rest/addressBookService/addressbooks

Parameters

userID: associated with the addressbook to be manipulated

usernameToAdd: username of the user to add

Parameters Template

<addUser> 
    <userID>xs:long</userID>
    <usernameToAdd>xs:string</usernameToAdd>
</addUser>

addUsers

Adds a list of users to the Private Message addressbook of the specified user.

POST http://domain:port/clearspace_context/rpc/rest/addressBookService/bulk

Parameters

userID: associated with the addressbook to be manipulated

userIDsToAdd: list of userIds to add to the addressbook

Parameters Template

<addUsers> 
    <userID>xs:long</userID>
    <!-- List of ... -->
    <userIDsToAdd>xs:long</userIDsToAdd>
</addUsers>

getRoster

Retrieves a list of users contained within the specified users addressbook.

GET http://domain:port/clearspace_context/rpc/rest/addressBookService/addressbooks/{userID}

Parameters

userID: of the the users addressbook to retrieve

Parameters Template

<getRoster> 
    <userID>xs:long</userID>
</getRoster>

Return Value Template

<getRosterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of User -->
    <return>
</getRosterResponse>

removeUser

Removes the specified username from a users Private Message addressbook.

DELETE http://domain:port/clearspace_context/rpc/rest/addressBookService/addressbooks/{userID}/{usernameToRemove}

Parameters

userID: associated with the addressbook to be manipulated

usernameToRemove: username to remove from the addressbook

Parameters Template

<removeUser> 
    <userID>xs:long</userID>
    <usernameToRemove>xs:string</usernameToRemove>
</removeUser>

removeUsers

Removes the specified list of users from a users Private Message addressbook.

DELETE http://domain:port/clearspace_context/rpc/rest/addressBookService/bulk/{userID}/{userIDsToRemove}

Parameters

userID: associated with the addressbook to be manipulated

userIDsToRemove: list of user ids to remove from the addressbook

Parameters Template

<removeUsers> 
    <userID>xs:long</userID>
    <!-- List of ... -->
    <userIDsToRemove>xs:long</userIDsToRemove>
</removeUsers>

attachmentService

A web service for managing attachment settings. A clone of the com.jivesoftware.community.AttachmentManager, modified for a web service.

There are three main properties that can administered with respect to attachments:

Size -- the maximum size in bytes of an individual attachment. Control this value in order to prevent users from uploading massive files that choke the server.
Attachments Per Object -- control the number of attachments that people are allowed to add to each object.
Allowed Types -- the file types that are allowed or disallowed to be attachments.

Method	Description
addAllowedType	Adds a content type to the list of explicitly allowed types.
addDisallowedType	Adds a content type to the list of explicitly disallowed types.
getAllowedTypes	Returns a List of explicitly allowed types.
getDisallowedTypes	Returns a List of explicitly disallowed types.
getImagePreviewMaxSize	Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getMaxAttachmentSize	Returns the maximum size of an individual attachment in kilobytes.
getMaxAttachmentsPerBlogPost	Returns the maximum number of attachments per blog post.
getMaxAttachmentsPerDocument	Returns the maximum number of attachments per document.
getMaxAttachmentsPerMessage	Returns the maximum number of attachments per message.
isAllowAllByDefault	Returns true if in the "allow all content types by default" mode.
isAttachmentsEnabled	Returns true if attachments are enabled, false otherwise.
isImagePreviewEnabled	Returns true if image preview support is enabled.
isImagePreviewRatioEnabled	Returns true if the aspect ratio of thumbnails should be preserved.
isValidType	Returns true if the content type is valid based on the current settings of the <tt>allowAllByDefault</tt> flag and the allowed and disallowed types list.
removeAllowedType	Removes a content type fromt he list of explicitly allowed types.
removeDisallowedType	Removes a content type from the list of explicitly disallowed types.
setAllowAllByDefault	Sets the default allowed content types mode.
setAttachmentsEnabled	Sets whether attachments are attachmentsEnabled, false otherwise.
setImagePreviewEnabled	Toggles whether image preview support is enabled.
setImagePreviewMaxSize	Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
setImagePreviewRatioEnabled	Toggles whether the aspect ratio of thumbnails should be preserved.
setMaxAttachmentSize	Sets the maximum size of an individual attachment in kilobytes.
setMaxAttachmentsPerBlogPost	Sets the maximum number of attachments per blog post.
setMaxAttachmentsPerDocument	Sets the maximum number of attachments per document.
setMaxAttachmentsPerMessage	Sets the maximum number of attachments per message.

addAllowedType

Adds a content type to the list of explicitly allowed types.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/allowedTypes

Parameters

contentType: a content type to add to the explicitly allowed types list.

Parameters Template

<addAllowedType> 
    <contentType>xs:string</contentType>
</addAllowedType>

addDisallowedType

Adds a content type to the list of explicitly disallowed types.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/disallowedTypes

Parameters

contentType: a content type to add to the explicitly disallowed types list.

Parameters Template

<addDisallowedType> 
    <contentType>xs:string</contentType>
</addDisallowedType>

getAllowedTypes

Returns a List of explicitly allowed types.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/allowedTypes

Return Value Template

<getAllowedTypesResponse> 
    <!-- List of ... -->
    <return>xs:string</return>
</getAllowedTypesResponse>

getDisallowedTypes

Returns a List of explicitly disallowed types.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/disallowedTypes

Return Value Template

<getDisallowedTypesResponse> 
    <!-- List of ... -->
    <return>xs:string</return>
</getDisallowedTypesResponse>

getImagePreviewMaxSize

Returns the max dimension of generated thumbnails (ie, the max value for the width or height). The default value is 25.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewMaxSize

Return Value Template

<getImagePreviewMaxSizeResponse> 
    <return>xs:int</return>
</getImagePreviewMaxSizeResponse>

getMaxAttachmentSize

Returns the maximum size of an individual attachment in kilobytes. Trying to create an attachment larger than the max size will fail with an exception. The default maximum attachment size is 1 megabyte, or 1,024 K.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentSize

Return Value Template

<getMaxAttachmentSizeResponse> 
    <return>xs:int</return>
</getMaxAttachmentSizeResponse>

getMaxAttachmentsPerBlogPost

Returns the maximum number of attachments per blog post. The default is 5 attachments.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerBlogPost

Return Value Template

<getMaxAttachmentsPerBlogPostResponse> 
    <return>xs:int</return>
</getMaxAttachmentsPerBlogPostResponse>

getMaxAttachmentsPerDocument

Returns the maximum number of attachments per document. The default is 5 attachments.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerDoc

Return Value Template

<getMaxAttachmentsPerDocumentResponse> 
    <return>xs:int</return>
</getMaxAttachmentsPerDocumentResponse>

getMaxAttachmentsPerMessage

Returns the maximum number of attachments per message. The default is 5 attachments.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerMessage

Return Value Template

<getMaxAttachmentsPerMessageResponse> 
    <return>xs:int</return>
</getMaxAttachmentsPerMessageResponse>

isAllowAllByDefault

Returns true if in the "allow all content types by default" mode. The alternative is that all content types are disallowed unless they're on the "allowed" list.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/allowAllByDefault

Return Value Template

<isAllowAllByDefaultResponse> 
    <return>xs:boolean</return>
</isAllowAllByDefaultResponse>

isAttachmentsEnabled

Returns true if attachments are enabled, false otherwise.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/attachmentsEnabled

Return Value Template

<isAttachmentsEnabledResponse> 
    <return>xs:boolean</return>
</isAttachmentsEnabledResponse>

isImagePreviewEnabled

Returns true if image preview support is enabled. When enabled, the JiveServlet will generate thumbnails for image attachments. False by default.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewEnabled

Return Value Template

<isImagePreviewEnabledResponse> 
    <return>xs:boolean</return>
</isImagePreviewEnabledResponse>

isImagePreviewRatioEnabled

Returns true if the aspect ratio of thumbnails should be preserved. When enabled, the aspect ratio of the original image will be preserved when generating the thumbnail. When false, the thumbnail will always be a square (which may distort the image). The default is true..

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewRatioEnabled

Return Value Template

<isImagePreviewRatioEnabledResponse> 
    <return>xs:boolean</return>
</isImagePreviewRatioEnabledResponse>

isValidType

Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.

GET http://domain:port/clearspace_context/rpc/rest/attachmentService/allowedTypes/{contentType}

Parameters

contentType: the content type to test.

Parameters Template

<isValidType> 
    <contentType>xs:string</contentType>
</isValidType>

Return Value Template

<isValidTypeResponse> 
    <return>xs:boolean</return>
</isValidTypeResponse>

removeAllowedType

Removes a content type fromt he list of explicitly allowed types. If the given content type does not exist in the list, this method does nothing.

DELETE http://domain:port/clearspace_context/rpc/rest/attachmentService/allowedTypes/{contentType}

Parameters

contentType: a content type to remove from the explicitly allowed types list.

Parameters Template

<removeAllowedType> 
    <contentType>xs:string</contentType>
</removeAllowedType>

removeDisallowedType

Removes a content type from the list of explicitly disallowed types.

DELETE http://domain:port/clearspace_context/rpc/rest/attachmentService/disallowedTypes/{contentType}

Parameters

contentType: a content type to remove from the explicitly disallowed types list.

Parameters Template

<removeDisallowedType> 
    <contentType>xs:string</contentType>
</removeDisallowedType>

setAllowAllByDefault

Sets the default allowed content types mode. The value true means that all content types will be allowed unless they're on the "disallowed list". If false, no content types will be allowed unless on the "allowed list".

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/allowAllByDefault

Parameters

allowAllByDefault: <tt>true</tt> if all content types should be allowed by default.

Parameters Template

<setAllowAllByDefault> 
    <allowAllByDefault>xs:boolean</allowAllByDefault>
</setAllowAllByDefault>

setAttachmentsEnabled

Sets whether attachments are attachmentsEnabled, false otherwise.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/attachmentsEnabled

Parameters

attachmentsEnabled: true if attachments are attachmentsEnabled, false otherwise.

Parameters Template

<setAttachmentsEnabled> 
    <attachmentsEnabled>xs:boolean</attachmentsEnabled>
</setAttachmentsEnabled>

setImagePreviewEnabled

Toggles whether image preview support is enabled. When enabled, the JiveServlet will generate thumbnails for image attachments. False by default.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewEnabled

Parameters

imagePreviewEnabled: true if thumbnail support should be enabled.

Parameters Template

<setImagePreviewEnabled> 
    <imagePreviewEnabled>xs:boolean</imagePreviewEnabled>
</setImagePreviewEnabled>

setImagePreviewMaxSize

Sets the max dimension of generated thumbnails (ie, the max value for the width or height). The default value is 25.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewMaxSize

Parameters

imagePreviewMaxSize: the max dimension of a thumbnail.

Parameters Template

<setImagePreviewMaxSize> 
    <imagePreviewMaxSize>xs:int</imagePreviewMaxSize>
</setImagePreviewMaxSize>

setImagePreviewRatioEnabled

Toggles whether the aspect ratio of thumbnails should be preserved. When enabled, the aspect ratio of the original image will be preserved when generating the thumbnail. When false, the thumbnail will always be a square (which may distort the image). The default is true.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/imagePreviewRatioEnabled

Parameters

imagePreviewRatioEnabled: true if the aspect ration should be preserved.

Parameters Template

<setImagePreviewRatioEnabled> 
    <imagePreviewRatioEnabled>xs:boolean</imagePreviewRatioEnabled>
</setImagePreviewRatioEnabled>

setMaxAttachmentSize

Sets the maximum size of an individual attachment in kilobytes. Trying to create an attachment larger than the max size will fail with an exception. The default maximum attachment size is 1 megabyte, or 1024 K.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentSize

Parameters

maxAttachmentSize: the max size in kilobytes of any single attachment.

Parameters Template

<setMaxAttachmentSize> 
    <maxAttachmentSize>xs:int</maxAttachmentSize>
</setMaxAttachmentSize>

setMaxAttachmentsPerBlogPost

Sets the maximum number of attachments per blog post. The default is 5 attachments.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerBlogPost

Parameters

maxAttachmentsPerBlogPost: the max number of attachments allowed per blog post.

Parameters Template

<setMaxAttachmentsPerBlogPost> 
    <maxAttachmentsPerBlogPost>xs:int</maxAttachmentsPerBlogPost>
</setMaxAttachmentsPerBlogPost>

setMaxAttachmentsPerDocument

Sets the maximum number of attachments per document. The default is 5 attachments.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerDocument

Parameters

maxAttachmentsPerDocument: the max number of attachments allowed per document.

Parameters Template

<setMaxAttachmentsPerDocument> 
    <maxAttachmentsPerDocument>xs:int</maxAttachmentsPerDocument>
</setMaxAttachmentsPerDocument>

setMaxAttachmentsPerMessage

Sets the maximum number of attachments per message. The default is 5 attachments.

POST http://domain:port/clearspace_context/rpc/rest/attachmentService/maxAttachmentsPerMessage

Parameters

maxAttachmentsPerMessage: the max number of attachments allowed per message.

Parameters Template

<setMaxAttachmentsPerMessage> 
    <maxAttachmentsPerMessage>xs:int</maxAttachmentsPerMessage>
</setMaxAttachmentsPerMessage>

auditService

Provides a webservice for auditing actions from remote services.

For soap services this service can be accessed at /rpc/soap/AuditService For rest services this service can be accessed at /rpc/rest/audit

Method	Description
auditEvent	Audits (logs) a remote event with formatted data passed from remote service.
getAuditMessages	Retrieves audit logs and returns them to remote caller.

auditEvent

Audits (logs) a remote event with formatted data passed from remote service.

POST http://domain:port/clearspace_context/rpc/rest/auditService/audit

Parameters

username: The name of user.

description: The description (summary) of the event.

details: The details of the method call.

Parameters Template

<auditEvent> 
    <username>xs:string</username>
    <description>xs:string</description>
    <details>xs:string</details>
</auditEvent>

getAuditMessages

Retrieves audit logs and returns them to remote caller.

GET http://domain:port/clearspace_context/rpc/rest/auditService/audit

Return Value Template

<getAuditMessagesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of AuditMessage -->
    <return>
</getAuditMessagesResponse>

avatarService

Method	Description
createAvatar	Creates a new avatar for a user allowing the user to specify byte array for the image.
deleteAvatar	Deletes an avatar from the system.
getActiveAvatar	Returns an avatar for a user, else the if the user does not have an active avatar specified.
getAvatar	Used to acquire an avatar by its id
getAvatarCount	Used to acquire a count of all the avatars for a specific user
getAvatars	Returns a collection of avatars for a user
getGlobalAvatars	Returns a collection of all of the global avatars
getMaxAllowableHeight	Returns the maximum allowable height for an avatar image
getMaxAllowableWidth	Returns the maximum allowable width for an avatar image
getMaxUserAvatars	Returns the maximum amount of avatars a user is allowed to have, -1 for limitless
getModerationAvatarCount	Used to acquire a count of all the avatars that require moderation.
getModerationAvatars	Returns a collection of all of the avatars that require moderation.
isAllowImageResize	Returns true if the system should attempt to resize images
isAvatarsEnabled	Returns true if the avatars feature is enabled, else false
isModerateUserAvatars	Returns whether or not user avatars will be moderated.
isUserAvatarsEnabled	Returns true if users can create their own avatars, false otherwise.
setActiveAvatar	Used to make a user use a global avatar, to set no active avatar pass -1 for the avatar value.
setAllowImageResize	Used to set whether the system should attempt to resize images
setMaxAllowableHeight	Sets the maximum allowable height for an avatar image
setMaxAllowableWidth	Sets the maximum allowable width for an avatar image
setMaxUserAvatars	Sets the maximum number of avatars a user can have
setModerateUserAvatars	Sets whether or not user avatars will be moderated.
setUserAvatarsEnabled	Sets whether or not users can create their own custom avatars.

createAvatar

Creates a new avatar for a user allowing the user to specify byte array for the image.

POST http://domain:port/clearspace_context/rpc/rest/avatarService/avatars

Parameters

ownerID: the user ID to create the avatar for

name: image name of the avatar

contentType: mime type of the image

data: byte array of the image

Parameters Template

<createAvatar> 
    <ownerID>xs:long</ownerID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <data>xs:base64Binary</data>
</createAvatar>

Return Value Template

<createAvatarResponse> 
    <return>
        <!-- Contents of Avatar -->
    <return>
</createAvatarResponse>

deleteAvatar

Deletes an avatar from the system.

DELETE http://domain:port/clearspace_context/rpc/rest/avatarService/avatar/{avatarID}

Parameters

avatarID: the avatar ID to delete

Parameters Template

<deleteAvatar> 
    <avatarID>xs:long</avatarID>
</deleteAvatar>

getActiveAvatar

Returns an avatar for a user, else the if the user does not have an active avatar specified.

GET http://domain:port/clearspace_context/rpc/rest/avatarService/activeAvatar/{userID}

Parameters

userID: user ID to acquire an avatar for

Parameters Template

<getActiveAvatar> 
    <userID>xs:long</userID>
</getActiveAvatar>

Return Value Template

<getActiveAvatarResponse> 
    <return>
        <!-- Contents of Avatar -->
    <return>
</getActiveAvatarResponse>

getAvatar

Used to acquire an avatar by its id

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarByID/{avatarID}

Parameters

avatarID: unique id of the avatar

Parameters Template

<getAvatar> 
    <avatarID>xs:long</avatarID>
</getAvatar>

Return Value Template

<getAvatarResponse> 
    <return>
        <!-- Contents of Avatar -->
    <return>
</getAvatarResponse>

getAvatarCount

Used to acquire a count of all the avatars for a specific user

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarCount/{userID}

Parameters

userID: user to count avatars for

Parameters Template

<getAvatarCount> 
    <userID>xs:long</userID>
</getAvatarCount>

Return Value Template

<getAvatarCountResponse> 
    <return>xs:int</return>
</getAvatarCountResponse>

getAvatars

Returns a collection of avatars for a user

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarsByUser/{userID}

Parameters

userID: user ID to find an avatar for

Parameters Template

<getAvatars> 
    <userID>xs:long</userID>
</getAvatars>

Return Value Template

<getAvatarsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Avatar -->
    <return>
</getAvatarsResponse>

getGlobalAvatars

Returns a collection of all of the global avatars

GET http://domain:port/clearspace_context/rpc/rest/avatarService/globalAvatars

Return Value Template

<getGlobalAvatarsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Avatar -->
    <return>
</getGlobalAvatarsResponse>

getMaxAllowableHeight

Returns the maximum allowable height for an avatar image

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarMaxAllowableHeight

Return Value Template

<getMaxAllowableHeightResponse> 
    <return>xs:int</return>
</getMaxAllowableHeightResponse>

getMaxAllowableWidth

Returns the maximum allowable width for an avatar image

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarMaxAllowableWidth

Return Value Template

<getMaxAllowableWidthResponse> 
    <return>xs:int</return>
</getMaxAllowableWidthResponse>

getMaxUserAvatars

Returns the maximum amount of avatars a user is allowed to have, -1 for limitless

GET http://domain:port/clearspace_context/rpc/rest/avatarService/maxUserAvatars

Return Value Template

<getMaxUserAvatarsResponse> 
    <return>xs:int</return>
</getMaxUserAvatarsResponse>

getModerationAvatarCount

Used to acquire a count of all the avatars that require moderation.

GET http://domain:port/clearspace_context/rpc/rest/avatarService/moderationAvatarCount

Return Value Template

<getModerationAvatarCountResponse> 
    <return>xs:int</return>
</getModerationAvatarCountResponse>

getModerationAvatars

Returns a collection of all of the avatars that require moderation.

GET http://domain:port/clearspace_context/rpc/rest/avatarService/moderationAvatars

Return Value Template

<getModerationAvatarsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Avatar -->
    <return>
</getModerationAvatarsResponse>

isAllowImageResize

Returns true if the system should attempt to resize images

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarAllowImageResize

Return Value Template

<isAllowImageResizeResponse> 
    <return>xs:boolean</return>
</isAllowImageResizeResponse>

isAvatarsEnabled

Returns true if the avatars feature is enabled, else false

GET http://domain:port/clearspace_context/rpc/rest/avatarService/avatarsEnabled

Return Value Template

<isAvatarsEnabledResponse> 
    <return>xs:boolean</return>
</isAvatarsEnabledResponse>

isModerateUserAvatars

Returns whether or not user avatars will be moderated. The default value is true.

GET http://domain:port/clearspace_context/rpc/rest/avatarService/moderateUserAvatars

Return Value Template

<isModerateUserAvatarsResponse> 
    <return>xs:boolean</return>
</isModerateUserAvatarsResponse>

isUserAvatarsEnabled

Returns true if users can create their own avatars, false otherwise. If custom user avatars are enabled, the number of custom avatars allowed per user and whether or not custom avatars should be moderated can be set using setMaxUserAvatars(int max); and setModerateUserAvatars(boolean moderateUserAvatars); respecitvely.

GET http://domain:port/clearspace_context/rpc/rest/avatarService/userAvatarsEnabled

Return Value Template

<isUserAvatarsEnabledResponse> 
    <return>xs:boolean</return>
</isUserAvatarsEnabledResponse>

setActiveAvatar

Used to make a user use a global avatar, to set no active avatar pass -1 for the avatar value.

POST http://domain:port/clearspace_context/rpc/rest/avatarService/activeAvatar

Parameters

userID: the user ID to set an avatar for

avatarID: the avatar ID to make active

Parameters Template

<setActiveAvatar> 
    <userID>xs:long</userID>
    <avatarID>xs:long</avatarID>
</setActiveAvatar>

setAllowImageResize

Used to set whether the system should attempt to resize images

POST http://domain:port/clearspace_context/rpc/rest/avatarService/avatarAllowImageResize

Parameters

isAllowImageResize: whether the system should attempt to resize images

Parameters Template

<setAllowImageResize> 
    <isAllowImageResize>xs:boolean</isAllowImageResize>
</setAllowImageResize>

setMaxAllowableHeight

Sets the maximum allowable height for an avatar image

POST http://domain:port/clearspace_context/rpc/rest/avatarService/avatarMaxAllowableHeight

Parameters

height: the maximum allowable height for an avatar image

Parameters Template

<setMaxAllowableHeight> 
    <height>xs:int</height>
</setMaxAllowableHeight>

setMaxAllowableWidth

Sets the maximum allowable width for an avatar image

POST http://domain:port/clearspace_context/rpc/rest/avatarService/avatarMaxAllowableWidth

Parameters

width: the maximum allowable width for an avatar image

Parameters Template

<setMaxAllowableWidth> 
    <width>xs:int</width>
</setMaxAllowableWidth>

setMaxUserAvatars

Sets the maximum number of avatars a user can have

POST http://domain:port/clearspace_context/rpc/rest/avatarService/maxUserAvatars

Parameters

max: the maximum number of avatars a user can have

Parameters Template

<setMaxUserAvatars> 
    <max>xs:int</max>
</setMaxUserAvatars>

setModerateUserAvatars

Sets whether or not user avatars will be moderated. The default value is true.

POST http://domain:port/clearspace_context/rpc/rest/avatarService/moderateUserAvatars

Parameters

moderateUserAvatars: whether or not user avatars will be moderated

Parameters Template

<setModerateUserAvatars> 
    <moderateUserAvatars>xs:boolean</moderateUserAvatars>
</setModerateUserAvatars>

setUserAvatarsEnabled

Sets whether or not users can create their own custom avatars. If custom user avatars are enabled, the number of custom avatars allowed per user and whether or not custom avatars should be moderated can be set using setMaxUserAvatars(int max); and setModerateUserAvatars(boolean moderateUserAvatars); respecitvely.

POST http://domain:port/clearspace_context/rpc/rest/avatarService/userAvatarsEnabled

Parameters

enableCustomAvatars: true if custom user avatars are enabled, false otherwise

Parameters Template

<setUserAvatarsEnabled> 
    <enableCustomAvatars>xs:boolean</enableCustomAvatars>
</setUserAvatarsEnabled>

blogService

A web service interface for managing blogs.

Method	Description
addAttachmentToBlogPost	Adds an attachment to the blog post with the specified ID.
addImageToBlogPost	Adds an image to the blog post with the specified ID.
createBlog	Creates a new blog.
createBlogPost	Creates a new blog post.
deleteBlog	Permanently deletes a blog and all of the blog postings and comments associated with the blog.
deleteBlogPost	Permanently deletes a blog post and all of the comments associated with the it.
getAttachmentsByBlogPostID	Returns an array of attachments that are attached to the specified blog post.
getBlog	Returns a blog by blog blogName.
getBlog	Returns a blog by blog ID.
getBlogCount	Returns the total number of blogs on this system.
getBlogCount	Returns the total number of blogs on this system that match the criteria specified by the ResultFilter.
getBlogCountForUser	Returns the count of all blogs which are associated with the given user.
getBlogPost	Returns a blog by blog ID.
getBlogPostCount	Returns the number of blog posts on the system, by default only includes blog posts where status = and publish date less than now().
getBlogPostCount	Returns the number of blog posts on the system.
getBlogPosts	Returns all the blog posts that match the criteria specified by the BlogPostResultFilter on the entire system.
getBlogsByDisplayName	Returns all the blogs on this system whose display name is LIKE the given query.
getBlogsForUser	Returns all blogs which are associated with the given user.
getCommentCount	Returns the number of comments on blog posts in the system.
getCommentCount	Returns the number of comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getComments	Returns all the comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getImagesByBlogPostID	Returns an array of images that are attached to the specified blog post.
getPingServices	Returns a comma delimited list of available ping services for the system.
getRecentBlogs	Returns (at most) the ten most recent blogs created on this system.
getTags	Returns all tags for blogs in the system.
getTags	Returns all tags for blogs in the system filtered by the BlogTagResultFilter.
isBlogsEnabled	Returns true if the blogs feature is turned on.
isCommentsEnabled	Returns true if the comments feature is turned on.
isPingsEnabled	Returns true if the pings feature is turned on.
isPingsOverrideEnabled	Returns true if the system has been configured to allow users to override the ping URIs configured for the system.
isTrackbacksEnabled	Returns true if the trackbacks feature is turned on.
publishBlogPost
removeAttachment	Removes the attachment with the supplied id as an attachment of a blog.
setBlogsEnabled	Enables or disables the blogs feature.
setCommentsEnabled	Enables or disables the comments feature system wide.
setPingServices	Sets the comma delimited list of available ping services for the system.
setPingsEnabled	Enables or disables the pings feature system wide.
setPingsOverrideEnabled	Configures the system to allow users to override the ping URIs configured for all blogs.
setTrackbacksEnabled	Enables or disables the trackbacks feature system wide.
updateBlogPost
uploadAttachmentToBlogPost	Uploads a new attachment to the blog post with the specified ID.
userHasBlogs	Returns <tt>true</tt> if the given user has one or more blogs, <tt>false</tt> if the user does not have a blog.

addAttachmentToBlogPost

Adds an attachment to the blog post with the specified ID.

POST http://domain:port/clearspace_context/rpc/rest/blogService/attachments

Parameters

blogPostID: The ID of the blog post.

name: The name of the attachment.

contentTypes: the content type of the attachment.

source: The content for the attachment.

Parameters Template

<addAttachmentToBlogPost> 
    <blogPostID>xs:long</blogPostID>
    <name>xs:string</name>
    <contentTypes>xs:string</contentTypes>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addAttachmentToBlogPost>

addImageToBlogPost

Adds an image to the blog post with the specified ID.

POST http://domain:port/clearspace_context/rpc/rest/blogService/images

Parameters

blogPostID: The ID of the blog post.

name: The name of the image.

contentTypes: the content type of the image.

source: The content for the image.

Parameters Template

<addImageToBlogPost> 
    <blogPostID>xs:long</blogPostID>
    <name>xs:string</name>
    <contentTypes>xs:string</contentTypes>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addImageToBlogPost>

createBlog

Creates a new blog.

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogs

Parameters

userID: the user ID creating the blog.

blogName: the name of the blog.

displayName: the display name of the blog.

Parameters Template

<createBlog> 
    <userID>xs:long</userID>
    <blogName>xs:string</blogName>
    <displayName>xs:string</displayName>
</createBlog>

Return Value Template

<createBlogResponse> 
    <return>
        <!-- Contents of Blog -->
    <return>
</createBlogResponse>

createBlogPost

Creates a new blog post.

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogPosts

Parameters

subject: the subject of the blog post.

body: the body content of the blog post.

blogID: the id of the blog to post to.

userID: the user ID creating the blog post.

Parameters Template

<createBlogPost> 
    <subject>xs:string</subject>
    <body>xs:string</body>
    <blogID>xs:long</blogID>
    <userID>xs:long</userID>
</createBlogPost>

Return Value Template

<createBlogPostResponse> 
    <return>
        <!-- Contents of BlogPost -->
    <return>
</createBlogPostResponse>

deleteBlog

Permanently deletes a blog and all of the blog postings and comments associated with the blog.

DELETE http://domain:port/clearspace_context/rpc/rest/blogService/blogs/{blogID}

Parameters

blogID: the ID of the blog to delete.

Parameters Template

<deleteBlog> 
    <blogID>xs:long</blogID>
</deleteBlog>

deleteBlogPost

Permanently deletes a blog post and all of the comments associated with the it.

DELETE http://domain:port/clearspace_context/rpc/rest/blogService/blogPosts/{blogPostID}

Parameters

blogPostID: the ID of the blog post to delete.

Parameters Template

<deleteBlogPost> 
    <blogPostID>xs:long</blogPostID>
</deleteBlogPost>

getAttachmentsByBlogPostID

Returns an array of attachments that are attached to the specified blog post.

GET http://domain:port/clearspace_context/rpc/rest/blogService/attachments/{blogPostID}

Parameters

blogPostID: The ID of the blog post to acquire attachments for.

Parameters Template

<getAttachmentsByBlogPostID> 
    <blogPostID>xs:long</blogPostID>
</getAttachmentsByBlogPostID>

Return Value Template

<getAttachmentsByBlogPostIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Attachment -->
    <return>
</getAttachmentsByBlogPostIDResponse>

getBlog

Returns a blog by blog ID.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogsByID/{blogID}

Parameters

blogID: the ID of the blog to return.

Parameters Template

<getBlog> 
    <blogID>xs:long</blogID>
</getBlog>

Return Value Template

<getBlogResponse> 
    <return>
        <!-- Contents of Blog -->
    <return>
</getBlogResponse>

getBlog

Returns a blog by blog blogName.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogsByName/{blogName}

Parameters

blogName: the displayName of the blog to return.

Parameters Template

<getBlog> 
    <blogName>xs:string</blogName>
</getBlog>

Return Value Template

<getBlogResponse> 
    <return>
        <!-- Contents of Blog -->
    <return>
</getBlogResponse>

getBlogCount

Returns the total number of blogs on this system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogCount

Return Value Template

<getBlogCountResponse> 
    <return>xs:int</return>
</getBlogCountResponse>

getBlogCount

Returns the total number of blogs on this system that match the criteria specified by the ResultFilter.

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogCount

Parameters

filter: the besult filter holding the criteria to filter the blog count

Parameters Template

<getBlogCount> 
    <filter>
        <!-- Contents of BlogResultFilter -->
    <filter>
</getBlogCount>

Return Value Template

<getBlogCountResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Blog -->
    <return>
</getBlogCountResponse>

getBlogCountForUser

Returns the count of all blogs which are associated with the given user.

GET http://domain:port/clearspace_context/rpc/rest/blogService/userBlogCount/{userID}

Parameters

userID: the ID of the user to find blogs for

Parameters Template

<getBlogCountForUser> 
    <userID>xs:long</userID>
</getBlogCountForUser>

Return Value Template

<getBlogCountForUserResponse> 
    <return>xs:int</return>
</getBlogCountForUserResponse>

getBlogPost

Returns a blog by blog ID.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogPosts/{blogPostID}

Parameters

blogPostID: the ID of the blog to return.

Parameters Template

<getBlogPost> 
    <blogPostID>xs:long</blogPostID>
</getBlogPost>

Return Value Template

<getBlogPostResponse> 
    <return>
        <!-- Contents of BlogPost -->
    <return>
</getBlogPostResponse>

getBlogPostCount

Returns the number of blog posts on the system, by default only includes blog posts where status = and publish date less than now().

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogPostCount

Return Value Template

<getBlogPostCountResponse> 
    <return>xs:int</return>
</getBlogPostCountResponse>

getBlogPostCount

Returns the number of blog posts on the system. The default blog post result filter () only includes blog posts where status = and publish date less than now().

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogPostCount

Parameters

filter: the besult filter holding the criteria to filter the blogposts

Parameters Template

<getBlogPostCount> 
    <filter>
        <!-- Contents of BlogPostResultFilter -->
    <filter>
</getBlogPostCount>

Return Value Template

<getBlogPostCountResponse> 
    <return>xs:int</return>
</getBlogPostCountResponse>

getBlogPosts

Returns all the blog posts that match the criteria specified by the BlogPostResultFilter on the entire system.

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogsPostsWithFilter

Parameters

filter: a BlogPostResultFilter object to perform filtering and sorting with.

Parameters Template

<getBlogPosts> 
    <filter>
        <!-- Contents of BlogPostResultFilter -->
    <filter>
</getBlogPosts>

Return Value Template

<getBlogPostsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of BlogPost -->
    <return>
</getBlogPostsResponse>

getBlogsByDisplayName

Returns all the blogs on this system whose display name is LIKE the given query.

NOTE: This method is designed only to be used only by administrators for administration purposes and will throw an UnauthorizedException if the current user is not a system administrator.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogsByDisplayName/{query}/{startIndex}/{endIndex}/{numResults}

Parameters

query: a string to search blog display names by

startIndex: Starting index to grab blogs.

endIndex: Ending index to grab blogs.

numResults: Total number of results to grab.

Parameters Template

<getBlogsByDisplayName> 
    <query>xs:string</query>
    <startIndex>xs:int</startIndex>
    <endIndex>xs:int</endIndex>
    <numResults>xs:int</numResults>
</getBlogsByDisplayName>

Return Value Template

<getBlogsByDisplayNameResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Blog -->
    <return>
</getBlogsByDisplayNameResponse>

getBlogsForUser

Returns all blogs which are associated with the given user.

GET http://domain:port/clearspace_context/rpc/rest/blogService/userBlogs/{userID}

Parameters

userID: the ID of the user to find blogs for

Parameters Template

<getBlogsForUser> 
    <userID>xs:long</userID>
</getBlogsForUser>

Return Value Template

<getBlogsForUserResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Blog -->
    <return>
</getBlogsForUserResponse>

getCommentCount

Returns the number of comments on blog posts in the system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/commentCount

Return Value Template

<getCommentCountResponse> 
    <return>xs:int</return>
</getCommentCountResponse>

getCommentCount

Returns the number of comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.

POST http://domain:port/clearspace_context/rpc/rest/blogService/commentCountWithFilter

Parameters

filter: a FeedbackResultFilter object to perform filtering and sorting with.

Parameters Template

<getCommentCount> 
    <filter>
        <!-- Contents of FeedbackResultFilter -->
    <filter>
</getCommentCount>

Return Value Template

<getCommentCountResponse> 
    <return>xs:int</return>
</getCommentCountResponse>

getComments

Returns all the comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.

POST http://domain:port/clearspace_context/rpc/rest/blogService/commentsWithFilter

Parameters

filter: a FeedbackResultFilter object to perform filtering and sorting with.

Parameters Template

<getComments> 
    <filter>
        <!-- Contents of FeedbackResultFilter -->
    <filter>
</getComments>

Return Value Template

<getCommentsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Comment -->
    <return>
</getCommentsResponse>

getImagesByBlogPostID

Returns an array of images that are attached to the specified blog post.

GET http://domain:port/clearspace_context/rpc/rest/blogService/images/{blogPostID}

Parameters

blogPostID: The ID of the blog post to acquire images for.

Parameters Template

<getImagesByBlogPostID> 
    <blogPostID>xs:long</blogPostID>
</getImagesByBlogPostID>

Return Value Template

<getImagesByBlogPostIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Image -->
    <return>
</getImagesByBlogPostIDResponse>

getPingServices

Returns a comma delimited list of available ping services for the system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/pingServices

Return Value Template

<getPingServicesResponse> 
    <return>xs:string</return>
</getPingServicesResponse>

getRecentBlogs

Returns (at most) the ten most recent blogs created on this system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/recentBlogs

Return Value Template

<getRecentBlogsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Blog -->
    <return>
</getRecentBlogsResponse>

getTags

Returns all tags for blogs in the system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/tags

Return Value Template

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

getTags

Returns all tags for blogs in the system filtered by the BlogTagResultFilter.

POST http://domain:port/clearspace_context/rpc/rest/blogService/tags

Return Value Template

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

isBlogsEnabled

Returns true if the blogs feature is turned on. When blogs are disabled, other methods serve as no-ops.

GET http://domain:port/clearspace_context/rpc/rest/blogService/blogsEnabled

Return Value Template

<isBlogsEnabledResponse> 
    <return>xs:boolean</return>
</isBlogsEnabledResponse>

isCommentsEnabled

Returns true if the comments feature is turned on. When comments are disabled on the system, all individual blog comment settings are disabled as well.

GET http://domain:port/clearspace_context/rpc/rest/blogService/commentsEnabled

Return Value Template

<isCommentsEnabledResponse> 
    <return>xs:boolean</return>
</isCommentsEnabledResponse>

isPingsEnabled

Returns true if the pings feature is turned on. When pings are disabled on the system, all individual blog ping settings are disabled as well.

GET http://domain:port/clearspace_context/rpc/rest/blogService/pingsEnabled

Return Value Template

<isPingsEnabledResponse> 
    <return>xs:boolean</return>
</isPingsEnabledResponse>

isPingsOverrideEnabled

Returns true if the system has been configured to allow users to override the ping URIs configured for the system.

GET http://domain:port/clearspace_context/rpc/rest/blogService/pingsOverrideEnabled

Return Value Template

<isPingsOverrideEnabledResponse> 
    <return>xs:boolean</return>
</isPingsOverrideEnabledResponse>

isTrackbacksEnabled

Returns true if the trackbacks feature is turned on. When trackbacks are disabled on the system, all individual blog trackback settings are disabled as well.

GET http://domain:port/clearspace_context/rpc/rest/blogService/trackbacksEnabled

Return Value Template

<isTrackbacksEnabledResponse> 
    <return>xs:boolean</return>
</isTrackbacksEnabledResponse>

publishBlogPost

POST http://domain:port/clearspace_context/rpc/rest/blogService/publishBlogPost

Parameters

subject

body

blogID

userID

Parameters Template

<publishBlogPost> 
    <subject>xs:string</subject>
    <body>xs:string</body>
    <blogID>xs:long</blogID>
    <userID>xs:long</userID>
</publishBlogPost>

Return Value Template

<publishBlogPostResponse> 
    <return>
        <!-- Contents of BlogPost -->
    <return>
</publishBlogPostResponse>

removeAttachment

Removes the attachment with the supplied id as an attachment of a blog. Only administrators or the creator of the blog are allowed to call this method.

DELETE http://domain:port/clearspace_context/rpc/rest/blogService/attachments/{attachmentID}

Parameters

attachmentID: The id of the attachment to remove.

Parameters Template

<removeAttachment> 
    <attachmentID>xs:long</attachmentID>
</removeAttachment>

setBlogsEnabled

Enables or disables the blogs feature. When blogs are disabled, other methods serve as no-ops.

POST http://domain:port/clearspace_context/rpc/rest/blogService/blogsEnabled

Parameters

blogsEnabled: true to enable the blogs feature, false to disable

Parameters Template

<setBlogsEnabled> 
    <blogsEnabled>xs:boolean</blogsEnabled>
</setBlogsEnabled>

setCommentsEnabled

Enables or disables the comments feature system wide.

POST http://domain:port/clearspace_context/rpc/rest/blogService/commentsEnabled

Parameters

commentsEnabled: true to enable the comments feature, false to disable

Parameters Template

<setCommentsEnabled> 
    <commentsEnabled>xs:boolean</commentsEnabled>
</setCommentsEnabled>

setPingServices

Sets the comma delimited list of available ping services for the system.

POST http://domain:port/clearspace_context/rpc/rest/blogService/pingServices

Parameters

services: comma delimited list of available ping services for the system.

Parameters Template

<setPingServices> 
    <services>xs:string</services>
</setPingServices>

setPingsEnabled

Enables or disables the pings feature system wide.

POST http://domain:port/clearspace_context/rpc/rest/blogService/pingsEnabled

Parameters

pingsEnabled: true to enable the ping feature, false to disable

Parameters Template

<setPingsEnabled> 
    <pingsEnabled>xs:boolean</pingsEnabled>
</setPingsEnabled>

setPingsOverrideEnabled

Configures the system to allow users to override the ping URIs configured for all blogs.

POST http://domain:port/clearspace_context/rpc/rest/blogService/pingsOverrideEnabled

Parameters

pingsOverrideEnabled: true to enable users to override the system settings, false to use system settings.

Parameters Template

<setPingsOverrideEnabled> 
    <pingsOverrideEnabled>xs:boolean</pingsOverrideEnabled>
</setPingsOverrideEnabled>

setTrackbacksEnabled

Enables or disables the trackbacks feature system wide.

POST http://domain:port/clearspace_context/rpc/rest/blogService/trackbacksEnabled

Parameters

trackbacksEnabled: true to enable the trackback feature, false to disable

Parameters Template

<setTrackbacksEnabled> 
    <trackbacksEnabled>xs:boolean</trackbacksEnabled>
</setTrackbacksEnabled>

updateBlogPost

PUT http://domain:port/clearspace_context/rpc/rest/blogService/blogPosts

Parameters

blogPost

Parameters Template

<updateBlogPost> 
    <blogPost>
        <!-- Contents of BlogPost -->
    <blogPost>
</updateBlogPost>

uploadAttachmentToBlogPost

Uploads a new attachment to the blog post with the specified ID.

POST http://domain:port/clearspace_context/rpc/rest/blogService/attachmentUpload

Parameters

blogPostID: The ID of the blog post.

name: The name of the attachment.

contentTypes: the content type of the attachment.

source: The content for the attachment.

Parameters Template

<uploadAttachmentToBlogPost> 
    <blogPostID>xs:long</blogPostID>
    <name>xs:string</name>
    <contentTypes>xs:string</contentTypes>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</uploadAttachmentToBlogPost>

Return Value Template

<uploadAttachmentToBlogPostResponse> 
    <return>
        <!-- Contents of Attachment -->
    <return>
</uploadAttachmentToBlogPostResponse>

userHasBlogs

Returns true if the given user has one or more blogs, false if the user does not have a blog.

GET http://domain:port/clearspace_context/rpc/rest/blogService/userHasBlogs

Parameters

userID: the user to check to see if they have a blog

Parameters Template

<userHasBlogs> 
    <userID>xs:long</userID>
</userHasBlogs>

Return Value Template

<userHasBlogsResponse> 
    <return>xs:boolean</return>
</userHasBlogsResponse>

commentService

Method	Description
addComment	Adds a new comment to an object.
addCommentToComment	Adds a new comment having a parent comment to the object.
deleteAllComments	Deletes all comments on the object.
deleteComment	Deletes a comment in the object.
deleteCommentRecursive	Deletes a comment in the object.
getComment	Acquire a comment.
getCommentCount	Returns the number of comments in the object.
getCommentCountWithFilter	Returns the number of comments in the object based on the specified ResultFilter.
getComments	Returns an array of all the comments in the object.
getUserContentCommentCount	Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentCommentCountWithFilter	Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentComments	Returns array of all the comments in all content which has been authored by the supplied user.
getUserContentCommentsWithFilter	Returns array of all the comments in all content which has been authored by the supplied user.
updateComment	Updates an existing comment.

addComment

Adds a new comment to an object.

POST http://domain:port/clearspace_context/rpc/rest/commentService/comments

Parameters

objectType: The object type of the parent.

objectID: The object id of the parent.

userID: The id of the user.

body: The comment body.

Parameters Template

<addComment> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <userID>xs:long</userID>
    <body>xs:string</body>
</addComment>

Return Value Template

<addCommentResponse> 
    <return>
        <!-- Contents of Comment -->
    <return>
</addCommentResponse>

addCommentToComment

Adds a new comment having a parent comment to the object.

POST http://domain:port/clearspace_context/rpc/rest/commentService/comments/addChild

Parameters

objectType: The parent jive object's object type.

objectID: The parent object's id.

commentID: The id of the parent comment.

userID: Body of the new comment.

body: Add the id of the new user.

Parameters Template

<addCommentToComment> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <commentID>xs:long</commentID>
    <userID>xs:long</userID>
    <body>xs:string</body>
</addCommentToComment>

Return Value Template

<addCommentToCommentResponse> 
    <return>
        <!-- Contents of Comment -->
    <return>
</addCommentToCommentResponse>

deleteAllComments

Deletes all comments on the object.

DELETE http://domain:port/clearspace_context/rpc/rest/commentService/comments/{objectType}/{objectID}

Parameters

objectType: The object type of the parent object.

objectID: The object id of the parent id.

Parameters Template

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

deleteComment

Deletes a comment in the object. Deleting a comment also deletes all of its children comments. The search index and other resources that referenced the comment and its children will also be updated appropriately.

DELETE http://domain:port/clearspace_context/rpc/rest/commentService/comments/{objectType}/{objectID}/{commentID}

Parameters

objectType: The owner's object type.

objectID: The owner's object id.

commentID: the id of the comment to delete

Parameters Template

<deleteComment> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <commentID>xs:long</commentID>
</deleteComment>

deleteCommentRecursive

Deletes a comment in the object. The search index and other resources that referenced the comment will also be updated appropriately.

DELETE http://domain:port/clearspace_context/rpc/rest/commentService/comments/recursiveDelete/{objectType}/{objectID}/{commentID}/{recursive}

Parameters

objectType: The object type of the parent.

objectID: The object id of the parent.

commentID: The id of the comment to delete.

recursive: true to delete all the child comments, false to leave the children.

Parameters Template

<deleteCommentRecursive> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <commentID>xs:long</commentID>
    <recursive>xs:boolean</recursive>
</deleteCommentRecursive>

getComment

Acquire a comment.

GET http://domain:port/clearspace_context/rpc/rest/commentService/comments/{objectType}/{objectID}/{commentID}

Parameters

objectType: The object type of the parent.

objectID: The object id of the parent.

commentID: The id of the comment.

Parameters Template

<getComment> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <commentID>xs:long</commentID>
</getComment>

Return Value Template

<getCommentResponse> 
    <return>
        <!-- Contents of Comment -->
    <return>
</getCommentResponse>

getCommentCount

Returns the number of comments in the object.

GET http://domain:port/clearspace_context/rpc/rest/commentService/commentcount/{objectType}/{objectID}

Parameters

objectType: The type of object to acquire comment count for.

objectID: The id of the manager.

Parameters Template

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

Return Value Template

<getCommentCountResponse> 
    <return>xs:int</return>
</getCommentCountResponse>

getCommentCountWithFilter

Returns the number of comments in the object based on the specified ResultFilter. This is useful for determining such things as the number of comments in a date range, etc.

POST http://domain:port/clearspace_context/rpc/rest/commentService/comments/count

Parameters

objectType: The object type.

objectID: The id of the object.

filter: a filter to limit the query on.

Parameters Template

<getCommentCountWithFilter> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <filter>
        <!-- Contents of CommentResultFilter -->
    <filter>
</getCommentCountWithFilter>

Return Value Template

<getCommentCountWithFilterResponse> 
    <return>xs:int</return>
</getCommentCountWithFilterResponse>

getComments

Returns an array of all the comments in the object.

GET http://domain:port/clearspace_context/rpc/rest/commentService/comments/{objectType}/{objectID}

Parameters

objectType: The object type of the parent.

objectID: The object id of the parent.

Parameters Template

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

Return Value Template

<getCommentsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Comment -->
    <return>
</getCommentsResponse>

getUserContentCommentCount

Returns a count of all the comments in all content which has been authored by the supplied user.

GET http://domain:port/clearspace_context/rpc/rest/commentService/usercommentcount/{userID}

Parameters

userID: the id of the user whose content will be searched for comments.

Parameters Template

<getUserContentCommentCount> 
    <userID>xs:long</userID>
</getUserContentCommentCount>

Return Value Template

<getUserContentCommentCountResponse> 
    <return>xs:int</return>
</getUserContentCommentCountResponse>

getUserContentCommentCountWithFilter

Returns a count of all the comments in all content which has been authored by the supplied user.

POST http://domain:port/clearspace_context/rpc/rest/commentService/comments/user/count

Parameters

userID: the id of the user whose content will be searched for comments.

filter: The filter to apply to the results

Parameters Template

<getUserContentCommentCountWithFilter> 
    <userID>xs:long</userID>
    <filter>
        <!-- Contents of UserContentCommentResultFilter -->
    <filter>
</getUserContentCommentCountWithFilter>

Return Value Template

<getUserContentCommentCountWithFilterResponse> 
    <return>xs:int</return>
</getUserContentCommentCountWithFilterResponse>

getUserContentComments

Returns array of all the comments in all content which has been authored by the supplied user.

GET http://domain:port/clearspace_context/rpc/rest/commentService/usercomments/{userID}

Parameters

userID: the User whose content will be searched for comments.

Parameters Template

<getUserContentComments> 
    <userID>xs:long</userID>
</getUserContentComments>

Return Value Template

<getUserContentCommentsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Comment -->
    <return>
</getUserContentCommentsResponse>

getUserContentCommentsWithFilter

Returns array of all the comments in all content which has been authored by the supplied user.

POST http://domain:port/clearspace_context/rpc/rest/commentService/comments/user

Parameters

userID: the User whose content will be searched for comments.

filter: The filter to apply to the results

Parameters Template

<getUserContentCommentsWithFilter> 
    <userID>xs:long</userID>
    <filter>
        <!-- Contents of UserContentCommentResultFilter -->
    <filter>
</getUserContentCommentsWithFilter>

Return Value Template

<getUserContentCommentsWithFilterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Comment -->
    <return>
</getUserContentCommentsWithFilterResponse>

updateComment

Updates an existing comment.

PUT http://domain:port/clearspace_context/rpc/rest/commentService/comments

Parameters

objectType: The object type of the parent object.

objectID: The object id of the parent object.

comment: the comment to update.

Parameters Template

<updateComment> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <comment>
        <!-- Contents of Comment -->
    <comment>
</updateComment>

communityService

Provides the ability to manipulate communities. This service will allow you to create, delete, move and acquire communities.

Method	Description
createCommunity	Creates a new Community as a sub-community off of the specified community.
deleteCommunity	Used to delete the specified community
deleteProperty	Delete a property with the given name from the community with the given id.
getCommunity	Returns a by its id
getDocumentIDs	Returns document IDs for all the published documents in the community.
getProperties	Returns all tbe extended properties for the community with the specified id.
getProperty	Returns a specific extended property for the community with the specified property name and community ID.

REST Web Services Reference

Version 2.5.5 - Released 12/15/2008

Reading This Reference

Example

Web Services

addressBookService

addUser

Parameters

Parameters Template

addUsers

Parameters

Parameters Template

getRoster

Parameters

Parameters Template

Return Value Template

removeUser

Parameters

Parameters Template

removeUsers

Parameters

Parameters Template

attachmentService

addAllowedType

Parameters

Parameters Template

addDisallowedType

Parameters

Parameters Template

getAllowedTypes

Return Value Template

getDisallowedTypes

Return Value Template

getImagePreviewMaxSize

Return Value Template

getMaxAttachmentSize

Return Value Template

getMaxAttachmentsPerBlogPost

Return Value Template

getMaxAttachmentsPerDocument

Return Value Template

getMaxAttachmentsPerMessage

Return Value Template

isAllowAllByDefault

Return Value Template

isAttachmentsEnabled

Return Value Template

isImagePreviewEnabled

Return Value Template

isImagePreviewRatioEnabled

Return Value Template

isValidType

Parameters

Parameters Template

Return Value Template

removeAllowedType

Parameters

Parameters Template

removeDisallowedType

Parameters

Parameters Template

setAllowAllByDefault

Parameters

Parameters Template

setAttachmentsEnabled

Parameters

Parameters Template

setImagePreviewEnabled

Parameters

Parameters Template

setImagePreviewMaxSize

Parameters

Parameters Template

setImagePreviewRatioEnabled

Parameters

Parameters Template

setMaxAttachmentSize

Parameters

Parameters Template

setMaxAttachmentsPerBlogPost