REST Web Services Reference

Version 2.0.10 - Released 11/17/2008

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.
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.
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}

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  -->
    <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
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
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>

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>

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.
getRecursiveCommunities
getRecursiveCommunities	Returns all of the communities under the specified community recursively.
getRecursiveCommunityCount	Returns a count of call the communities under a community
getSubCommunities	Returns all the sub communities for the parent community.
setProperty	Set an extended propery for the community with the given community id.
updateCommunity	Update a Community

createCommunity

Creates a new Community as a sub-community off of the specified community.

POST http://domain:port/clearspace_context/rpc/rest/communityService/communities

Parameters

name: the name of the new community.

displayName: the display name of the new community.

description: the description of the new community.

communityID: Community to use as the parent

Parameters Template

<createCommunity> 
    <name>xs:string</name>
    <displayName>xs:string</displayName>
    <description>xs:string</description>
    <communityID>xs:long</communityID>
</createCommunity>

Return Value Template

<createCommunityResponse> 
    <return>
        <!-- Contents of Community -->
    <return>
</createCommunityResponse>

deleteCommunity

Used to delete the specified community

DELETE http://domain:port/clearspace_context/rpc/rest/communityService/communities/{communityID}

Parameters

communityID: the id of the community to delete

Parameters Template

<deleteCommunity> 
    <communityID>xs:long</communityID>
</deleteCommunity>

deleteProperty

Delete a property with the given name from the community with the given id.

DELETE http://domain:port/clearspace_context/rpc/rest/communityService/properties/{communityID}/{name}

Parameters

name: the name of the property to delete.

communityID: id of the community to delete the property from.

Parameters Template

<deleteProperty> 
    <name>xs:string</name>
    <communityID>xs:long</communityID>
</deleteProperty>

getCommunity

Returns a by its id

GET http://domain:port/clearspace_context/rpc/rest/communityService/communities/{communityID}

Parameters

communityID: id of the community

Parameters Template

<getCommunity> 
    <communityID>xs:long</communityID>
</getCommunity>

Return Value Template

<getCommunityResponse> 
    <return>
        <!-- Contents of Community -->
    <return>
</getCommunityResponse>

getDocumentIDs

Returns document IDs for all the published documents in the community. Does not traverse the subcommunities.

GET http://domain:port/clearspace_context/rpc/rest/communityService/documentIDs/{communityID}

Parameters

communityID: The id of the community.

Parameters Template

<getDocumentIDs> 
    <communityID>xs:long</communityID>
</getDocumentIDs>

Return Value Template

<getDocumentIDsResponse> 
    <!-- List of ... -->
    <return>Long</return>
</getDocumentIDsResponse>

getProperties

Returns all tbe extended properties for the community with the specified id.

GET http://domain:port/clearspace_context/rpc/rest/communityService/properties/{communityID}

Parameters

communityID: id of the community to retrieve properties for.

Parameters Template

<getProperties> 
    <communityID>xs:long</communityID>
</getProperties>

Return Value Template

<getPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getPropertiesResponse>

getProperty

Returns a specific extended property for the community with the specified property name and community ID.

GET http://domain:port/clearspace_context/rpc/rest/communityService/properties/{communityID}/{name}

Parameters

name: The name of the property.

communityID: The ID of the community to get the extended property for.

Parameters Template

<getProperty> 
    <name>xs:string</name>
    <communityID>xs:long</communityID>
</getProperty>

Return Value Template

<getPropertyResponse> 
    <return>xs:string</return>
</getPropertyResponse>

getRecursiveCommunities

Returns all of the communities under the specified community recursively.

GET http://domain:port/clearspace_context/rpc/rest/communityService/recursiveCommunities/{communityID}

Parameters

communityID: The id of the community.

Parameters Template

<getRecursiveCommunities> 
    <communityID>xs:long</communityID>
</getRecursiveCommunities>

Return Value Template

<getRecursiveCommunitiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Community -->
    <return>
</getRecursiveCommunitiesResponse>

getRecursiveCommunities

GET http://domain:port/clearspace_context/rpc/rest/communityService/communities

Return Value Template

<getRecursiveCommunitiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Community -->
    <return>
</getRecursiveCommunitiesResponse>

getRecursiveCommunityCount

Returns a count of call the communities under a community

GET http://domain:port/clearspace_context/rpc/rest/communityService/recursiveCount/{communityID}

Parameters

communityID: The id of the community.

Parameters Template

<getRecursiveCommunityCount> 
    <communityID>xs:long</communityID>
</getRecursiveCommunityCount>

Return Value Template

<getRecursiveCommunityCountResponse> 
    <return>xs:int</return>
</getRecursiveCommunityCountResponse>

getSubCommunities

Returns all the sub communities for the parent community.

GET http://domain:port/clearspace_context/rpc/rest/communityService/subCommunities/{communityID}

Parameters

communityID: The id of the parent community.

Parameters Template

<getSubCommunities> 
    <communityID>xs:long</communityID>
</getSubCommunities>

Return Value Template

<getSubCommunitiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Community -->
    <return>
</getSubCommunitiesResponse>

setProperty

Set an extended propery for the community with the given community id.

POST http://domain:port/clearspace_context/rpc/rest/communityService/properties

Parameters

name: The name of the property.

value: The value of the property.

communityID: The ID of the community to set an extended property for.

Parameters Template

<setProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <communityID>xs:long</communityID>
</setProperty>

updateCommunity

Update a Community

PUT http://domain:port/clearspace_context/rpc/rest/communityService/communities

Parameters

community: the community to update

Parameters Template

<updateCommunity> 
    <community>
        <!-- Contents of Community -->
    <community>
</updateCommunity>

documentService

This service provides methods to load and manipulate documents, comments.

Method	Description
addAttachmentToDocumentByDocumentID	Add a new attachment to the document with the specified id.
addAttachmentToDocumentByInternalDocID	Add a new attachment to the document with the specified internal id.
addAuthor	Adds the user with the supplied id as an author of this document of the specified document.
addDocumentApproverOnCommunity	Add the user as a document approver for this entire community.
addDocumentApproverOnDocument	Adds a user as a document approver for this document.
addImageToDocumentByDocumentID	Add a new image to the document with the specified id.
addImageToDocumentByInternalDocID	Add a new image to the document with the specified internal id.
createBinaryDocument	Creates a new binary document.
createDocument	Create a new document.
deleteDocument	Deletes a document.
deleteDocumentProperty	Delete a property with the given name from the document with the given ID.
getApprovalStatusForDocument	Returns a collection of objects.
getAttachmentCountByDocumentID	Returns the number of attachments on the document with the specified id.
getAttachmentCountByInternalDocID	Returns the number of attachments on the document with the specified internal id.
getAttachmentsByDocumentID	Acquire the attachments for a document by the document id.
getAttachmentsByInternalDocID	Acquire the attachments for a document by the internal document id.
getAuthors	Returns the userss who are allowed to edit the document.
getBinaryDocumentContent	Returns the content of the binary document.
getDocumentApproversOnCommunity	Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.
getDocumentApproversOnDocument	Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.
getDocumentByDocumentID	Returns a document from the community based on its document ID.
getDocumentByDocumentIDAndVersion	Returns the revision of the document with the specified docID and version number.
getDocumentByInternalDocID	Returns the document with the specified docID.
getDocumentByInternalDocIDAndVersion	Returns the revision of document with the specified docID and version number.
getDocumentProperties	Returns all tbe extended properties for the message with the specified ID.
getDocumentProperty	Returns a specific extended property for the document with the specified property name and document ID.
getDocumentsByCommunity	Returns all of the documents for the specified community.
getImageCountByDocumentID	Returns the number of images on the document with the specified id.
getImageCountByInternalDocID	Returns the number of images on the document with the specified internal id.
getPopularDocuments	Returns the top x documents across all communities according to ratings, document views and time passed since the document was created.
getPopularDocumentsByLanguage	Returns the top x documents across all communities according to ratings, document views and time passed since the document was created in the languages specified.
getUserApprovalDocuments	Returns a list of documents that a user needs to approve.
isCommentsEnabled	Returns true if the comments feature is turned on.
isTrackbacksEnabled	Returns true if the trackbacks feature is turned on.
moveDocument	Moves a document from it's current community to another.
publishDocument	Publish a new document.
removeAuthor	Removes the user with the supplied id as an author of this document.
setCommentsEnabled	Enables or disables the comments feature system wide.
setDocumentProperty	Set an extended for the property with the given document id.
setTrackbacksEnabled	Enables or disables the trackbacks feature system wide.
updateDocument

addAttachmentToDocumentByDocumentID

Add a new attachment to the document with the specified id.

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

Parameters

documentID: The id of the document.

name: The name of the file that is being added as an attachment.

contentType: The mime type of the file.

source: The file content.

Parameters Template

<addAttachmentToDocumentByDocumentID> 
    <documentID>xs:string</documentID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addAttachmentToDocumentByDocumentID>

addAttachmentToDocumentByInternalDocID

Add a new attachment to the document with the specified internal id.

POST http://domain:port/clearspace_context/rpc/rest/documentService/attachmentsByInternalDocID

Parameters

internalDocID: The id of the document.

name: The name of the file that is being added as an attachment.

contentType: The mime type of the file.

source: The file content.

Parameters Template

<addAttachmentToDocumentByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addAttachmentToDocumentByInternalDocID>

addAuthor

Adds the user with the supplied id as an author of this document of the specified document. Once any users have been added, the document is no longer available for editing by just anyone with the appropriate permissions.

POST http://domain:port/clearspace_context/rpc/rest/documentService/authors

Parameters

documentID: the id of the user to add as an author.

userID: the document to add a user too.

Parameters Template

<addAuthor> 
    <documentID>xs:long</documentID>
    <userID>xs:long</userID>
</addAuthor>

addDocumentApproverOnCommunity

Add the user as a document approver for this entire community.

This user will be required to approve all document edits for all documents in this community that have document approval enabled.

POST http://domain:port/clearspace_context/rpc/rest/documentService/approval/communityUsers

Parameters

communityID: The id of the community.

userID: The id of the user to add as a document approver.

Parameters Template

<addDocumentApproverOnCommunity> 
    <communityID>xs:long</communityID>
    <userID>xs:long</userID>
</addDocumentApproverOnCommunity>

addDocumentApproverOnDocument

Adds a user as a document approver for this document. If document approval is enabled for this document this user will have to approve this document to before it will be changed to a PUBLISHED status when it is edited.

POST http://domain:port/clearspace_context/rpc/rest/documentService/approval/users

Parameters

documentID: The id of the document.

userID: The user to add as a document approver

Parameters Template

<addDocumentApproverOnDocument> 
    <documentID>xs:long</documentID>
    <userID>xs:long</userID>
</addDocumentApproverOnDocument>

addImageToDocumentByDocumentID

Add a new image to the document with the specified id.

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

Parameters

documentID: The id of the document.

name: The name of the image that is being added.

contentType: The mime type of the image.

source: The image content.

Parameters Template

<addImageToDocumentByDocumentID> 
    <documentID>xs:string</documentID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addImageToDocumentByDocumentID>

addImageToDocumentByInternalDocID

Add a new image to the document with the specified internal id.

POST http://domain:port/clearspace_context/rpc/rest/documentService/imagesByInternalDocID

Parameters

internalDocID: The internal id of the document.

name: The name of the image that is being added.

conentType: The mime type of the image.

source: The image content.

Parameters Template

<addImageToDocumentByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
    <name>xs:string</name>
    <conentType>xs:string</conentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addImageToDocumentByInternalDocID>

createBinaryDocument

Creates a new binary document.

If a documentID is not provided (i.e. it's null) one will be automatically created. By default the autogenerated ID will be 'tempDOC-#' however the 'tempDOC-#' prefix can be controlled by changing the 'jive.temporaryDocPrefix' jive property.

POST http://domain:port/clearspace_context/rpc/rest/documentService/binaryDocument

Parameters

communityID: The id of the community to create the document in.

userID: The id of the author of the new document

: the id of the document type of the new document

: the document ID of the new document

: The title of the document

: The name of the file.

: The file's mime content type.

: @throws java.io.IOException Thrown if there is problems reading the datasouce

Parameters Template

<createBinaryDocument> 
    <communityID>xs:long</communityID>
    <userID>xs:long</userID>
    <>xs:long</>
    <>xs:string</>
    <>xs:string</>
    <>xs:string</>
    <>xs:string</>
    <!-- List of ... -->
    <>xs:base64Binary</>
</createBinaryDocument>

Return Value Template

<createBinaryDocumentResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</createBinaryDocumentResponse>

createDocument

Create a new document.

If a documentID is not provided (i.e. it's null, or empty string) one will be automatically created. By default the autogenerated ID will be 'tempDOC-#' however the 'tempDOC-#' prefix can be controlled by changing the 'jive.temporaryDocPrefix' jive property.

POST http://domain:port/clearspace_context/rpc/rest/documentService/documents

Parameters

communityID: The id of the community to create the document.

userID: The id of the author of the new document

documentTypeID: the id of the document type of the new document

documentID: the document ID of the new document

title: the title of the new document

body: the body of the new document @return the new document

Parameters Template

<createDocument> 
    <communityID>xs:long</communityID>
    <userID>xs:long</userID>
    <documentTypeID>xs:long</documentTypeID>
    <documentID>xs:string</documentID>
    <title>xs:string</title>
    <body>xs:string</body>
</createDocument>

Return Value Template

<createDocumentResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</createDocumentResponse>

deleteDocument

Deletes a document. Once a document is deleted, the document object should no longer be used. The search index and other resources that referenced the document and its comments will also be updated appropriately.

Note that since documents are versioned you may want to just delete or archive the specific version of the document instead of deleting the document which will delete all versions of the document. If this is the case see

DELETE http://domain:port/clearspace_context/rpc/rest/documentService/{documentID}

Parameters

documentID: the id of the document to delete.

Parameters Template

<deleteDocument> 
    <documentID>xs:long</documentID>
</deleteDocument>

deleteDocumentProperty

Delete a property with the given name from the document with the given ID.

DELETE http://domain:port/clearspace_context/rpc/rest/documentService/properties/{documentID}/{name}

Parameters

name: The name of the property to delete.

documentID: The ID of the message to delete the property from.

Parameters Template

<deleteDocumentProperty> 
    <name>xs:string</name>
    <documentID>xs:long</documentID>
</deleteDocumentProperty>

getApprovalStatusForDocument

Returns a collection of objects. The objects contain show which user has approved the Document and which hasn't.

GET http://domain:port/clearspace_context/rpc/rest/documentService/approval/status/{documentID}

Parameters

documentID: Thrown if the specified document does not exist.

Parameters Template

<getApprovalStatusForDocument> 
    <documentID>xs:long</documentID>
</getApprovalStatusForDocument>

Return Value Template

<getApprovalStatusForDocumentResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ApprovalStatus -->
    <return>
</getApprovalStatusForDocumentResponse>

getAttachmentCountByDocumentID

Returns the number of attachments on the document with the specified id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/attachmentCount/{documentID}

Parameters

documentID: The id of the document.

Parameters Template

<getAttachmentCountByDocumentID> 
    <documentID>xs:string</documentID>
</getAttachmentCountByDocumentID>

Return Value Template

<getAttachmentCountByDocumentIDResponse> 
    <return>xs:int</return>
</getAttachmentCountByDocumentIDResponse>

getAttachmentCountByInternalDocID

Returns the number of attachments on the document with the specified internal id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/attachmentCountByInternalDocID/{internalDocID}

Parameters

internalDocID: The id of the document.

Parameters Template

<getAttachmentCountByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
</getAttachmentCountByInternalDocID>

Return Value Template

<getAttachmentCountByInternalDocIDResponse> 
    <return>xs:int</return>
</getAttachmentCountByInternalDocIDResponse>

getAttachmentsByDocumentID

Acquire the attachments for a document by the document id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/attachments/{documentID}

Parameters

documentID: The id of the document.

Parameters Template

<getAttachmentsByDocumentID> 
    <documentID>xs:string</documentID>
</getAttachmentsByDocumentID>

Return Value Template

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

getAttachmentsByInternalDocID

Acquire the attachments for a document by the internal document id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/attachementsByInternalDocID/{internalDocID}

Parameters

internalDocID: The internal id of the document.

Parameters Template

<getAttachmentsByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
</getAttachmentsByInternalDocID>

Return Value Template

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

getAuthors

Returns the userss who are allowed to edit the document. If no users are specifically allowed to edit, then anyone with appropriate permissions can do so.

GET http://domain:port/clearspace_context/rpc/rest/documentService/authors/{documentID}

Parameters

documentID: Thrown if the specified document does not exist.

Parameters Template

<getAuthors> 
    <documentID>xs:long</documentID>
</getAuthors>

Return Value Template

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

getBinaryDocumentContent

Returns the content of the binary document.

GET http://domain:port/clearspace_context/rpc/rest/documentService/binaryDocument/{documentID}

Return Value Template

<getBinaryDocumentContentResponse> 
    <return>
        <!-- Contents of BinaryBody -->
    <return>
</getBinaryDocumentContentResponse>

getDocumentApproversOnCommunity

Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.

GET http://domain:port/clearspace_context/rpc/rest/documentService/approval/communityUsers/{communityID}

Parameters

communityID: The id of the community.

Parameters Template

<getDocumentApproversOnCommunity> 
    <communityID>xs:long</communityID>
</getDocumentApproversOnCommunity>

Return Value Template

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

getDocumentApproversOnDocument

Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.

GET http://domain:port/clearspace_context/rpc/rest/documentService/approval/users/{documentID}

Parameters

documentID: The id of the document.

Parameters Template

<getDocumentApproversOnDocument> 
    <documentID>xs:long</documentID>
</getDocumentApproversOnDocument>

Return Value Template

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

getDocumentByDocumentID

Returns a document from the community based on its document ID.

GET http://domain:port/clearspace_context/rpc/rest/documentService/documents/{documentID}

Parameters

documentID: the document ID of the document to retrieve.

Parameters Template

<getDocumentByDocumentID> 
    <documentID>xs:string</documentID>
</getDocumentByDocumentID>

Return Value Template

<getDocumentByDocumentIDResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</getDocumentByDocumentIDResponse>

getDocumentByDocumentIDAndVersion

Returns the revision of the document with the specified docID and version number.

GET http://domain:port/clearspace_context/rpc/rest/documentService/documents/{documentID}/{version}

Parameters

documentID: the document ID of the document to retrieve.

version: the version number of the document.

Parameters Template

<getDocumentByDocumentIDAndVersion> 
    <documentID>xs:string</documentID>
    <version>xs:int</version>
</getDocumentByDocumentIDAndVersion>

Return Value Template

<getDocumentByDocumentIDAndVersionResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</getDocumentByDocumentIDAndVersionResponse>

getDocumentByInternalDocID

Returns the document with the specified docID. It's a good idea to only display the string version of ID's to users so most often this method will be used only internally to the API.

GET http://domain:port/clearspace_context/rpc/rest/documentService/documentsByInternalDocID/{internalDocID}

Parameters

internalDocID: the long doc ID of the document

Parameters Template

<getDocumentByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
</getDocumentByInternalDocID>

Return Value Template

<getDocumentByInternalDocIDResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</getDocumentByInternalDocIDResponse>

getDocumentByInternalDocIDAndVersion

Returns the revision of document with the specified docID and version number. It's a good idea to only display the string version of ID's to users so most often this method will be used only internally to the API.

GET http://domain:port/clearspace_context/rpc/rest/documentService/documentsByInternalDocID/{internalDocID}/{version}

Parameters

internalDocID: the long doc ID of the document

version: the version number of the document

Parameters Template

<getDocumentByInternalDocIDAndVersion> 
    <internalDocID>xs:long</internalDocID>
    <version>xs:int</version>
</getDocumentByInternalDocIDAndVersion>

Return Value Template

<getDocumentByInternalDocIDAndVersionResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</getDocumentByInternalDocIDAndVersionResponse>

getDocumentProperties

Returns all tbe extended properties for the message with the specified ID.

GET http://domain:port/clearspace_context/rpc/rest/documentService/properties/{documentID}

Parameters

documentID: The ID of the document to retrieve properties for.

Parameters Template

<getDocumentProperties> 
    <documentID>xs:long</documentID>
</getDocumentProperties>

Return Value Template

<getDocumentPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getDocumentPropertiesResponse>

getDocumentProperty

Returns a specific extended property for the document with the specified property name and document ID.

GET http://domain:port/clearspace_context/rpc/rest/documentService/properties/{documentID}/{name}

Parameters

name: The name of the property.

documentID: The ID of the document to retrieve the property for.

Parameters Template

<getDocumentProperty> 
    <name>xs:string</name>
    <documentID>xs:long</documentID>
</getDocumentProperty>

Return Value Template

<getDocumentPropertyResponse> 
    <return>xs:string</return>
</getDocumentPropertyResponse>

getDocumentsByCommunity

Returns all of the documents for the specified community.

GET http://domain:port/clearspace_context/rpc/rest/documentService/documentsByCommunity/{communityID}

Parameters

communityID: The id of the community.

Parameters Template

<getDocumentsByCommunity> 
    <communityID>xs:long</communityID>
</getDocumentsByCommunity>

Return Value Template

<getDocumentsByCommunityResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Document -->
    <return>
</getDocumentsByCommunityResponse>

getImageCountByDocumentID

Returns the number of images on the document with the specified id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/imageCount/{documentID}

Parameters

documentID: The id of the document.

Parameters Template

<getImageCountByDocumentID> 
    <documentID>xs:string</documentID>
</getImageCountByDocumentID>

Return Value Template

<getImageCountByDocumentIDResponse> 
    <return>xs:int</return>
</getImageCountByDocumentIDResponse>

getImageCountByInternalDocID

Returns the number of images on the document with the specified internal id.

GET http://domain:port/clearspace_context/rpc/rest/documentService/imageCountByInternalDocID/{internalDocID}

Parameters

internalDocID: The id of the document.

Parameters Template

<getImageCountByInternalDocID> 
    <internalDocID>xs:long</internalDocID>
</getImageCountByInternalDocID>

Return Value Template

<getImageCountByInternalDocIDResponse> 
    <return>xs:int</return>
</getImageCountByInternalDocIDResponse>

getPopularDocuments

Returns the top x documents across all communities according to ratings, document views and time passed since the document was created. The algorithm is as follows:

Top x of ((document views) * (document mean rating+2)) * 1/(1 + number of days since creation date)

The number of documents to return is determined by the property "popularDocuments.number", defaulting to 5 if the property is not specified. Popular documents are only calculated once every 15 minutes.

GET http://domain:port/clearspace_context/rpc/rest/documentService/popularDocuments

Return Value Template

<getPopularDocumentsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Document -->
    <return>
</getPopularDocumentsResponse>

getPopularDocumentsByLanguage

Returns the top x documents across all communities according to ratings, document views and time passed since the document was created in the languages specified. The algorithm is as follows:

Top x of ((document views) * (document mean rating+2)) * 1/(1 + number of days since creation date)

GET http://domain:port/clearspace_context/rpc/rest/documentService/documentsByLanguage/{languages}

Parameters

languages: a list of ISO-639 language codes to restrict returned documents to.

Parameters Template

<getPopularDocumentsByLanguage> 
    <!-- List of ... -->
    <languages>xs:string</languages>
</getPopularDocumentsByLanguage>

Return Value Template

<getPopularDocumentsByLanguageResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Document -->
    <return>
</getPopularDocumentsByLanguageResponse>

getUserApprovalDocuments

Returns a list of documents that a user needs to approve.

GET http://domain:port/clearspace_context/rpc/rest/documentService/approval/users/{userID}

Parameters

userID: The user to acquire the documents for.

Parameters Template

<getUserApprovalDocuments> 
    <userID>xs:long</userID>
</getUserApprovalDocuments>

Return Value Template

<getUserApprovalDocumentsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Document -->
    <return>
</getUserApprovalDocumentsResponse>

isCommentsEnabled

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

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

Return Value Template

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

isTrackbacksEnabled

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

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

Return Value Template

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

moveDocument

Moves a document from it's current community to another.

POST http://domain:port/clearspace_context/rpc/rest/documentService/moveDocument

Parameters

documentID: the id of the document to move.

communityID: the id of the community to move the document to.

Parameters Template

<moveDocument> 
    <documentID>xs:long</documentID>
    <communityID>xs:long</communityID>
</moveDocument>

publishDocument

Publish a new document. Unlike create, this document will go straight to the published state.

If a documentID is not provided (i.e. it's null or empty string) one will be automatically created. By default the autogenerated ID will be 'tempDOC-#' however the 'tempDOC-#' prefix can be controlled by changing the 'jive.temporaryDocPrefix' jive property.

PUT http://domain:port/clearspace_context/rpc/rest/documentService/publish

Parameters

communityID: The id of the community to create the document.

userID: The id of the author of the new document

documentTypeID: the id of the document type of the new document

documentID: the document ID of the new document

title: the title of the new document

body: the body of the new document @return the new document

Parameters Template

<publishDocument> 
    <communityID>xs:long</communityID>
    <userID>xs:long</userID>
    <documentTypeID>xs:long</documentTypeID>
    <documentID>xs:string</documentID>
    <title>xs:string</title>
    <body>xs:string</body>
</publishDocument>

Return Value Template

<publishDocumentResponse> 
    <return>
        <!-- Contents of Document -->
    <return>
</publishDocumentResponse>

removeAuthor

Removes the user with the supplied id as an author of this document.

DELETE http://domain:port/clearspace_context/rpc/rest/documentService/authors/{documentID}/{userID}

Parameters

documentID: The id of the document to remove the user as an author from.

userID: The id of the user to remove as a document author.

Parameters Template

<removeAuthor> 
    <documentID>xs:long</documentID>
    <userID>xs:long</userID>
</removeAuthor>

setCommentsEnabled

Enables or disables the comments feature system wide.

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

Parameters

enableComments: true to enableComments the comments feature, false to disable

Parameters Template

<setCommentsEnabled> 
    <enableComments>xs:boolean</enableComments>
</setCommentsEnabled>

setDocumentProperty

Set an extended for the property with the given document id.

POST http://domain:port/clearspace_context/rpc/rest/documentService/properties

Parameters

name: The name of the property.

value: The value of the property.

documentID: The ID of the document to set an extended property for.

Parameters Template

<setDocumentProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <documentID>xs:long</documentID>
</setDocumentProperty>

setTrackbacksEnabled

Enables or disables the trackbacks feature system wide.

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

Parameters

enableTrackbacks: true to enableTrackbacks the trackback feature, false to disable

Parameters Template

<setTrackbacksEnabled> 
    <enableTrackbacks>xs:boolean</enableTrackbacks>
</setTrackbacksEnabled>

updateDocument

PUT http://domain:port/clearspace_context/rpc/rest/documentService/documents

Parameters

document

Parameters Template

<updateDocument> 
    <document>
        <!-- Contents of Document -->
    <document>
</updateDocument>

forumService

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

Method	Description
addAttachmentToMessage	Adds an attachment to the message with the specified ID.
addImageToMessage	Adds an image to the message with the specified ID.
createMessage	Creates a new message on the given thread.
createReplyMessage	Creates a new message that is a direct response to a given message.
createThread	Creates a new thread.
deleteMessage	Delete the message with the following id.
deleteMessageAndChildren	Delete the message with the specified id.
deleteMessageProperty	Delete a property with the given name from the message with the given ID.
deleteThread	Deletes a thread with the specified ID.
deleteThreadProperty	Delete a property with the given name from the thread with the given ID.
getAttachmentsByMessageID	Returns an array of attachments that are attached to the specified message.
getChild	Returns the child of parent at index index in the parent's child array.
getChildCount	Returns the number of children of parent.
getChildren	Returns an array of all the child messages of the parent.
getForumMessage	Returns a by its ID.
getForumThread	Returns a by its ID.
getImagesByMessageID	Returns an array of images that are attached to the specified message.
getIndexOfChild	Returns the index of child in parent.
getMessageCountByCommunityID	Returns the number of messages that are in the community.
getMessageCountByCommunityIDAndFilter	Returns the number of messages that are in the community with the specified id after the specified filter has been applied.
getMessageCountByThreadID	Returns the number of messages that are in the thread.
getMessageCountByThreadIDAndFilter	Returns the number of messages that are in the thread with the specified id after the specified filter has been applied.
getMessageCountsByCommunityIDAndFilter	Returns the number of messages that are in the community with the specified id after the specified filter has been applied.
getMessageDepth	Returns the depth of a message in the message tree hierarchy.
getMessageIDsByCommunityID	Returns all of the message IDs for all of the message that are in the community.
getMessageIDsByCommunityIDAndFilter	Returns all of the message IDs for all of the message that are in the community with the specified ID, filtered by the the specified result filter.
getMessageIDsByThreadID	Returns the IDs of the messages that are in the thread.
getMessageIDsByThreadIDAndFilter	Returns all of the message IDs for all of the message that are in the thread after the specified filter has been applied.
getMessageProperties	Returns all tbe extended properties for the message with the specified ID.
getMessageProperty	Returns a specific extended property for the message with the specified property name and message ID.
getMessagesByCommunityID	Returns all of the messages that are in the community.
getMessagesByCommunityIDAndFilter	Returns all of the messages that are in the community with the specified ID, filtered by the the specified result filter.
getMessagesByThreadID	Returns the messages that are in the thread.
getMessagesByThreadIDAndFilter	Returns all of the messages that are in the thread after the specified filter has been applied.
getParent	Returns the parent of the <code>child</code> ForumMessage.
getPopularThreads	Returns an array of thread IDs for all the popular threads in the system.
getPopularThreadsByCommunityID	Return an array of popular threads by community.
getRecursiveChildCount	Returns the total number of recursive children of a parent.
getRecursiveChildren	Returns an array for all child messages (and sub-children, etc) of the parent.
getRecursiveMessages	Returns an array for all messages in the thread in depth-first order.
getRootMessage	Returns the root of a thread.
getThreadCountByCommunityID	Returns the number of threads in the specified community.
getThreadCountByCommunityIDAndFilter	Returns the number of threads in the specified community after being filtered by the specified filter.
getThreadProperties	Returns all tbe extended properties for the thread with the specified ID.
getThreadProperty	Returns a specific extended property for the thread with the specified property name and thread ID.
getThreadsByCommunityID	Returns all of the IDs for threads a community.
getThreadsByCommunityIDAndFilter	Returns all of the IDs for threads a community has filtered by the specified result filter.
getUnfilteredMessageProperties	Returns the properties without applying filters to them first.
hasParent	Returns true if the <code>child</code> message has a parent message.
isLeaf	Returns true if node is a leaf.
moveThread	Moves the thread with the specified ID to the community with the specified ID.
setMessageProperty	Set an extended for the property with the given message id.
setThreadProperty	Set an extended for the property for the thread with the given ID.
updateForumMessage	Used to update the subject and body of a

addAttachmentToMessage

Adds an attachment to the message with the specified ID.

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

Parameters

messageID: The ID of the message.

name: The name of the attachment.

contentType: the content type of the attachment.

source: The content for the attachment.

Parameters Template

<addAttachmentToMessage> 
    <messageID>xs:long</messageID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addAttachmentToMessage>

addImageToMessage

Adds an image to the message with the specified ID.

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

Parameters

messsageID: The ID of the message.

name: The name of the image.

contentType: the content type of the image.

source: The content for the image.

Parameters Template

<addImageToMessage> 
    <messsageID>xs:long</messsageID>
    <name>xs:string</name>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <source>xs:base64Binary</source>
</addImageToMessage>

createMessage

Creates a new message on the given thread.

If userID is a value less than one then the message will be created for an anonymous user.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messages

Return Value Template

<createMessageResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</createMessageResponse>

createReplyMessage

Creates a new message that is a direct response to a given message.

If userID is a value less than one then the message will be created for an anonymous user.

POST http://domain:port/clearspace_context/rpc/rest/forumService/replyMessage

Return Value Template

<createReplyMessageResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</createReplyMessageResponse>

createThread

Creates a new thread.

POST http://domain:port/clearspace_context/rpc/rest/forumService/threads

Return Value Template

<createThreadResponse> 
    <return>
        <!-- Contents of ForumThread -->
    <return>
</createThreadResponse>

deleteMessage

Delete the message with the following id.

DELETE http://domain:port/clearspace_context/rpc/rest/forumService/messages/{messageID}

Parameters

messageID: the id of the message to delete.

Parameters Template

<deleteMessage> 
    <messageID>xs:long</messageID>
</deleteMessage>

deleteMessageAndChildren

Delete the message with the specified id. If the deleteChildren parameters is set to true all children of this message will be deleted.

DELETE http://domain:port/clearspace_context/rpc/rest/forumService/messages/{messageID}/{deleteChildren}

Parameters

messageID: The ID of the message to delete.

deleteChildren: Whether or not to delete the children of this message.

Parameters Template

<deleteMessageAndChildren> 
    <messageID>xs:long</messageID>
    <deleteChildren>xs:boolean</deleteChildren>
</deleteMessageAndChildren>

deleteMessageProperty

Delete a property with the given name from the message with the given ID.

DELETE http://domain:port/clearspace_context/rpc/rest/forumService/properties

Parameters

name: The name of the property to delete.

messageID: The ID of the message to delete the property from.

Parameters Template

<deleteMessageProperty> 
    <name>xs:string</name>
    <messageID>xs:long</messageID>
</deleteMessageProperty>

deleteThread

Deletes a thread with the specified ID.

DELETE http://domain:port/clearspace_context/rpc/rest/forumService/threads/{threadID}

Parameters

threadID: The ID of thread to delete.

Parameters Template

<deleteThread> 
    <threadID>xs:long</threadID>
</deleteThread>

deleteThreadProperty

Delete a property with the given name from the thread with the given ID.

DELETE http://domain:port/clearspace_context/rpc/rest/forumService/threadProperties/{threadID}/{name}

Parameters

name: The name of the property to delete.

threadID: The ID of the thread to delete the property from.

Parameters Template

<deleteThreadProperty> 
    <name>xs:string</name>
    <threadID>xs:long</threadID>
</deleteThreadProperty>

getAttachmentsByMessageID

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

GET http://domain:port/clearspace_context/rpc/rest/forumService/attachments/{messageID}

Parameters

messageID: The ID of the message to acquire attachments for.

Parameters Template

<getAttachmentsByMessageID> 
    <messageID>xs:long</messageID>
</getAttachmentsByMessageID>

Return Value Template

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

getChild

Returns the child of parent at index index in the parent's child array. The index must be a valid one, that is: index >= 0, and index < getChildCount(parent). If the index is not valid, or if the child could not be loaded for any other reason, a ForumMessageNotFoundException will be thrown.

GET http://domain:port/clearspace_context/rpc/rest/forumService/children/{messageID}/{index}

Parameters

messageID: The ID of the parent message.

index: the index of the child.

Parameters Template

<getChild> 
    <messageID>xs:long</messageID>
    <index>xs:int</index>
</getChild>

Return Value Template

<getChildResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getChildResponse>

getChildCount

Returns the number of children of parent. Returns 0 if the node is a leaf or if it has no children.

GET http://domain:port/clearspace_context/rpc/rest/forumService/childCount/{messageID}

Parameters

messageID: The ID the message.

Parameters Template

<getChildCount> 
    <messageID>xs:long</messageID>
</getChildCount>

Return Value Template

<getChildCountResponse> 
    <return>xs:int</return>
</getChildCountResponse>

getChildren

Returns an array of all the child messages of the parent. This method only considers direct descendants of the parent message and not sub-children. To get an array for the full hierarchy of children for a parent message, use the method.

GET http://domain:port/clearspace_context/rpc/rest/forumService/children/{mesageID}

Parameters

messageID: The parent message.

Parameters Template

<getChildren> 
    <messageID>xs:long</messageID>
</getChildren>

Return Value Template

<getChildrenResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getChildrenResponse>

getForumMessage

Returns a by its ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messages/{messageID}

Parameters

messageID: id of the message.

Parameters Template

<getForumMessage> 
    <messageID>xs:long</messageID>
</getForumMessage>

Return Value Template

<getForumMessageResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getForumMessageResponse>

getForumThread

Returns a by its ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/threads/{threadID}

Parameters

threadID: The ID of the thread.

Parameters Template

<getForumThread> 
    <threadID>xs:long</threadID>
</getForumThread>

Return Value Template

<getForumThreadResponse> 
    <return>
        <!-- Contents of ForumThread -->
    <return>
</getForumThreadResponse>

getImagesByMessageID

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

GET http://domain:port/clearspace_context/rpc/rest/forumService/images/{messageID}

Parameters

messageID: The ID of the message to acquire images for.

Parameters Template

<getImagesByMessageID> 
    <messageID>xs:long</messageID>
</getImagesByMessageID>

Return Value Template

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

getIndexOfChild

Returns the index of child in parent. This method does not deal with the indexes of sub-children of parents. For example, take the following tree:

            4
            |-- 2
            |-- |-- 1
            |-- |-- 6
            |-- |-- 8
            |-- 5

In this example, getIndexOfChild(4, 2) would return 0, getIndexOfChild(4, 5) would return 1, and getIndexOfChild(2, 8) would return 2. getIndexOfChild(4, 8) -- NOT VALID

GET http://domain:port/clearspace_context/rpc/rest/forumService/indexOfChild/{parentID}/{messageID}

Parameters

parentID: The ID of the parent message.

messageID: The ID of the child message to get the index for.

Parameters Template

<getIndexOfChild> 
    <parentID>xs:long</parentID>
    <messageID>xs:long</messageID>
</getIndexOfChild>

Return Value Template

<getIndexOfChildResponse> 
    <return>xs:int</return>
</getIndexOfChildResponse>

getMessageCountByCommunityID

Returns the number of messages that are in the community.

http://domain:port/clearspace_context/rpc/rest/forumService/messageCountByCommunityID/{communityID}

Parameters

communityID: The ID of the community to find the message count for.

Parameters Template

<getMessageCountByCommunityID> 
    <communityID>xs:long</communityID>
</getMessageCountByCommunityID>

Return Value Template

<getMessageCountByCommunityIDResponse> 
    <return>xs:int</return>
</getMessageCountByCommunityIDResponse>

getMessageCountByCommunityIDAndFilter

Returns the number of messages that are in the community with the specified id after the specified filter has been applied.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messageCountByCommunityID

Parameters

communityID: The ID of the community to find the message count for.

filter: The filter that can be applied to filter out results.

Parameters Template

<getMessageCountByCommunityIDAndFilter> 
    <communityID>xs:long</communityID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessageCountByCommunityIDAndFilter>

Return Value Template

<getMessageCountByCommunityIDAndFilterResponse> 
    <return>xs:int</return>
</getMessageCountByCommunityIDAndFilterResponse>

getMessageCountByThreadID

Returns the number of messages that are in the thread.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messageCountByThreadID/{threadID}

Parameters

threadID: The ID of the thread to find the message count for.

Parameters Template

<getMessageCountByThreadID> 
    <threadID>xs:long</threadID>
</getMessageCountByThreadID>

Return Value Template

<getMessageCountByThreadIDResponse> 
    <return>xs:int</return>
</getMessageCountByThreadIDResponse>

getMessageCountByThreadIDAndFilter

Returns the number of messages that are in the thread with the specified id after the specified filter has been applied.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messageCountByThreadID

Parameters

threadID: The ID of the thread to find the message count for.

filter: The filter that can be applied to filter out results.

Parameters Template

<getMessageCountByThreadIDAndFilter> 
    <threadID>xs:long</threadID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessageCountByThreadIDAndFilter>

Return Value Template

<getMessageCountByThreadIDAndFilterResponse> 
    <return>xs:int</return>
</getMessageCountByThreadIDAndFilterResponse>

getMessageCountsByCommunityIDAndFilter

Returns the number of messages that are in the community with the specified id after the specified filter has been applied.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messageCountsByCommunityID

Return Value Template

<getMessageCountsByCommunityIDAndFilterResponse> 
    <return>xs:int</return>
</getMessageCountsByCommunityIDAndFilterResponse>

getMessageDepth

Returns the depth of a message in the message tree hierarchy. The root message is always at depth 0. For example, consider the following message tree:

            1
            |-- 3
            |-- |-- 4
            |-- |-- |-- 7

The depth of message 4 is 2, the depth of message 7 is 3, etc. This method is useful in combination with the array to build a UI of hierarchical messages.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messageDepth/{messageID}

Parameters

messageID: The ID of the message to determine the depth of.

Parameters Template

<getMessageDepth> 
    <messageID>xs:long</messageID>
</getMessageDepth>

Return Value Template

<getMessageDepthResponse> 
    <return>xs:int</return>
</getMessageDepthResponse>

getMessageIDsByCommunityID

Returns all of the message IDs for all of the message that are in the community.

If the number of results exceeds than then message IDs up to will be returned.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messageIDsByCommunityID/{communityID}

Parameters

communityID: The ID of the community to find messages for.

Parameters Template

<getMessageIDsByCommunityID> 
    <communityID>xs:long</communityID>
</getMessageIDsByCommunityID>

Return Value Template

<getMessageIDsByCommunityIDResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</getMessageIDsByCommunityIDResponse>

getMessageIDsByCommunityIDAndFilter

Returns all of the message IDs for all of the message that are in the community with the specified ID, filtered by the the specified result filter.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messageIdsByCommunityID/{communityID}

Parameters

communityID: The id of the community to find messages for.

filter: Filter to be apply to the results.

Parameters Template

<getMessageIDsByCommunityIDAndFilter> 
    <communityID>xs:long</communityID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessageIDsByCommunityIDAndFilter>

Return Value Template

<getMessageIDsByCommunityIDAndFilterResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</getMessageIDsByCommunityIDAndFilterResponse>

getMessageIDsByThreadID

Returns the IDs of the messages that are in the thread.

If the number of results exceeds than then message IDs up to will be returned.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messageIDsByThreadID/{threadID}

Parameters

threadID: The ID of the thread to find message IDs for.

Parameters Template

<getMessageIDsByThreadID> 
    <threadID>xs:long</threadID>
</getMessageIDsByThreadID>

Return Value Template

<getMessageIDsByThreadIDResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</getMessageIDsByThreadIDResponse>

getMessageIDsByThreadIDAndFilter

Returns all of the message IDs for all of the message that are in the thread after the specified filter has been applied.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messageIDsByThreadID

Parameters

threadID: The ID of the thread to find messages for.

filter: The filter to apply to the results.

Parameters Template

<getMessageIDsByThreadIDAndFilter> 
    <threadID>xs:long</threadID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessageIDsByThreadIDAndFilter>

Return Value Template

<getMessageIDsByThreadIDAndFilterResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</getMessageIDsByThreadIDAndFilterResponse>

getMessageProperties

Returns all tbe extended properties for the message with the specified ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/properties/{messageID}

Parameters

messageID: The ID of the message to retrieve properties for.

Parameters Template

<getMessageProperties> 
    <messageID>xs:long</messageID>
</getMessageProperties>

Return Value Template

<getMessagePropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getMessagePropertiesResponse>

getMessageProperty

Returns a specific extended property for the message with the specified property name and message ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/properties/{messageID}/{name}

Parameters

name: The name of the property.

messageID: The ID of the message to retrieve the property for.

Parameters Template

<getMessageProperty> 
    <name>xs:string</name>
    <messageID>xs:long</messageID>
</getMessageProperty>

Return Value Template

<getMessagePropertyResponse> 
    <return>xs:string</return>
</getMessagePropertyResponse>

getMessagesByCommunityID

Returns all of the messages that are in the community.

If the number of results exceeds than then message IDs up to will be returned.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messagesByCommunityID/{communityID}

Parameters

communityID: The ID of the community to find messages for.

Parameters Template

<getMessagesByCommunityID> 
    <communityID>xs:long</communityID>
</getMessagesByCommunityID>

Return Value Template

<getMessagesByCommunityIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getMessagesByCommunityIDResponse>

getMessagesByCommunityIDAndFilter

Returns all of the messages that are in the community with the specified ID, filtered by the the specified result filter.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messagesByCommunityID

Parameters

communityID: The id of the community to find messages for.

filter: Filter to be apply to the results.

Parameters Template

<getMessagesByCommunityIDAndFilter> 
    <communityID>xs:long</communityID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessagesByCommunityIDAndFilter>

Return Value Template

<getMessagesByCommunityIDAndFilterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getMessagesByCommunityIDAndFilterResponse>

getMessagesByThreadID

Returns the messages that are in the thread.

If the number of results exceeds than then message IDs up to will be returned.

GET http://domain:port/clearspace_context/rpc/rest/forumService/messagesByThreadID/{threadID}

Parameters

threadID: The ID of the thread to find message IDs for.

Parameters Template

<getMessagesByThreadID> 
    <threadID>xs:long</threadID>
</getMessagesByThreadID>

Return Value Template

<getMessagesByThreadIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getMessagesByThreadIDResponse>

getMessagesByThreadIDAndFilter

Returns all of the messages that are in the thread after the specified filter has been applied.

POST http://domain:port/clearspace_context/rpc/rest/forumService/messagesByThreadID

Parameters

threadID: The ID of the thread to find messages for.

filter: The filter to apply to the results.

Parameters Template

<getMessagesByThreadIDAndFilter> 
    <threadID>xs:long</threadID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getMessagesByThreadIDAndFilter>

Return Value Template

<getMessagesByThreadIDAndFilterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getMessagesByThreadIDAndFilterResponse>

getParent

Returns the parent of the child ForumMessage.

GET http://domain:port/clearspace_context/rpc/rest/forumService/parentMessage/{messageID}

Parameters

messageID: The ID of the message to find the parent for.

Parameters Template

<getParent> 
    <messageID>xs:long</messageID>
</getParent>

Return Value Template

<getParentResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getParentResponse>

getPopularThreads

Returns an array of thread IDs for all the popular threads in the system.

GET http://domain:port/clearspace_context/rpc/rest/forumService/popularThreads

Return Value Template

<getPopularThreadsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumThread -->
    <return>
</getPopularThreadsResponse>

getPopularThreadsByCommunityID

Return an array of popular threads by community.

GET http://domain:port/clearspace_context/rpc/rest/forumService/popularThreadsByCommunityID/{communityID}

Parameters

communityID: The ID of the community to check the thread count for.

Parameters Template

<getPopularThreadsByCommunityID> 
    <communityID>xs:long</communityID>
</getPopularThreadsByCommunityID>

Return Value Template

<getPopularThreadsByCommunityIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumThread -->
    <return>
</getPopularThreadsByCommunityIDResponse>

getRecursiveChildCount

Returns the total number of recursive children of a parent. Returns 0 if there are no children. This method is not intended to aid in navigation of a Thread but is included as an added utility.

GET http://domain:port/clearspace_context/rpc/rest/forumService/recursiveChildCount/{messageID}

Parameters

messageID: The ID of the message.

Parameters Template

<getRecursiveChildCount> 
    <messageID>xs:long</messageID>
</getRecursiveChildCount>

Return Value Template

<getRecursiveChildCountResponse> 
    <return>xs:int</return>
</getRecursiveChildCountResponse>

getRecursiveChildren

Returns an array for all child messages (and sub-children, etc) of the parent. Messages will be returned depth-first. For example, consider the following message tree:

            1
            |-- 3
            |-- |-- 4
            |-- |-- |-- 7
            |-- |-- |-- |-- 10
            |-- |-- 6
            |-- |-- 8
            |-- 5

Calling getRecursiveChildren(3) on the tree above would return the sequence 4, 7, 10, 6, 8. This method is a powerful way to show all children of a message, especially in combination with the method.

GET http://domain:port/clearspace_context/rpc/rest/forumService/recursiveChildren/{messageID}

Parameters

messageID: The ID of the parent message.

Parameters Template

<getRecursiveChildren> 
    <messageID>xs:long</messageID>
</getRecursiveChildren>

Return Value Template

<getRecursiveChildrenResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getRecursiveChildrenResponse>

getRecursiveMessages

Returns an array for all messages in the thread in depth-first order. For example, consider the following message tree:

            1
            |-- 3
            |-- |-- 4
            |-- |-- |-- 7
            |-- |-- |-- |-- 10
            |-- |-- 6
            |-- |-- 8
            |-- 5

Calling getRecursiveMessages() on the tree above would return the sequence 1, 3, 4, 7, 10, 6, 8, 5. This method is a powerful way to show the full tree of messages, especially in combination with the method.

GET http://domain:port/clearspace_context/rpc/rest/forumService/recusiveMessages/{threadID}

Parameters

threadID: The ID of the thread.

Parameters Template

<getRecursiveMessages> 
    <threadID>xs:long</threadID>
</getRecursiveMessages>

Return Value Template

<getRecursiveMessagesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getRecursiveMessagesResponse>

getRootMessage

Returns the root of a thread. Returns null only if thread has no nodes.

GET http://domain:port/clearspace_context/rpc/rest/forumService/rootMessage/{threadID}

Parameters

threadID: The ID of the thread.

Parameters Template

<getRootMessage> 
    <threadID>xs:long</threadID>
</getRootMessage>

Return Value Template

<getRootMessageResponse> 
    <return>
        <!-- Contents of ForumMessage -->
    <return>
</getRootMessageResponse>

getThreadCountByCommunityID

Returns the number of threads in the specified community.

GET http://domain:port/clearspace_context/rpc/rest/forumService/threadCountByCommunityID/{communityID}

Parameters

communityID: The ID of the community to check the thread count for.

Parameters Template

<getThreadCountByCommunityID> 
    <communityID>xs:long</communityID>
</getThreadCountByCommunityID>

Return Value Template

<getThreadCountByCommunityIDResponse> 
    <return>xs:int</return>
</getThreadCountByCommunityIDResponse>

getThreadCountByCommunityIDAndFilter

Returns the number of threads in the specified community after being filtered by the specified filter.

POST http://domain:port/clearspace_context/rpc/rest/forumService/threadCountByCommunityID

Return Value Template

<getThreadCountByCommunityIDAndFilterResponse> 
    <return>xs:int</return>
</getThreadCountByCommunityIDAndFilterResponse>

getThreadProperties

Returns all tbe extended properties for the thread with the specified ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/threadProperties/{threadID}

Parameters

threadID: The ID of the thread to retrieve properties for.

Parameters Template

<getThreadProperties> 
    <threadID>xs:long</threadID>
</getThreadProperties>

Return Value Template

<getThreadPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getThreadPropertiesResponse>

getThreadProperty

Returns a specific extended property for the thread with the specified property name and thread ID.

GET http://domain:port/clearspace_context/rpc/rest/forumService/threadProperties/{threadID}/{name}

Parameters

name: The name of the property.

threadID: The ID of the thread to retrieve the property for.

Parameters Template

<getThreadProperty> 
    <name>xs:string</name>
    <threadID>xs:long</threadID>
</getThreadProperty>

Return Value Template

<getThreadPropertyResponse> 
    <return>xs:string</return>
</getThreadPropertyResponse>

getThreadsByCommunityID

Returns all of the IDs for threads a community. If the number of threads exceeds the threads up to will be returned.

GET http://domain:port/clearspace_context/rpc/rest/forumService/threadsByCommunityID/{communityID}

Parameters

communityID: The ID of the community to grab threds for.

Parameters Template

<getThreadsByCommunityID> 
    <communityID>xs:long</communityID>
</getThreadsByCommunityID>

Return Value Template

<getThreadsByCommunityIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumThread -->
    <return>
</getThreadsByCommunityIDResponse>

getThreadsByCommunityIDAndFilter

Returns all of the IDs for threads a community has filtered by the specified result filter.

POST http://domain:port/clearspace_context/rpc/rest/forumService/threadsByCommunityID

Parameters

communityID: The ID of the community to grab threds for.

filter: The filter to use against the result.

Parameters Template

<getThreadsByCommunityIDAndFilter> 
    <communityID>xs:long</communityID>
    <filter>
        <!-- Contents of ResultFilter -->
    <filter>
</getThreadsByCommunityIDAndFilter>

Return Value Template

<getThreadsByCommunityIDAndFilterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ForumThread -->
    <return>
</getThreadsByCommunityIDAndFilterResponse>

getUnfilteredMessageProperties

Returns the properties without applying filters to them first.

GET http://domain:port/clearspace_context/rpc/rest/forumService/unfilteredProperties/{messageID}

Parameters

messageID: The ID of the message to return unfiltered properties for.

Parameters Template

<getUnfilteredMessageProperties> 
    <messageID>xs:long</messageID>
</getUnfilteredMessageProperties>

Return Value Template

<getUnfilteredMessagePropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getUnfilteredMessagePropertiesResponse>

hasParent

Returns true if the child message has a parent message.

GET http://domain:port/clearspace_context/rpc/rest/forumService/hasParent/{messageID}

Parameters

messageID: the message.

Parameters Template

<hasParent> 
    <messageID>xs:long</messageID>
</hasParent>

Return Value Template

<hasParentResponse> 
    <return>xs:boolean</return>
</hasParentResponse>

isLeaf

Returns true if node is a leaf. A node is a leaf when it has no children messages.

GET http://domain:port/clearspace_context/rpc/rest/forumService/isLeaf/{messageID}

Parameters

messageID: A node in the thread, obtained from this data source.

Parameters Template

<isLeaf> 
    <messageID>xs:long</messageID>
</isLeaf>

Return Value Template

<isLeafResponse> 
    <return>xs:boolean</return>
</isLeafResponse>

moveThread

Moves the thread with the specified ID to the community with the specified ID.

PUT http://domain:port/clearspace_context/rpc/rest/forumService/moveThread

Parameters

threadID: The ID of the thread to move.

communityID: The ID of the community to move the thread to.

Parameters Template

<moveThread> 
    <threadID>xs:long</threadID>
    <communityID>xs:long</communityID>
</moveThread>

setMessageProperty

Set an extended for the property with the given message id.

POST http://domain:port/clearspace_context/rpc/rest/forumService/properties

Parameters

name: The name of the property.

value: The value of the property.

messageID: The ID of the message to set an extended property for.

Parameters Template

<setMessageProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <messageID>xs:long</messageID>
</setMessageProperty>

setThreadProperty

Set an extended for the property for the thread with the given ID.

POST http://domain:port/clearspace_context/rpc/rest/forumService/threadProperties

Parameters

name: The name of the property.

value: The value of the property.

threadID: The ID of the thread to set an extended property for.

Parameters Template

<setThreadProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <threadID>xs:long</threadID>
</setThreadProperty>

updateForumMessage

Used to update the subject and body of a

PUT http://domain:port/clearspace_context/rpc/rest/forumService/messages

groupService

Provides a the ability for managing groups and group membership.

Method	Description
addAdministratorToGroup	Make the user with the specified userID an administrator of the group with the specified groupID.
addMemberToGroup	Add the user with the specified userID to the group with the specified groupID.
createGroup	Creates a new group.
deleteGroup	Delete the group with the specified id.
deleteProperty	Deletes an extended property from the specfied group.
getAdministratorCount	Returns the count of how many administrators there are for the group with the specified ID.
getGroup	Returns a by its ID.
getGroupAdmins	Returns an array of all the user IDs that administer this group.
getGroupByName	Returns a by its name.
getGroupCount	Returns a count of all groups in the system.
getGroupMembers	Returns an array of all userIDs for all the members of a particular group.
getGroupNames	Returns an array of all the group names for all the groups in the system.
getGroupNamesBounded	Returns an array of the group names beginning at startIndex and until the number results equals numResults.
getGroups	Returns an array of all the group IDs for all the groups in the system.
getProperties	Returns an array of all the extended properties for a group.
getUserGroupNames	Returns an array of group names that an entity belongs to.
getUserGroups	Returns an array of all the group IDs that a user belongs too.
isReadOnly	Returns true if this GroupService is read-only.
removeAdministratorFromGroup	Remove the user with the specified ID as an administrator from the group with the specified ID.
removeMemberFromGroup	Remove the user with the specified id from the group with the specified id.
setProperty	Set a new extended property on the specified group.
updateGroup	Update the following group in the system.

addAdministratorToGroup

Make the user with the specified userID an administrator of the group with the specified groupID.

POST http://domain:port/clearspace_context/rpc/rest/groupService/groupAdmins

Parameters

userID: The ID of the user to add as a member to a group.

groupID: The ID of the group to make a user an administrator for.

Parameters Template

<addAdministratorToGroup> 
    <userID>xs:long</userID>
    <groupID>xs:long</groupID>
</addAdministratorToGroup>

addMemberToGroup

Add the user with the specified userID to the group with the specified groupID.

POST http://domain:port/clearspace_context/rpc/rest/groupService/groupMembers

Parameters

userID: The ID of the user to add to a group.

groupID: The ID of the group to add a user too.

Parameters Template

<addMemberToGroup> 
    <userID>xs:long</userID>
    <groupID>xs:long</groupID>
</addMemberToGroup>

createGroup

Creates a new group.

POST http://domain:port/clearspace_context/rpc/rest/groupService/groups

Parameters

name: The name of the group.

description: A short description of this group.

Parameters Template

<createGroup> 
    <name>xs:string</name>
    <description>xs:string</description>
</createGroup>

Return Value Template

<createGroupResponse> 
    <return>
        <!-- Contents of Group -->
    <return>
</createGroupResponse>

deleteGroup

Delete the group with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/groupService/groups/{groupID}

Parameters

groupID: The id of the group to delete.

Parameters Template

<deleteGroup> 
    <groupID>xs:long</groupID>
</deleteGroup>

deleteProperty

Deletes an extended property from the specfied group.

DELETE http://domain:port/clearspace_context/rpc/rest/groupService/properties/{groupID}/{name}

Parameters

name: The name of the extended property to delete.

groupID: The id of the group to delete an extended property from.

Parameters Template

<deleteProperty> 
    <name>xs:string</name>
    <groupID>xs:long</groupID>
</deleteProperty>

getAdministratorCount

Returns the count of how many administrators there are for the group with the specified ID.

GET http://domain:port/clearspace_context/rpc/rest/groupService/administratorCount/{groupID}

Parameters

groupID: The ID of the group to acquire the administrator count for.

Parameters Template

<getAdministratorCount> 
    <groupID>xs:long</groupID>
</getAdministratorCount>

Return Value Template

<getAdministratorCountResponse> 
    <return>xs:int</return>
</getAdministratorCountResponse>

getGroup

Returns a by its ID.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupsByID/{groupID}

Parameters

groupID: The ID of the group.

Parameters Template

<getGroup> 
    <groupID>xs:long</groupID>
</getGroup>

Return Value Template

<getGroupResponse> 
    <return>
        <!-- Contents of Group -->
    <return>
</getGroupResponse>

getGroupAdmins

Returns an array of all the user IDs that administer this group.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupAdmins/{groupID}

Parameters

groupID: The group ID to acquire administrator IDs for.

Parameters Template

<getGroupAdmins> 
    <groupID>xs:long</groupID>
</getGroupAdmins>

Return Value Template

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

getGroupByName

Returns a by its name. The name should be encoded using java.net.URLEncoder.encode(name, "UTF-8") or equivalent.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groups/{name}

Parameters

name: The name of the group UTF-8 encoded.

Parameters Template

<getGroupByName> 
    <name>xs:string</name>
</getGroupByName>

Return Value Template

<getGroupByNameResponse> 
    <return>
        <!-- Contents of Group -->
    <return>
</getGroupByNameResponse>

getGroupCount

Returns a count of all groups in the system.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupCount

Return Value Template

<getGroupCountResponse> 
    <return>xs:int</return>
</getGroupCountResponse>

getGroupMembers

Returns an array of all userIDs for all the members of a particular group.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupMembers/{groupID}

Parameters

groupID: The ID of the group to acquire members for.

Parameters Template

<getGroupMembers> 
    <groupID>xs:long</groupID>
</getGroupMembers>

Return Value Template

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

getGroupNames

Returns an array of all the group names for all the groups in the system.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupNames

Return Value Template

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

getGroupNamesBounded

Returns an array of the group names beginning at startIndex and until the number results equals numResults.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groupNamesBounded/{startIndex}/{numResults}

Parameters

startIndex: start index in results.

numResults: number of results to return.

Parameters Template

<getGroupNamesBounded> 
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</getGroupNamesBounded>

Return Value Template

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

getGroups

Returns an array of all the group IDs for all the groups in the system.

GET http://domain:port/clearspace_context/rpc/rest/groupService/groups

Return Value Template

<getGroupsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Group -->
    <return>
</getGroupsResponse>

getProperties

Returns an array of all the extended properties for a group.

GET http://domain:port/clearspace_context/rpc/rest/groupService/properties/{groupID}

Parameters

groupID: The ID of the group to acquire extended properties for.

Parameters Template

<getProperties> 
    <groupID>xs:long</groupID>
</getProperties>

Return Value Template

<getPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getPropertiesResponse>

getUserGroupNames

Returns an array of group names that an entity belongs to.

GET http://domain:port/clearspace_context/rpc/rest/groupService/userGroupNames/{userID}

Parameters

userID: the ID of the user.

Parameters Template

<getUserGroupNames> 
    <userID>xs:long</userID>
</getUserGroupNames>

Return Value Template

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

getUserGroups

Returns an array of all the group IDs that a user belongs too.

GET http://domain:port/clearspace_context/rpc/rest/groupService/userGroups/{userID}

Parameters

userID: The ID of the user to acquire group IDs for.

Parameters Template

<getUserGroups> 
    <userID>xs:long</userID>
</getUserGroups>

Return Value Template

<getUserGroupsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Group -->
    <return>
</getUserGroupsResponse>

isReadOnly

Returns true if this GroupService is read-only. When read-only, groups can not be created, deleted, or modified.

GET http://domain:port/clearspace_context/rpc/rest/groupService/isReadOnly

Return Value Template

<isReadOnlyResponse> 
    <return>xs:boolean</return>
</isReadOnlyResponse>

removeAdministratorFromGroup

Remove the user with the specified ID as an administrator from the group with the specified ID.

DELETE http://domain:port/clearspace_context/rpc/rest/groupService/groupAdmins/{groupID}/{userID}

Parameters

userID: The ID of the user to remove admin status from a group.

groupID: The ID of the group to remove the user as an admin.

Parameters Template

<removeAdministratorFromGroup> 
    <userID>xs:long</userID>
    <groupID>xs:long</groupID>
</removeAdministratorFromGroup>

removeMemberFromGroup

Remove the user with the specified id from the group with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/groupService/groupMembers/{groupID}/{userID}

Parameters

userID: The ID of the User to remove from a group.

groupID: The ID of the group to remove a user from.

Parameters Template

<removeMemberFromGroup> 
    <userID>xs:long</userID>
    <groupID>xs:long</groupID>
</removeMemberFromGroup>

setProperty

Set a new extended property on the specified group.

POST http://domain:port/clearspace_context/rpc/rest/groupService/properties

Parameters

name: The extended property name.

value: The extended property value.

groupID: The ID of the group to set the extended property on.

Parameters Template

<setProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <groupID>xs:long</groupID>
</setProperty>

updateGroup

Update the following group in the system.

PUT http://domain:port/clearspace_context/rpc/rest/groupService/groups

iMService

Provides a the ability for managing real time comunication.

Method	Description
configureComponent	Tries to connect to XMPP server.
testCredentials	Test if user's credentials are OK and have enough permissions.
updateSharedSecret	Updates the shared secret and resets the connection using it.

configureComponent

Tries to connect to XMPP server. Since the server could have several host names this method will try to connect using each one. When it founds a host/port combination that works it stops trying and saves that configuration.

POST http://domain:port/clearspace_context/rpc/rest/iMService/configureComponent

Parameters

domain: the domain of Openfire

hosts: a list of possible host address of Openfire, comma separated

port: the port of external components of Openfire

Parameters Template

<configureComponent> 
    <domain>xs:string</domain>
    <!-- List of ... -->
    <hosts>xs:string</hosts>
    <port>xs:int</port>
</configureComponent>

testCredentials

Test if user's credentials are OK and have enough permissions. Throws an UnauthorizedException if user is not loged in or it doesn't have enough permissions.

GET http://domain:port/clearspace_context/rpc/rest/iMService/testCredentials

updateSharedSecret

Updates the shared secret and resets the connection using it.

POST http://domain:port/clearspace_context/rpc/rest/iMService/updateSharedSecret

Parameters

newSecret: the new shared secret

Parameters Template

<updateSharedSecret> 
    <newSecret>xs:string</newSecret>
</updateSharedSecret>

permissionService

Provides a webservice for managing permissions on users and groups.

Method	Description
addCommunityPermissionToGroup	Add the specified permission on the specified community to the group with the specified id.
addCommunityPermissionToUser	Add the specified permission on the specified community to the user with the specified id.
addPermissionToGroup	Add the specified permission to the group with the specified id.
addPermissionToUser	Add the specified permission to the user with the specified id.
anonymousUserHasPermission	Returns true if the anonymous users have a particular permission globally.
anonymousUserHasPermissionOnCommunity	Returns true if the anonymous users have a particular permission on the community with the specified ID.
authenticate	Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.
isAuthorized	Returns true if the current user has globally has the specified permission.
isAuthorizedOnCommunity	Returns true if the current user has the permission specified on the specified community.
isGroupAuthorized	Returns true if the specified group has the specified permission on the specified jive Object.
isUserAuthorized	Check to see if the specified user has the particular permission system wide.
isUserAuthorizedOnCommunity	Check to see if the specified user has the particular permission on the specified community.
registeredUserHasPermission	Returns true if registered users have a particular permission globally.
registeredUserHasPermissionOnCommunity	Returns true if registered users have a particular permission on the community with the specified ID.
removeCommunityPermissionFromGroup	Remove the specified permission on the specified community from the group with the specified id.
removeCommunityPermissionFromUser	Remove the specified permission on the specified community from the user with the specified id.
removePermissionFromGroup	Remove the specified permission from the group with the specified id.
removePermissionFromUser	Remove the specified permission from the user with the specified id.
usersWithPermission	Returns all the userID's of users with a particular permission.
usersWithPermissionCount	Returns a count of the users that have a particular permission.
usersWithPermissionCountOnCommunity	Returns a count of the users that have a particular permission on the specified community.
usersWithPermissionOnCommunity	Returns all the userID's of users with a particular permission on the specified community.

addCommunityPermissionToGroup

Add the specified permission on the specified community to the group with the specified id.

POST http://domain:port/clearspace_context/rpc/rest/permissionService/groupCommunityPermissions/{permission}/{additive}/{groupID}/{communityID}

Parameters

permission: The permission to add to a group.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

groupID: The id of the group to add a permission too.

communityID: The ID of the community to add the permission on

Parameters Template

<addCommunityPermissionToGroup> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <groupID>xs:long</groupID>
    <communityID>xs:long</communityID>
</addCommunityPermissionToGroup>

addCommunityPermissionToUser

Add the specified permission on the specified community to the user with the specified id.

POST http://domain:port/clearspace_context/rpc/rest/permissionService/userCommunityPermissions

Parameters

permission: The permission to add to a user.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

userID: The id of the user to add a permission too.

communityID: The ID of the community to add the permission on

Parameters Template

<addCommunityPermissionToUser> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</addCommunityPermissionToUser>

addPermissionToGroup

Add the specified permission to the group with the specified id.

POST http://domain:port/clearspace_context/rpc/rest/permissionService/groupPermissions

Parameters

permission: The permission to add to a group.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

groupID: The id of the group to add a permission too.

Parameters Template

<addPermissionToGroup> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <groupID>xs:long</groupID>
</addPermissionToGroup>

addPermissionToUser

Add the specified permission to the user with the specified id.

POST http://domain:port/clearspace_context/rpc/rest/permissionService/userPermissions

Parameters

permission: The permission to add to a user.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

userID: The id of the user to add a permission too.

Parameters Template

<addPermissionToUser> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <userID>xs:long</userID>
</addPermissionToUser>

anonymousUserHasPermission

Returns true if the anonymous users have a particular permission globally.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/anonymousUserHasPermission/{permission}/{additive}

Parameters

permission: The permission to see if anonymous users have this permission.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

Parameters Template

<anonymousUserHasPermission> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
</anonymousUserHasPermission>

Return Value Template

<anonymousUserHasPermissionResponse> 
    <return>xs:boolean</return>
</anonymousUserHasPermissionResponse>

anonymousUserHasPermissionOnCommunity

Returns true if the anonymous users have a particular permission on the community with the specified ID.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/anonymousUserHasPermissionOnCommunity/{permission}/{additive}/{communityID}

Parameters

permission: The permission to see if anonymous users have this permission on the specified community.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

communityID: The ID of the community to check to see if a user has permission on.

Parameters Template

<anonymousUserHasPermissionOnCommunity> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <communityID>xs:long</communityID>
</anonymousUserHasPermissionOnCommunity>

Return Value Template

<anonymousUserHasPermissionOnCommunityResponse> 
    <return>xs:boolean</return>
</anonymousUserHasPermissionOnCommunityResponse>

authenticate

Returns if the username and password are valid; otherwise this method throws an UnauthorizedException.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/authenticate/{userID}/{password}

Parameters

userID: The username to authenticate.

password: The password .

Parameters Template

<authenticate> 
    <userID>xs:string</userID>
    <password>xs:string</password>
</authenticate>

isAuthorized

Returns true if the current user has globally has the specified permission. Certain methods of this class are restricted to certain permissions as specified in the method comments.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/isAuthorized/{permission}

Parameters

permission: a permission type.

Parameters Template

<isAuthorized> 
    <permission>xs:long</permission>
</isAuthorized>

Return Value Template

<isAuthorizedResponse> 
    <return>xs:boolean</return>
</isAuthorizedResponse>

isAuthorizedOnCommunity

Returns true if the current user has the permission specified on the specified community.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/isAuthorizedOnCommunity/{permission}/{communityID}

Parameters

permission: a permission type.

communityID: to see if the current user has permission on.

Parameters Template

<isAuthorizedOnCommunity> 
    <permission>xs:long</permission>
    <communityID>xs:long</communityID>
</isAuthorizedOnCommunity>

Return Value Template

<isAuthorizedOnCommunityResponse> 
    <return>xs:boolean</return>
</isAuthorizedOnCommunityResponse>

isGroupAuthorized

Returns true if the specified group has the specified permission on the specified jive Object.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/isGroupAuthorized/{permission}/{groupID}/{objectType}/{objectID}

Parameters

permission: The permission to test for.

groupID: The group to test for the permission

objectType: The type of object to test against.

objectID: The id of the object to test against.

Parameters Template

<isGroupAuthorized> 
    <permission>xs:long</permission>
    <groupID>xs:long</groupID>
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</isGroupAuthorized>

Return Value Template

<isGroupAuthorizedResponse> 
    <return>xs:boolean</return>
</isGroupAuthorizedResponse>

isUserAuthorized

Check to see if the specified user has the particular permission system wide.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/isUserAuthorized/{permissoin}/{userID}

Parameters

permission: The permission to add to check.

userID: The id of the user.

Parameters Template

<isUserAuthorized> 
    <permission>xs:long</permission>
    <userID>xs:long</userID>
</isUserAuthorized>

Return Value Template

<isUserAuthorizedResponse> 
    <return>xs:boolean</return>
</isUserAuthorizedResponse>

isUserAuthorizedOnCommunity

Check to see if the specified user has the particular permission on the specified community.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/isUserAuthorizedOnCommunity/{permission}/{userID}/{communityID}

Parameters

permission: The permission to add to check.

userID: The id of the user.

communityID: The id of the community.

Parameters Template

<isUserAuthorizedOnCommunity> 
    <permission>xs:long</permission>
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</isUserAuthorizedOnCommunity>

Return Value Template

<isUserAuthorizedOnCommunityResponse> 
    <return>xs:boolean</return>
</isUserAuthorizedOnCommunityResponse>

registeredUserHasPermission

Returns true if registered users have a particular permission globally. "Registered Users" does not refer to the static current list of users. Instead, it dynamically matches to any member of the user database.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/registeredUserHasPermission/{permission}/{additive}

Parameters

permission: The permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

Parameters Template

<registeredUserHasPermission> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
</registeredUserHasPermission>

Return Value Template

<registeredUserHasPermissionResponse> 
    <return>xs:boolean</return>
</registeredUserHasPermissionResponse>

registeredUserHasPermissionOnCommunity

Returns true if registered users have a particular permission on the community with the specified ID. "Registered Users" does not refer to the static current list of users. Instead, it dynamically matches to any member of the user database.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/registeredUserHasPermissionOnCommunity/{permission}/{additive}/{communityID}

Parameters

permission: The permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

communityID: The ID of the community to check the permission on.

Parameters Template

<registeredUserHasPermissionOnCommunity> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <communityID>xs:long</communityID>
</registeredUserHasPermissionOnCommunity>

Return Value Template

<registeredUserHasPermissionOnCommunityResponse> 
    <return>xs:boolean</return>
</registeredUserHasPermissionOnCommunityResponse>

removeCommunityPermissionFromGroup

Remove the specified permission on the specified community from the group with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/permissionService/groupCommunityPermissions/{permission}/{additive}/{groupID}/{communityID}

Parameters

permission: The permission remove from a group.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

groupID: The id of the group to remove a permission from.

communityID: The ID of the community to remove the permission from.

Parameters Template

<removeCommunityPermissionFromGroup> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <groupID>xs:long</groupID>
    <communityID>xs:long</communityID>
</removeCommunityPermissionFromGroup>

removeCommunityPermissionFromUser

Remove the specified permission on the specified community from the user with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/permissionService/userCommunityPermissions/{permission}/{additive}/{userID}/{communityID}

Parameters

permission: The permission remove from a user.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

userID: The id of the user to remove a permission from.

communityID: The ID of the community to remove the permission from.

Parameters Template

<removeCommunityPermissionFromUser> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</removeCommunityPermissionFromUser>

removePermissionFromGroup

Remove the specified permission from the group with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/permissionService/groupPermissions/{permission}/{additive}/{groupID}

Parameters

permission: The permission remove from a group.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

groupID: The id of the group to remove a permission from.

Parameters Template

<removePermissionFromGroup> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <groupID>xs:long</groupID>
</removePermissionFromGroup>

removePermissionFromUser

Remove the specified permission from the user with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/permissionService/userPermissions/{permission}/{additive}/{userID}

Parameters

permission: The permission remove from a user.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

userID: The id of the user to remove a permission from.

Parameters Template

<removePermissionFromUser> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <userID>xs:long</userID>
</removePermissionFromUser>

usersWithPermission

Returns all the userID's of users with a particular permission. This list does not include the special "anonymous users" and "registered users" permission types. This method is not the normal method for determining if a user has a certain permission on an object in the system; instead it is only useful for permission management. For example, to check if a user has(perm), where community is the community you want to check perms on.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/userPermissions/{permission}/{additive}

Parameters

permission: the permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

Parameters Template

<usersWithPermission> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
</usersWithPermission>

Return Value Template

<usersWithPermissionResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</usersWithPermissionResponse>

usersWithPermissionCount

Returns a count of the users that have a particular permission. This count does not include the special "anonymous users" and "registered users" permission types.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/usersWithPermissionCount/{permission}/{additive}

Parameters

permission: the permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

Parameters Template

<usersWithPermissionCount> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
</usersWithPermissionCount>

Return Value Template

<usersWithPermissionCountResponse> 
    <return>xs:int</return>
</usersWithPermissionCountResponse>

usersWithPermissionCountOnCommunity

Returns a count of the users that have a particular permission on the specified community. This count does not include the special "anonymous users" and "registered users" permission types.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/communityUserPermissionCount/{permission}/{additive}/{communityID}

Parameters

permission: the permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects

communityID: The id of the community..

Parameters Template

<usersWithPermissionCountOnCommunity> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <communityID>xs:long</communityID>
</usersWithPermissionCountOnCommunity>

Return Value Template

<usersWithPermissionCountOnCommunityResponse> 
    <return>xs:int</return>
</usersWithPermissionCountOnCommunityResponse>

usersWithPermissionOnCommunity

Returns all the userID's of users with a particular permission on the specified community. This list does not include the special "anonymous users" and "registered users" permission types. This method is not the normal method for determining if a user has a certain permission on an object in the system; instead it is only useful for permission management. For example, to check if a user has(perm), where community is the community you want to check perms on.

GET http://domain:port/clearspace_context/rpc/rest/permissionService/userCommunityPermissions/{permission}/{additive}/{communityID}

Parameters

permission: the permission to check.

additive: True if the permission should be 'added' to the permissions retrieved from a parent object(s). This means that if the permission has been already set in a parent object, it will be inherited by all child objects.

communityID: The ID of the community to get users with the specified permission.

Parameters Template

<usersWithPermissionOnCommunity> 
    <permission>xs:long</permission>
    <additive>xs:boolean</additive>
    <communityID>xs:long</communityID>
</usersWithPermissionOnCommunity>

Return Value Template

<usersWithPermissionOnCommunityResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</usersWithPermissionOnCommunityResponse>

pollService

Method	Description
addAnonymousVote	Add a guest vote for an option in the poll.
addOption	Add a new option to the poll.
addUserVote	Add a user vote for an option in the poll.
changeAnonymousVote	Change a guest vote.
changeUserVote	Change a user vote.
createPoll
deleteOption	Remove an option from the poll.
deletePoll	Deletes a poll.
getActivePollCount	Returns a count of all active polls in the system.
getActivePollCountByObjectTypeAndObjectID	Returns a count of all active polls of a given type and object ID.
getActivePolls	Returns an iterable of active polls in the system.
getActivePollsByObjectTypeAndObjectID	Returns an iterable of active polls associated with the object specified by the objectType and objectID.
getAnonymousVoteCount	Returns a count of all guests user votes for all options in the poll.
getAnonymousVoteCountByIndex	Returns a count of all user votes for the specified option in the poll.
getAnonymousVoteIndices	Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.
getAnonymousVotes	Returns a list of uniqueID's for guests who have voted for the option at the given index.
getAnonymousVotesByIndex	Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
getLivePollCount	Returns a count of all live polls in the system.
getLivePollCountByObjectTypeAndObjectID	Returns a count of all live polls of a given type and object ID.
getLivePolls	Returns a List of live polls in the system.
getLivePollsByObjectTypeAndObjectID	Returns an iterable of live polls associated with the object specified by the objectType and objectID.
getPoll	Returns the Poll specified by the poll ID.
getPollCount	Returns a count of all polls, both active and inactive.
getPollCountByObjectTypeAndObjectID	Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPolls	Returns an iterable of all polls, both active and inactive.
getPollsByObjectTypeAndObjectID	Returns an iterable of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getUserVoteCount	Returns a count of all user votes for all options in the poll.
getUserVoteCountByIndex	Returns a count of all user votes for the specified option in the poll.
getUserVoteIndices	Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
getUserVotes	Returns a List of User objects for users who have voted for any options in the poll.
getUserVotesByIndex	Returns a list of User objects for users who have voted for the option at the given index.
getVoteCount	Returns a count of all votes (both guest and user votes) for all options in the poll.
getVoteCountByIndex	Returns a count of all votes (both guest and user votes) for the specified option in the poll.
hasAnonymousVoted	Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.
hasUserVoted	Returns true if the user specified has previously voted in the poll, false otherwise.
isModeEnabled	Returns true if the mode specified is enabled for the poll, false otherwise.
removeAnonymousVote	Remove a guest vote.
removeUserVote	Remove a user vote.
setMode	Sets a mode to be enabled or disabled for the poll.
setOption	Sets the text of the option at the specified index.
setOptionIndex	Moves the option's index.
update

addAnonymousVote

Add a guest vote for an option in the poll.

POST http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymous

Parameters

pollID: the index of the option that the guest is voting for

index: a uniqueID for the guest. We suggest either using a session ID or the remote IP of the guest voting.

uniqueID

Parameters Template

<addAnonymousVote> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
    <uniqueID>xs:string</uniqueID>
</addAnonymousVote>

addOption

Add a new option to the poll. The option will be added to the end of the option list for the poll.

POST http://domain:port/clearspace_context/rpc/rest/pollService/options

Parameters

pollID: the text for the new option.

value

Parameters Template

<addOption> 
    <pollID>xs:long</pollID>
    <value>xs:string</value>
</addOption>

addUserVote

Add a user vote for an option in the poll.

POST http://domain:port/clearspace_context/rpc/rest/pollService/votes/user

Parameters

pollID: the index of the option that the user is voting for

index: the user making the vote

userID

Parameters Template

<addUserVote> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
    <userID>xs:long</userID>
</addUserVote>

changeAnonymousVote

Change a guest vote. This method will throw a PollException unless the mode 'ALLOW_ANONYMOUS_VOTE_MODIFICATION' is enabled for the poll.

PUT http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymous

Parameters

pollID: the index of the option to change the vote from.

prevOptionIndex: the index of the option to change the vote to.

newOptionIndex: a uniqueID for the guest.

uniqueID

Parameters Template

<changeAnonymousVote> 
    <pollID>xs:long</pollID>
    <prevOptionIndex>xs:int</prevOptionIndex>
    <newOptionIndex>xs:int</newOptionIndex>
    <uniqueID>xs:string</uniqueID>
</changeAnonymousVote>

changeUserVote

Change a user vote. This method will throw a PollException unless the mode 'ALLOW_USER_VOTE_MODIFICATION' is enabled for the poll.

PUT http://domain:port/clearspace_context/rpc/rest/pollService/votes/user

Parameters

pollID: the index of the option to change the vote from.

prevOptionIndex: the index of the option to change the vote to.

newOptionIndex

userID

Parameters Template

<changeUserVote> 
    <pollID>xs:long</pollID>
    <prevOptionIndex>xs:int</prevOptionIndex>
    <newOptionIndex>xs:int</newOptionIndex>
    <userID>xs:long</userID>
</changeUserVote>

createPoll

POST http://domain:port/clearspace_context/rpc/rest/pollService/polls

Parameters

objectType

objectID

userID

name

Parameters Template

<createPoll> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <userID>xs:long</userID>
    <name>xs:string</name>
</createPoll>

Return Value Template

<createPollResponse> 
    <return>
        <!-- Contents of Poll -->
    <return>
</createPollResponse>

deleteOption

Remove an option from the poll.

DELETE http://domain:port/clearspace_context/rpc/rest/pollService/options/{pollID}/{index}

Parameters

pollID

index

Parameters Template

<deleteOption> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
</deleteOption>

deletePoll

Deletes a poll.

DELETE http://domain:port/clearspace_context/rpc/rest/pollService/polls/{pollID}

Parameters

pollID: the poll to delete

Parameters Template

<deletePoll> 
    <pollID>xs:long</pollID>
</deletePoll>

getActivePollCount

Returns a count of all active polls in the system. Active polls are defined as polls where the current date is between the poll's start and expire dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/activePollCount

Return Value Template

<getActivePollCountResponse> 
    <return>xs:int</return>
</getActivePollCountResponse>

getActivePollCountByObjectTypeAndObjectID

Returns a count of all active polls of a given type and object ID. Active polls are defined as polls where the current date is between the poll's start and expire dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/activePollCount/{objectType}/{objectID}

Parameters

objectType: the type of object we're looking at (defined in the class.

objectID: the ID of the object we're looking at.

Parameters Template

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

Return Value Template

<getActivePollCountByObjectTypeAndObjectIDResponse> 
    <return>xs:int</return>
</getActivePollCountByObjectTypeAndObjectIDResponse>

getActivePolls

Returns an iterable of active polls in the system. Active polls are defined as polls where the current date is between the poll's start and expire dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/activePolls

Return Value Template

<getActivePollsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getActivePollsResponse>

getActivePollsByObjectTypeAndObjectID

Returns an iterable of active polls associated with the object specified by the objectType and objectID. Active polls are defined as polls where the current date is between the poll's start and expire dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/activePolls/{objectType}/{objectID}

Parameters

objectType: the object type of the object the poll is associated with.

objectID: the objectID of the object the poll is associated with.

Parameters Template

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

Return Value Template

<getActivePollsByObjectTypeAndObjectIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getActivePollsByObjectTypeAndObjectIDResponse>

getAnonymousVoteCount

Returns a count of all guests user votes for all options in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymousCount/{pollID}

Parameters

pollID

Parameters Template

<getAnonymousVoteCount> 
    <pollID>xs:long</pollID>
</getAnonymousVoteCount>

Return Value Template

<getAnonymousVoteCountResponse> 
    <return>xs:int</return>
</getAnonymousVoteCountResponse>

getAnonymousVoteCountByIndex

Returns a count of all user votes for the specified option in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymousCount/{pollID}/{index}

Parameters

pollID

index

Parameters Template

<getAnonymousVoteCountByIndex> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
</getAnonymousVoteCountByIndex>

Return Value Template

<getAnonymousVoteCountByIndexResponse> 
    <return>xs:int</return>
</getAnonymousVoteCountByIndexResponse>

getAnonymousVoteIndices

Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymousIndices/{pollID}/{uniqueID}

Parameters

pollID: a uniqueID for the guest.

uniqueID

Parameters Template

<getAnonymousVoteIndices> 
    <pollID>xs:long</pollID>
    <uniqueID>xs:string</uniqueID>
</getAnonymousVoteIndices>

Return Value Template

<getAnonymousVoteIndicesResponse> 
    <!-- List of ... -->
    <return>xs:int</return>
</getAnonymousVoteIndicesResponse>

getAnonymousVotes

Returns a list of uniqueID's for guests who have voted for the option at the given index.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymous/{pollID}

Parameters

pollID

Parameters Template

<getAnonymousVotes> 
    <pollID>xs:long</pollID>
</getAnonymousVotes>

Return Value Template

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

getAnonymousVotesByIndex

Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymous/{pollID}/{index}

Parameters

pollID: the index to return the voting guests for.

index

Parameters Template

<getAnonymousVotesByIndex> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
</getAnonymousVotesByIndex>

Return Value Template

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

getLivePollCount

Returns a count of all live polls in the system. Live polls are defined as polls where the current date is between the poll's start and end dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/livePollCount

Return Value Template

<getLivePollCountResponse> 
    <return>xs:int</return>
</getLivePollCountResponse>

getLivePollCountByObjectTypeAndObjectID

Returns a count of all live polls of a given type and object ID. Live polls are defined as polls where the current date is between the poll's start and end dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/livePollCount/{objectType}/{objectID}

Parameters

objectType: the type of object we're looking at (defined in the class.

objectID: the ID of the object we're looking at.

Parameters Template

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

Return Value Template

<getLivePollCountByObjectTypeAndObjectIDResponse> 
    <return>xs:int</return>
</getLivePollCountByObjectTypeAndObjectIDResponse>

getLivePolls

Returns a List of live polls in the system. Live polls are defined as polls where the current date is between the poll's start and end dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/livePolls

Return Value Template

<getLivePollsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getLivePollsResponse>

getLivePollsByObjectTypeAndObjectID

Returns an iterable of live polls associated with the object specified by the objectType and objectID. Live polls are defined as polls where the current date is between the poll's start and end dates.

GET http://domain:port/clearspace_context/rpc/rest/pollService/livePolls/{objectType}/{objectID}

Parameters

objectType: the object type of the object the poll is associated with.

objectID: the objectID of the object the poll is associated with.

Parameters Template

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

Return Value Template

<getLivePollsByObjectTypeAndObjectIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getLivePollsByObjectTypeAndObjectIDResponse>

getPoll

Returns the Poll specified by the poll ID.

GET http://domain:port/clearspace_context/rpc/rest/pollService/polls/{pollID}

Parameters

pollID: the id of the poll to return.

Parameters Template

<getPoll> 
    <pollID>xs:long</pollID>
</getPoll>

Return Value Template

<getPollResponse> 
    <return>
        <!-- Contents of Poll -->
    <return>
</getPollResponse>

getPollCount

Returns a count of all polls, both active and inactive.

GET http://domain:port/clearspace_context/rpc/rest/pollService/pollCount

Return Value Template

<getPollCountResponse> 
    <return>xs:int</return>
</getPollCountResponse>

getPollCountByObjectTypeAndObjectID

Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.

GET http://domain:port/clearspace_context/rpc/rest/pollService/pollCount/{objectType}/{objectID}

Parameters

objectType: the object type of the object the poll is associated with.

objectID: the objectID of the object the poll is associated with.

Parameters Template

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

Return Value Template

<getPollCountByObjectTypeAndObjectIDResponse> 
    <return>xs:int</return>
</getPollCountByObjectTypeAndObjectIDResponse>

getPolls

Returns an iterable of all polls, both active and inactive. The ordering of the polls is from active to inactive polls and then from newest to oldest in each group.

GET http://domain:port/clearspace_context/rpc/rest/pollService/polls

Return Value Template

<getPollsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getPollsResponse>

getPollsByObjectTypeAndObjectID

Returns an iterable of polls, both active and inactive, associated with the object specified by the objectType and objectID.

GET http://domain:port/clearspace_context/rpc/rest/pollService/polls/{objectType}/{objectID}

Return Value Template

<getPollsByObjectTypeAndObjectIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Poll -->
    <return>
</getPollsByObjectTypeAndObjectIDResponse>

getUserVoteCount

Returns a count of all user votes for all options in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/userCount/{pollID}

Parameters

pollID

Parameters Template

<getUserVoteCount> 
    <pollID>xs:long</pollID>
</getUserVoteCount>

Return Value Template

<getUserVoteCountResponse> 
    <return>xs:int</return>
</getUserVoteCountResponse>

getUserVoteCountByIndex

Returns a count of all user votes for the specified option in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/userCount/{pollID}/{index}

Parameters

pollID

index

Parameters Template

<getUserVoteCountByIndex> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
</getUserVoteCountByIndex>

Return Value Template

<getUserVoteCountByIndexResponse> 
    <return>xs:int</return>
</getUserVoteCountByIndexResponse>

getUserVoteIndices

Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/userIndices/{pollID}/{userID}

Parameters

pollID: the user to return the indexes of options the user has voted for.

userID

Parameters Template

<getUserVoteIndices> 
    <pollID>xs:long</pollID>
    <userID>xs:long</userID>
</getUserVoteIndices>

Return Value Template

<getUserVoteIndicesResponse> 
    <!-- List of ... -->
    <return>xs:int</return>
</getUserVoteIndicesResponse>

getUserVotes

Returns a List of User objects for users who have voted for any options in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/{pollID}

Parameters

pollID

Parameters Template

<getUserVotes> 
    <pollID>xs:long</pollID>
</getUserVotes>

Return Value Template

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

getUserVotesByIndex

Returns a list of User objects for users who have voted for the option at the given index.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/{pollID}/{index}

Return Value Template

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

getVoteCount

Returns a count of all votes (both guest and user votes) for all options in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/count/{pollID}

Parameters

pollID

Parameters Template

<getVoteCount> 
    <pollID>xs:long</pollID>
</getVoteCount>

Return Value Template

<getVoteCountResponse> 
    <return>xs:int</return>
</getVoteCountResponse>

getVoteCountByIndex

Returns a count of all votes (both guest and user votes) for the specified option in the poll.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votesByIndex/{pollID}/{index}

Parameters

pollID

index

Parameters Template

<getVoteCountByIndex> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
</getVoteCountByIndex>

Return Value Template

<getVoteCountByIndexResponse> 
    <return>xs:int</return>
</getVoteCountByIndexResponse>

hasAnonymousVoted

Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymousVoted/{pollID}/{uniqueID}

Parameters

pollID: the uniqueID of the guest to check to see if they've voted already.

uniqueID

Parameters Template

<hasAnonymousVoted> 
    <pollID>xs:long</pollID>
    <uniqueID>xs:string</uniqueID>
</hasAnonymousVoted>

Return Value Template

<hasAnonymousVotedResponse> 
    <return>xs:boolean</return>
</hasAnonymousVotedResponse>

hasUserVoted

Returns true if the user specified has previously voted in the poll, false otherwise.

GET http://domain:port/clearspace_context/rpc/rest/pollService/votes/userVoted/{pollID}/{userID}

Parameters

pollID: id of the user to check to see if they've voted already.

userID

Parameters Template

<hasUserVoted> 
    <pollID>xs:long</pollID>
    <userID>xs:long</userID>
</hasUserVoted>

Return Value Template

<hasUserVotedResponse> 
    <return>xs:boolean</return>
</hasUserVotedResponse>

isModeEnabled

Returns true if the mode specified is enabled for the poll, false otherwise. Valid modes are defined as static final constants in this interface.

GET http://domain:port/clearspace_context/rpc/rest/pollService/modes/{pollID}/{mode}

Parameters

pollID: a valid poll mode

mode: of the poll we're querying

Parameters Template

<isModeEnabled> 
    <pollID>xs:long</pollID>
    <mode>xs:long</mode>
</isModeEnabled>

Return Value Template

<isModeEnabledResponse> 
    <return>xs:boolean</return>
</isModeEnabledResponse>

removeAnonymousVote

Remove a guest vote. This method will throw a PollException unless the mode 'ALLOW_ANONYMOUS_VOTE_MODIFICATION' is enabled for the poll.

DELETE http://domain:port/clearspace_context/rpc/rest/pollService/votes/anonymous/{pollID}/{prevOptionIndex}/{uniqueID}

Parameters

pollID: the index of the option to remove the vote from.

prevOptionIndex: a uniqueID for the guest.

uniqueID

Parameters Template

<removeAnonymousVote> 
    <pollID>xs:long</pollID>
    <prevOptionIndex>xs:int</prevOptionIndex>
    <uniqueID>xs:string</uniqueID>
</removeAnonymousVote>

removeUserVote

Remove a user vote. This method will throw a PollException unless the mode 'ALLOW_USER_VOTE_MODIFICATION' is enabled for the poll.

DELETE http://domain:port/clearspace_context/rpc/rest/pollService/votes/user/{pollID}/{prevOptionIndex}/{userID}

Parameters

pollID: the index of the option to remove the vote from.

prevOptionIndex

userID

Parameters Template

<removeUserVote> 
    <pollID>xs:long</pollID>
    <prevOptionIndex>xs:int</prevOptionIndex>
    <userID>xs:long</userID>
</removeUserVote>

setMode

Sets a mode to be enabled or disabled for the poll. Valid modes are defined as static final constants in this interface.

POST http://domain:port/clearspace_context/rpc/rest/pollService/modes

Parameters

pollID: a valid mode

mode: true if the poll should be enabled, false if not

enabled

Parameters Template

<setMode> 
    <pollID>xs:long</pollID>
    <mode>xs:long</mode>
    <enabled>xs:boolean</enabled>
</setMode>

setOption

Sets the text of the option at the specified index.

PUT http://domain:port/clearspace_context/rpc/rest/pollService/options

Parameters

pollID: the index of the option to set the text for.

index: the new text for the option.

value

Parameters Template

<setOption> 
    <pollID>xs:long</pollID>
    <index>xs:int</index>
    <value>xs:string</value>
</setOption>

setOptionIndex

Moves the option's index.

PUT http://domain:port/clearspace_context/rpc/rest/pollService/options/index

Parameters

pollID: the current index of the option.

currentIndex: the new index of the option.

newIndex

Parameters Template

<setOptionIndex> 
    <pollID>xs:long</pollID>
    <currentIndex>xs:int</currentIndex>
    <newIndex>xs:int</newIndex>
</setOptionIndex>

update

PUT http://domain:port/clearspace_context/rpc/rest/pollService/polls

privateMessageService

Provides the ability to manipulate private messages. Send, retrieve, move, list.

Method	Description
createFolder	Creates a new folder.
createMessage	Creates a new private message.
deleteFolder	Deletes a folder.
deleteMessage	Deletes a private message from the folder by moving it to the trash folder.
getFolder	Returns the specified folder for a user.
getFolders	Returns an Iterator of PrivateMessageFolder objects for the folders the user has.
getMessage	Returns the specified private message.
getMessageCount	Returns the total number of private messages a user has in their mailbox.
getMessageCountForFolder	Returns the message count on a specific folder.
getMessages	Returns all the messages in the folder sorted by date descending.
getUnreadMessageCount	Returns the total number of unread private messages a user has in their mailbox.
getUnreadMessageCountForFolder	Returns the total number of unread private messages a user has in a specific folder.
isPrivateMessagesEnabled	Returns <tt>true</tt> if the feature is enabled, <tt>false</tt> otherwise.
moveMessage	Moves a private message to another folder.
saveMessageAsDraft	Saves a message as a draft by storing it in the sender's <tt>Drafts</tt> folder.
sendMessage	Sends a private message to another user.

createFolder

Creates a new folder.

POST http://domain:port/clearspace_context/rpc/rest/privateMessageService/folders

Parameters

userID: of the user to create the folder for.

name: the name of the folder.

Parameters Template

<createFolder> 
    <userID>xs:long</userID>
    <name>xs:string</name>
</createFolder>

Return Value Template

<createFolderResponse> 
    <return>
        <!-- Contents of PrivateMessageFolder -->
    <return>
</createFolderResponse>

createMessage

Creates a new private message. The message must be either saved as a draft or sent to another user in order to be stored permanently.

POST http://domain:port/clearspace_context/rpc/rest/privateMessageService/messages

Parameters

senderID: of the user sending the message.

Parameters Template

<createMessage> 
    <senderID>xs:long</senderID>
</createMessage>

Return Value Template

<createMessageResponse> 
    <return>
        <!-- Contents of PrivateMessage -->
    <return>
</createMessageResponse>

deleteFolder

Deletes a folder. All messages in the folder will be moved to the user's Trash folder. Attempting to delete one of the four default folders will move all messages in the folder to Trash but won't delete the folder itself. If the folder is the Trash folder, all messages in the folder will be permanently deleted.

DELETE http://domain:port/clearspace_context/rpc/rest/privateMessageService/folders/{userID}/{folderID}

Parameters

userID: of the folder to associate

folderID: of the folder to delete.

Parameters Template

<deleteFolder> 
    <userID>xs:long</userID>
    <folderID>xs:int</folderID>
</deleteFolder>

deleteMessage

Deletes a private message from the folder by moving it to the trash folder. Messages in the Trash folder will be routinely automatically deleted. If this is the Trash folder, this method will do nothing.

DELETE http://domain:port/clearspace_context/rpc/rest/privateMessageService/userMessages/{userID}/{messageID}

Parameters

userID: the private message to delete.

messageID

Parameters Template

<deleteMessage> 
    <userID>xs:long</userID>
    <messageID>xs:long</messageID>
</deleteMessage>

getFolder

Returns the specified folder for a user.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/folders/{userID}/{folderID}

Parameters

userID: of the user.

folderID: the folder ID.

Parameters Template

<getFolder> 
    <userID>xs:long</userID>
    <folderID>xs:int</folderID>
</getFolder>

Return Value Template

<getFolderResponse> 
    <return>
        <!-- Contents of PrivateMessageFolder -->
    <return>
</getFolderResponse>

getFolders

Returns an Iterator of PrivateMessageFolder objects for the folders the user has. The four built-in folders (Inbox, Sent, Drafts, Trash) are returned first, followed by custom folders in alphabetical order.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/folders/{userID}

Parameters

userID: of the user.

Parameters Template

<getFolders> 
    <userID>xs:long</userID>
</getFolders>

Return Value Template

<getFoldersResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of PrivateMessageFolder -->
    <return>
</getFoldersResponse>

getMessage

Returns the specified private message.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/messages/{privateMessageID}

Parameters

privateMessageID: the ID of the private message.

Parameters Template

<getMessage> 
    <privateMessageID>xs:long</privateMessageID>
</getMessage>

Return Value Template

<getMessageResponse> 
    <return>
        <!-- Contents of PrivateMessage -->
    <return>
</getMessageResponse>

getMessageCount

Returns the total number of private messages a user has in their mailbox. This calculation does not count any messages in the user's Trash folder.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/messageCount/{userID}

Parameters

userID: of the user.

Parameters Template

<getMessageCount> 
    <userID>xs:long</userID>
</getMessageCount>

Return Value Template

<getMessageCountResponse> 
    <return>xs:int</return>
</getMessageCountResponse>

getMessageCountForFolder

Returns the message count on a specific folder.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/messsageCount/{userID}/{folderID}

Parameters

userID: of the user

folderID: the folder id

Parameters Template

<getMessageCountForFolder> 
    <userID>xs:long</userID>
    <folderID>xs:int</folderID>
</getMessageCountForFolder>

Return Value Template

<getMessageCountForFolderResponse> 
    <return>xs:int</return>
</getMessageCountForFolderResponse>

getMessages

Returns all the messages in the folder sorted by date descending.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/userMesages/{userID}/{folderID}

Parameters

userID

folderID

Parameters Template

<getMessages> 
    <userID>xs:long</userID>
    <folderID>xs:long</folderID>
</getMessages>

Return Value Template

<getMessagesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of PrivateMessage -->
    <return>
</getMessagesResponse>

getUnreadMessageCount

Returns the total number of unread private messages a user has in their mailbox. This calculation does not count any messages in the user's Trash folder.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/unreadMessageCount/{userID}

Parameters

userID: of the user.

Parameters Template

<getUnreadMessageCount> 
    <userID>xs:long</userID>
</getUnreadMessageCount>

Return Value Template

<getUnreadMessageCountResponse> 
    <return>xs:int</return>
</getUnreadMessageCountResponse>

getUnreadMessageCountForFolder

Returns the total number of unread private messages a user has in a specific folder.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/unreadMessageCount/{userID}/{folderID}

Parameters

userID: of the user

folderID: the folder id

Parameters Template

<getUnreadMessageCountForFolder> 
    <userID>xs:long</userID>
    <folderID>xs:int</folderID>
</getUnreadMessageCountForFolder>

Return Value Template

<getUnreadMessageCountForFolderResponse> 
    <return>xs:int</return>
</getUnreadMessageCountForFolderResponse>

isPrivateMessagesEnabled

Returns true if the feature is enabled, false otherwise.

GET http://domain:port/clearspace_context/rpc/rest/privateMessageService/privateMessagesEnabled

Return Value Template

<isPrivateMessagesEnabledResponse> 
    <return>xs:boolean</return>
</isPrivateMessagesEnabledResponse>

moveMessage

Moves a private message to another folder.

POST http://domain:port/clearspace_context/rpc/rest/privateMessageService/moveMessage

Parameters

userID: of the user

messageID: of the message to move.

destinationFolderID: of the folder to move the message to.

Parameters Template

<moveMessage> 
    <userID>xs:long</userID>
    <messageID>xs:long</messageID>
    <destinationFolderID>xs:int</destinationFolderID>
</moveMessage>

saveMessageAsDraft

Saves a message as a draft by storing it in the sender's Drafts folder.

POST http://domain:port/clearspace_context/rpc/rest/privateMessageService/saveDraft

Parameters

privateMessage: the private message to save as a draft

Parameters Template

<saveMessageAsDraft> 
    <privateMessage>
        <!-- Contents of PrivateMessage -->
    <privateMessage>
</saveMessageAsDraft>

sendMessage

Sends a private message to another user. The message will be delivered to the recipient's Inbox. Optionally, a copy of the message will be put in the sender's Sent folder.

If the recipient's mailbox is full, a will be thrown. The exception will also be thrown if the recipient is not allowed to receive private messages or if the user has elected to save a copy of the message in their Sent folder, but doesn't have room to do so.

POST http://domain:port/clearspace_context/rpc/rest/privateMessageService/sendMessage

Parameters

privateMessage: the message to send.

recipientID: of the user to send the message to.

copyToSentFolder: true if the message should be copied to the <tt>Sent</tt> folder.

Parameters Template

<sendMessage> 
    <privateMessage>
        <!-- Contents of PrivateMessage -->
    <privateMessage>
    <recipientID>xs:long</recipientID>
    <copyToSentFolder>xs:boolean</copyToSentFolder>
</sendMessage>

profileFieldService

Defines methods used to create, access, update, and remove profile fields data. All user profile data is managed via the ProfileService.

Method	Description
createProfileField	Creates a new profile field.
deleteProfileField	Removes a profile field from the system.
editProfileField	Edits the profile field data.
editProfileFieldOptions	Edits the objects for a profile field.
getDefaultFields	Returns a list of all default profile fields.
getProfileField	Gets a profile field object by its id.
getProfileFields	Gets the list of all profile fields in the system.
setIndex	Sets the index of the profile field.

createProfileField

Creates a new profile field.

POST http://domain:port/clearspace_context/rpc/rest/profileFieldService/fields

Parameters

field: the new profile field to create.

Parameters Template

<createProfileField> 
    <field>
        <!-- Contents of ProfileField -->
    <field>
</createProfileField>

Return Value Template

<createProfileFieldResponse> 
    <return>
        <!-- Contents of ProfileField -->
    <return>
</createProfileFieldResponse>

deleteProfileField

Removes a profile field from the system. This method will also remove all the user data and objects associated with the field.

DELETE http://domain:port/clearspace_context/rpc/rest/profileFieldService/fields/{fieldID}

Parameters

fieldID: the id of the field to remove

Parameters Template

<deleteProfileField> 
    <fieldID>xs:long</fieldID>
</deleteProfileField>

editProfileField

Edits the profile field data.

PUT http://domain:port/clearspace_context/rpc/rest/profileFieldService/fields

Parameters

field: the profile field to edit.

Parameters Template

<editProfileField> 
    <field>
        <!-- Contents of ProfileField -->
    <field>
</editProfileField>

editProfileFieldOptions

Edits the objects for a profile field.

PUT http://domain:port/clearspace_context/rpc/rest/profileFieldService/options

Parameters

field: the field containing the edited objects.

Parameters Template

<editProfileFieldOptions> 
    <field>
        <!-- Contents of ProfileField -->
    <field>
</editProfileFieldOptions>

getDefaultFields

Returns a list of all default profile fields. These fields need not be shown, but they cannot be deleted.

GET http://domain:port/clearspace_context/rpc/rest/profileFieldService/defaultFields

Return Value Template

<getDefaultFieldsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ProfileField -->
    <return>
</getDefaultFieldsResponse>

getProfileField

Gets a profile field object by its id.

GET http://domain:port/clearspace_context/rpc/rest/profileFieldService/fields/{fieldID}

Parameters

fieldID: the id of the profile field.

Parameters Template

<getProfileField> 
    <fieldID>xs:long</fieldID>
</getProfileField>

Return Value Template

<getProfileFieldResponse> 
    <return>
        <!-- Contents of ProfileField -->
    <return>
</getProfileFieldResponse>

getProfileFields

Gets the list of all profile fields in the system.

GET http://domain:port/clearspace_context/rpc/rest/profileFieldService/fields

Return Value Template

<getProfileFieldsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of ProfileField -->
    <return>
</getProfileFieldsResponse>

setIndex

Sets the index of the profile field. The index value can be used to display the fields in an arbitrary order. Index values are from 0 to getProfileFields().size() - 1.

POST http://domain:port/clearspace_context/rpc/rest/profileFieldService/index

Parameters

fieldID: the profile field id to adjust the index of.

newIndex: the new index value for the field.

Parameters Template

<setIndex> 
    <fieldID>xs:long</fieldID>
    <newIndex>xs:int</newIndex>
</setIndex>

profileSearchService

Provides the ability to search users.

Method	Description
getSimilarUserResults	Returns the the first 5 users that are similar to the specified user.
isSearchEnabled	Returns true if the profile search feature is turned on.
search	Returns the users that correspond to the search query.
searchBounded	Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

getSimilarUserResults

Returns the the first 5 users that are similar to the specified user. This method only checks profile data, and does not use username, name, or email address as a means of determining similarity.

GET http://domain:port/clearspace_context/rpc/rest/profileSearchService/similarUsers/{targetUserID}

Parameters

groupID: the user ID that other user records will be similar to

Parameters Template

<getSimilarUserResults> 
    <groupID>xs:long</groupID>
</getSimilarUserResults>

Return Value Template

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

isSearchEnabled

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

GET http://domain:port/clearspace_context/rpc/rest/profileSearchService/isSearchEnabled

Return Value Template

<isSearchEnabledResponse> 
    <return>xs:boolean</return>
</isSearchEnabledResponse>

search

Returns the users that correspond to the search query.

POST http://domain:port/clearspace_context/rpc/rest/profileSearchService/searchProfile

Parameters

query: the profile search query

Parameters Template

<search> 
    <query>
        <!-- Contents of ProfileSearchQuery -->
    <query>
</search>

Return Value Template

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

searchBounded

Returns the users that correspond to the search query beginning at startIndex and until the number results equals numResults.

POST http://domain:port/clearspace_context/rpc/rest/profileSearchService/searchProfileBounded

Parameters

query: the profile search query

startIndex: the starting index in the search result to return.

numResults: the number of users to return in the search result.

Parameters Template

<searchBounded> 
    <query>
        <!-- Contents of ProfileSearchQuery -->
    <query>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</searchBounded>

Return Value Template

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

profileService

Manages user profile data. Defines methods used to create, access, update, and remove user profile data.

Method	Description
deleteProfileByID	Removes all user profile data associated with a particular profile field.
deleteProfileByUserID	Removes all user profile data associated with a particular user.
getProfile	Gets a map of user profile values for a particular user mapped to their corresponding <tt>ProfileField</tt> id.
getProfileImage	Returns the profile image for a user.
setProfile	Sets a array of profile values for a particular user.
setProfileImage	Set a new profile page image for the specified user.

deleteProfileByID

Removes all user profile data associated with a particular profile field. This method is generally called when a profile field is removed from the system.

DELETE http://domain:port/clearspace_context/rpc/rest/profileService/fields/{fieldID}

Parameters

fieldID: remove all user profile data associated with this profile field id.

Parameters Template

<deleteProfileByID> 
    <fieldID>xs:long</fieldID>
</deleteProfileByID>

deleteProfileByUserID

Removes all user profile data associated with a particular user. This method is generally called when a user is removed from the system.

DELETE http://domain:port/clearspace_context/rpc/rest/profileService/profiles/{userID}

Parameters

userID: remove all user profile data associated with this userID.

Parameters Template

<deleteProfileByUserID> 
    <userID>xs:long</userID>
</deleteProfileByUserID>

getProfile

Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.

GET http://domain:port/clearspace_context/rpc/rest/profileService/profiles/{userID}

Parameters

userID: get the profile for the user with this id.

Parameters Template

<getProfile> 
    <userID>xs:long</userID>
</getProfile>

Return Value Template

<getProfileResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of UserProfile -->
    <return>
</getProfileResponse>

getProfileImage

Returns the profile image for a user.

GET http://domain:port/clearspace_context/rpc/rest/profileService/images/{userID}

Parameters

userID: The id of the user to get an image for.

Parameters Template

<getProfileImage> 
    <userID>xs:long</userID>
</getProfileImage>

Return Value Template

<getProfileImageResponse> 
    <!-- List of ... -->
    <return>xs:base64Binary</return>
</getProfileImageResponse>

setProfile

Sets a array of profile values for a particular user.

POST http://domain:port/clearspace_context/rpc/rest/profileService/profiles

Parameters

userID: the user that represents the profile list

profiles: the array of user profile values to save

Parameters Template

<setProfile> 
    <userID>xs:long</userID>
    <!-- List of ... -->
    <profiles>
        <!-- Contents of UserProfile -->
    <profiles>
</setProfile>

setProfileImage

Set a new profile page image for the specified user.

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

Parameters

userID: The id of the user to add an image for.

mimeType: The mime type of the image.

data: The content for the image.

Parameters Template

<setProfileImage> 
    <userID>xs:long</userID>
    <mimeType>xs:string</mimeType>
    <!-- List of ... -->
    <data>xs:base64Binary</data>
</setProfileImage>

projectService

This service provides methods to load tasks by ID and to retrieve lists of projects. Once a handle on a project is obtained one can use the methods in this interface to update or delete a project or otherwise modify the project.

Method	Description
create
delete
getCheckPoints
getProjectByID
getProjectCount
getProjects
getUserCount
setCheckPoints
update

create

POST http://domain:port/clearspace_context/rpc/rest/projectService/projects

Parameters

containerType

containerID

name

description

userID

checkPoints

dueDate

Parameters Template

<create> 
    <containerType>xs:int</containerType>
    <containerID>xs:long</containerID>
    <name>xs:string</name>
    <description>xs:string</description>
    <userID>xs:long</userID>
    <!-- List of ... -->
    <checkPoints>
        <!-- Contents of CheckPoint -->
    <checkPoints>
    <dueDate>xs:dateTime</dueDate>
</create>

Return Value Template

<createResponse> 
    <return>
        <!-- Contents of Project -->
    <return>
</createResponse>

delete

DELETE http://domain:port/clearspace_context/rpc/rest/projectService/projects/{projectID}

Parameters

projectID

Parameters Template

<delete> 
    <projectID>xs:long</projectID>
</delete>

getCheckPoints

GET http://domain:port/clearspace_context/rpc/rest/projectService/checkPointsByProject/{projectID}

Parameters

projectID

Parameters Template

<getCheckPoints> 
    <projectID>xs:long</projectID>
</getCheckPoints>

Return Value Template

<getCheckPointsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of CheckPoint -->
    <return>
</getCheckPointsResponse>

getProjectByID

GET http://domain:port/clearspace_context/rpc/rest/projectService/projects/{projectID}

Parameters

projectID

Parameters Template

<getProjectByID> 
    <projectID>xs:long</projectID>
</getProjectByID>

Return Value Template

<getProjectByIDResponse> 
    <return>
        <!-- Contents of Project -->
    <return>
</getProjectByIDResponse>

getProjectCount

GET http://domain:port/clearspace_context/rpc/rest/projectService/projectCount

Return Value Template

<getProjectCountResponse> 
    <return>xs:int</return>
</getProjectCountResponse>

getProjects

GET http://domain:port/clearspace_context/rpc/rest/projectService/projects

Return Value Template

<getProjectsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Project -->
    <return>
</getProjectsResponse>

getUserCount

GET http://domain:port/clearspace_context/rpc/rest/projectService/userCount/{projectID}

Parameters

projectID

Parameters Template

<getUserCount> 
    <projectID>xs:long</projectID>
</getUserCount>

Return Value Template

<getUserCountResponse> 
    <return>xs:int</return>
</getUserCountResponse>

setCheckPoints

PUT http://domain:port/clearspace_context/rpc/rest/projectService/checkPoints

Parameters

projectID

checkpoints

Parameters Template

<setCheckPoints> 
    <projectID>xs:long</projectID>
    <!-- List of ... -->
    <checkpoints>
        <!-- Contents of CheckPoint -->
    <checkpoints>
</setCheckPoints>

update

PUT http://domain:port/clearspace_context/rpc/rest/projectService/projects

Parameters

project

Parameters Template

<update> 
    <project>
        <!-- Contents of Project -->
    <project>
</update>

ratingsService

Method	Description
addRating	Add a rating to the .
createRating	Create a new rating with the specified attributes.
getAvailableRatingCount	Returns the count of currently available ratings.
getAvailableRatings	Returns an iterable of Rating objects that list all the available ratings.
getMeanRating	A convenience method which returns a geometric mean average of all the ratings given to the .
getRating	Returns the rating associated with the user, or null if this user hasn't rated the .
getRatingCount	Returns the total number of ratings given to the .
getRatingFromScore	Retrieve the rating with the specified score.
getRatings	Returns an Iterable of all the ratings given to the .
hasRated	Returns whether the user has rated the or not.
isRatingsEnabled	Returns true if the rating feature is turned on.
removeRating	Remove the specified rating from the list of currently available ratings.
setRatingsEnabled	Enables or disables the ratings feature.

addRating

Add a rating to the . If the user has already rated, this rating will replace the previous rating. If the user is null (anonymous) this rating will be added to the ratings for the . The author of the cannot rate their own content.

http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/user

Parameters

userID: the user rating the

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

ratingScore: the rating the user wants to give to the

Parameters Template

<addRating> 
    <userID>xs:long</userID>
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <ratingScore>xs:int</ratingScore>
</addRating>

createRating

Create a new rating with the specified attributes. Only positive integers are allowed for the score, 0 or negative integers will cause an IllegalArgumentException to be thrown. If the score is already taken an IllegalArgumentException will be thrown.

POST http://domain:port/clearspace_context/rpc/rest/ratingsService/ratings

Parameters

score: the score or rating level for the new rating

description: the description of the new rating

Parameters Template

<createRating> 
    <score>xs:int</score>
    <description>xs:string</description>
</createRating>

Return Value Template

<createRatingResponse> 
    <return>
        <!-- Contents of Rating -->
    <return>
</createRatingResponse>

getAvailableRatingCount

Returns the count of currently available ratings.

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/ratings/count

Return Value Template

<getAvailableRatingCountResponse> 
    <return>xs:int</return>
</getAvailableRatingCountResponse>

getAvailableRatings

Returns an iterable of Rating objects that list all the available ratings. The returned list will be sorted from lowest rating to high rating.

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/ratings

Return Value Template

<getAvailableRatingsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Rating -->
    <return>
</getAvailableRatingsResponse>

getMeanRating

A convenience method which returns a geometric mean average of all the ratings given to the .

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/mean/{objectType}/{objectID}

Parameters

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

Parameters Template

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

Return Value Template

<getMeanRatingResponse> 
    <return>double</return>
</getMeanRatingResponse>

getRating

Returns the rating associated with the user, or null if this user hasn't rated the . If the user is null (anonymous) this method will return null.

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/user/{objectType}/{objectID}

Parameters

userID: of the user to check

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

Parameters Template

<getRating> 
    <userID>xs:long</userID>
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</getRating>

Return Value Template

<getRatingResponse> 
    <return>
        <!-- Contents of Rating -->
    <return>
</getRatingResponse>

getRatingCount

Returns the total number of ratings given to the .

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/count/{objectType}/{objectID}

Parameters

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

Parameters Template

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

Return Value Template

<getRatingCountResponse> 
    <return>xs:int</return>
</getRatingCountResponse>

getRatingFromScore

Retrieve the rating with the specified score.

POST http://domain:port/clearspace_context/rpc/rest/ratingsService/ratingFromScore/{score}

Parameters

score: the score of the rating to retrieve

Parameters Template

<getRatingFromScore> 
    <score>xs:int</score>
</getRatingFromScore>

Return Value Template

<getRatingFromScoreResponse> 
    <return>
        <!-- Contents of Rating -->
    <return>
</getRatingFromScoreResponse>

getRatings

Returns an Iterable of all the ratings given to the .

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/{objectType}/{objectID}

Parameters

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

Parameters Template

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

Return Value Template

<getRatingsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Rating -->
    <return>
</getRatingsResponse>

hasRated

Returns whether the user has rated the or not. This method will always return false if the user is anonymous.

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/objectRatings/userHasRated/{objectType}/{objectID}

Parameters

userID: of the user to check

objectType: the ()} to return ratings for

objectID: the ()} to return ratings for

Parameters Template

<hasRated> 
    <userID>xs:long</userID>
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
</hasRated>

Return Value Template

<hasRatedResponse> 
    <return>xs:boolean</return>
</hasRatedResponse>

isRatingsEnabled

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

GET http://domain:port/clearspace_context/rpc/rest/ratingsService/ratingsEnabled

Return Value Template

<isRatingsEnabledResponse> 
    <return>xs:boolean</return>
</isRatingsEnabledResponse>

removeRating

Remove the specified rating from the list of currently available ratings.

DELETE http://domain:port/clearspace_context/rpc/rest/ratingsService/ratings/{score}

setRatingsEnabled

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

POST http://domain:port/clearspace_context/rpc/rest/ratingsService/ratingsEnabled

referenceService

Manager used to create references between different kind of jive objects.

References are use to create a relationship between one kind of jive object to another. For instance a blog may reference a specific thread.

Method	Description
addReference	Creates a reference between the refering object and the references.
deleteAllReferences	Removes all references from the specified referer.
deleteAllReferers	Causes this object to not be referred by any other objects.
deleteReference	Delete the reference between a referer and the refered content.
getReferences	Get all objects that the specfied jiveObject referers too.
getReferers	Get a list of all the objects that refer to this specified object.

addReference

Creates a reference between the refering object and the references.

POST http://domain:port/clearspace_context/rpc/rest/referenceService/references

Parameters

referer: The object that will refer to references.

reference

Parameters Template

<addReference> 
    <referer>
        <!-- Contents of JiveObject -->
    <referer>
    <reference>
        <!-- Contents of JiveObject -->
    <reference>
</addReference>

deleteAllReferences

Removes all references from the specified referer.

DELETE http://domain:port/clearspace_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}

Parameters

refererObjectType: The referer's object type.

refererObjectID: The id of the referer.

Parameters Template

<deleteAllReferences> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
</deleteAllReferences>

deleteAllReferers

Causes this object to not be referred by any other objects.

DELETE http://domain:port/clearspace_context/rpc/rest/referenceService/referers/{referenceObjectType}/{referenceObjectID}

Parameters

referenceObjectType: The object Type of the reference.

referenceObjectID: The object id of the reference.

Parameters Template

<deleteAllReferers> 
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</deleteAllReferers>

deleteReference

Delete the reference between a referer and the refered content.

DELETE http://domain:port/clearspace_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}/{referenceObjectType}/{referenceObjectID}

Parameters

refererObjectType: The referer's object type.

refererObjectID: The id of the referer.

referenceObjectType: The object Type of the reference.

referenceObjectID: The object id of the reference.

Parameters Template

<deleteReference> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</deleteReference>

getReferences

Get all objects that the specfied jiveObject referers too.

GET http://domain:port/clearspace_context/rpc/rest/referenceService/references/{refererObjectType}/{refererObjectID}

Parameters

refererObjectType: The referer's object type.

refererObjectID: The id of the referer.

Parameters Template

<getReferences> 
    <refererObjectType>xs:int</refererObjectType>
    <refererObjectID>xs:long</refererObjectID>
</getReferences>

Return Value Template

<getReferencesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</getReferencesResponse>

getReferers

Get a list of all the objects that refer to this specified object.

GET http://domain:port/clearspace_context/rpc/rest/referenceService/referers/{referenceObjectType}/{referenceObjectID}

Parameters

referenceObjectType: The object Type of the reference.

referenceObjectID: The object id of the reference.

Parameters Template

<getReferers> 
    <referenceObjectType>xs:int</referenceObjectType>
    <referenceObjectID>xs:long</referenceObjectID>
</getReferers>

Return Value Template

<getReferersResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</getReferersResponse>

searchService

Provides the ability to search for content.

Method	Description
countQuickMessageSearchResultsByCommunityID	Returns the number of possible results for the specified query.
countQuickSearchResults	Returns the number of possible results for the specified query.
countSearchResults	Returns the number of possible results for the specified query.
countSearchResultsByCommunityID	Returns the number of possible results for the specified query by category.
quickMessageSearchByCommunityID	Provides the ability to do quick search queries based on the provided string.
quickSearch	Provides the ability to do quick search queries based on the provided string.
search	Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.
searchByCommunities	Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

countQuickMessageSearchResultsByCommunityID

Returns the number of possible results for the specified query.

GET http://domain:port/clearspace_context/rpc/rest/searchService/communitySearchCount/{communityID}/{query}/{contentTypes}

Return Value Template

<countQuickMessageSearchResultsByCommunityIDResponse> 
    <return>xs:int</return>
</countQuickMessageSearchResultsByCommunityIDResponse>

countQuickSearchResults

Returns the number of possible results for the specified query.

GET http://domain:port/clearspace_context/rpc/rest/searchService/searchCount

Parameters

query: The query to find the number of results for.

contentTypes: an array of jive content types

Parameters Template

<countQuickSearchResults> 
    <query>xs:string</query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countQuickSearchResults>

Return Value Template

<countQuickSearchResultsResponse> 
    <return>xs:int</return>
</countQuickSearchResultsResponse>

countSearchResults

Returns the number of possible results for the specified query.

POST http://domain:port/clearspace_context/rpc/rest/searchService/searchCount

Parameters

query: The query to find the number of results for.

contentTypes: an array of jive content types

Parameters Template

<countSearchResults> 
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countSearchResults>

Return Value Template

<countSearchResultsResponse> 
    <return>xs:int</return>
</countSearchResultsResponse>

countSearchResultsByCommunityID

Returns the number of possible results for the specified query by category.

POST http://domain:port/clearspace_context/rpc/rest/searchService/communitySearchCount

Parameters

communityID: The id of the category.

query: The query to find the number of results for.

contentTypes: an array of jive content types

Parameters Template

<countSearchResultsByCommunityID> 
    <communityID>xs:long</communityID>
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
</countSearchResultsByCommunityID>

Return Value Template

<countSearchResultsByCommunityIDResponse> 
    <return>xs:int</return>
</countSearchResultsByCommunityIDResponse>

quickMessageSearchByCommunityID

Provides the ability to do quick search queries based on the provided string.

GET http://domain:port/clearspace_context/rpc/rest/searchService/communitySearch/{communityID}/{query}/{contentTypes}/{startIndex}/{numResults}

Return Value Template

<quickMessageSearchByCommunityIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</quickMessageSearchByCommunityIDResponse>

quickSearch

Provides the ability to do quick search queries based on the provided string.

GET http://domain:port/clearspace_context/rpc/rest/searchService/search

Parameters

query: The query string.

contentTypes: an array of jive content types

startIndex: Starting point of results to grab.

numResults: Ending point of results to grab. @return An array of message IDs.

Parameters Template

<quickSearch> 
    <query>xs:string</query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</quickSearch>

Return Value Template

<quickSearchResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</quickSearchResponse>

search

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.

POST http://domain:port/clearspace_context/rpc/rest/searchService/search

Parameters

query: The query objects.

contentTypes: an array of jive content types

startIndex: Starting point of results to grab.

numResults: Ending point of results to grab.

Parameters Template

<search> 
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</search>

Return Value Template

<searchResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</searchResponse>

searchByCommunities

Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.

POST http://domain:port/clearspace_context/rpc/rest/searchService/communitySearch

Parameters

communityID: The id of the category

query: The query objects.

contentTypes: an array of jive content types

startIndex: Starting point of results to grab.

numResults: Ending point of results to grab. @return An array of message IDs.

Parameters Template

<searchByCommunities> 
    <communityID>xs:long</communityID>
    <query>
        <!-- Contents of Query -->
    <query>
    <!-- List of ... -->
    <contentTypes>xs:int</contentTypes>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</searchByCommunities>

Return Value Template

<searchByCommunitiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of JiveObject -->
    <return>
</searchByCommunitiesResponse>

statusLevelService

Manages status level feature. StatusLevel levels allow the system to rank users by points or associate users with a specific group.

Method	Description
addPoints	Rewards points to a user.
createStatusLevel	Creates a new points based StatusLevel.
createStatusLevel	Creates a new group based StatusLevel Level
deleteStatusLevel	Deletes a statusLevel level from the system
getAllStatusLevelScenarios	Returns all of the objects.
getGroupStatusLevel	If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.
getGroupStatusLevels	Returns an array of all group based status levels in the system.
getLeaders	Returns an array of system wide leaders.
getLeaders	Returns an array of system wide leaders.
getLeaders	Returns an Iterable of leaders for a specific community
getLeaders	Returns an Iterable of leaders for a specific community
getPointLevel	Returns the point level for a user system wide.
getPointLevel	Returns the status level points for a user in regards to a specific community
getPointStatusLevels	Returns an array of point based status levels in the system sorted by point range.
getStatusLevel	Used to acquire a specific status level object from the system
getStatusLevelByPoints	Used to get a status level by a point value.
getStatusLevelScenarioByCode	Returns a by its code.
getUserStatusLevel	Returns the system wide status level for specific user, will return null if there is no status level for this user.
isStatusLevelsEnabled	Returns true if status levels are enabled in the system
setStatusLevelsEnabled	Sets whether status levels should be enabled in the system.
updateStatusLevelScenario	Update the points and whether or not this scenario is included in status level results.

addPoints

Rewards points to a user. By providing the object and a reason we can tell which object the user is be rewarded on and a code explaining why.

Note that it is valid to submit negative point values to remove points from a user.

POST http://domain:port/clearspace_context/rpc/rest/statusLevelService/addPoints

Parameters

userID: The ID of the user who is receiving points.

communityID: The ID of the community the points are added to.

objectID: The ID of the object the user should receive points on.

objectType: Amount of points to award the user.

points: A code explaining why the user is receiving points.

code: The objectType of the object to add points for.

Parameters Template

<addPoints> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
    <objectID>xs:long</objectID>
    <objectType>xs:int</objectType>
    <points>xs:long</points>
    <code>xs:string</code>
</addPoints>

createStatusLevel

Creates a new points based StatusLevel. The minPoints and maxPoints range must not intersect, and maxPoints cannot be zero. Specify -1 in either to denote a boundless range (ie minPoints=50, maxPoints=-1 would mean everything over 50 has this status level)

The minPoints and maxPoints values must not go into the range over another StatusLevel levels point range.

POST http://domain:port/clearspace_context/rpc/rest/statusLevelService/pointStatusLevels

Parameters

name: name of the status level

imagePath: The path the image used when displaying this status level.

minPoints: minimum amount in the point range

maxPoints: maximum amount in the point range

Parameters Template

<createStatusLevel> 
    <name>xs:string</name>
    <imagePath>xs:string</imagePath>
    <minPoints>xs:int</minPoints>
    <maxPoints>xs:int</maxPoints>
</createStatusLevel>

Return Value Template

<createStatusLevelResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</createStatusLevelResponse>

createStatusLevel

Creates a new group based StatusLevel Level

POST http://domain:port/clearspace_context/rpc/rest/statusLevelService/groupStatusLevels

Parameters

name: name of the status level

imagePath: The path the image used when displaying this status level.

groupID: ID of the group to associate this status level with

Parameters Template

<createStatusLevel> 
    <name>xs:string</name>
    <imagePath>xs:string</imagePath>
    <groupID>xs:long</groupID>
</createStatusLevel>

Return Value Template

<createStatusLevelResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</createStatusLevelResponse>

deleteStatusLevel

Deletes a statusLevel level from the system

DELETE http://domain:port/clearspace_context/rpc/rest/statusLevelService/statusLevels/{statusLevelID}

Parameters

statusLevelID: ID of the statusLevel level to delete

Parameters Template

<deleteStatusLevel> 
    <statusLevelID>xs:long</statusLevelID>
</deleteStatusLevel>

getAllStatusLevelScenarios

Returns all of the objects.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/scenarios

Return Value Template

<getAllStatusLevelScenariosResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of StatusLevelScenario -->
    <return>
</getAllStatusLevelScenariosResponse>

getGroupStatusLevel

If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/groupStatusLevels/{groupID}

Parameters

groupID: ID of the group to find a status level for

Parameters Template

<getGroupStatusLevel> 
    <groupID>xs:long</groupID>
</getGroupStatusLevel>

Return Value Template

<getGroupStatusLevelResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getGroupStatusLevelResponse>

getGroupStatusLevels

Returns an array of all group based status levels in the system.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/groupStatusLevels

Return Value Template

<getGroupStatusLevelsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getGroupStatusLevelsResponse>

getLeaders

Returns an array of system wide leaders.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/leaders

Return Value Template

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

getLeaders

Returns an array of system wide leaders.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/leaders/{startIndex}/{numResults}

Parameters

startIndex: The starting point of the results.

numResults: The number of results to return in the array.

Parameters Template

<getLeaders> 
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</getLeaders>

Return Value Template

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

getLeaders

Returns an Iterable of leaders for a specific community

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/leadersByCommunity/{communityID}

Parameters

communityID: ID of the community to find leaders for.

Parameters Template

<getLeaders> 
    <communityID>xs:long</communityID>
</getLeaders>

Return Value Template

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

getLeaders

Returns an Iterable of leaders for a specific community

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/leadersByCommunity/{communityID}/{startIndex}/{numResults}

Parameters

communityID: ID of the community to find leaders for

startIndex: The starting point of the leader results.

numResults: The number of results in the array.

Parameters Template

<getLeaders> 
    <communityID>xs:long</communityID>
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</getLeaders>

Return Value Template

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

getPointLevel

Returns the point level for a user system wide.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/pointLevel/{userID}

Parameters

userID: ID of the user to get status level points for

Parameters Template

<getPointLevel> 
    <userID>xs:long</userID>
</getPointLevel>

Return Value Template

<getPointLevelResponse> 
    <return>xs:long</return>
</getPointLevelResponse>

getPointLevel

Returns the status level points for a user in regards to a specific community

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/pointLevel/{userID}/{communityID}

Parameters

userID: ID of the user to get status level points for

communityID: ID of the community to filter by

Parameters Template

<getPointLevel> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</getPointLevel>

Return Value Template

<getPointLevelResponse> 
    <return>xs:long</return>
</getPointLevelResponse>

getPointStatusLevels

Returns an array of point based status levels in the system sorted by point range.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/pointStatusLevels

Return Value Template

<getPointStatusLevelsResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getPointStatusLevelsResponse>

getStatusLevel

Used to acquire a specific status level object from the system

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/statusLevels/{statusLevelID}

Parameters

statusLevelID: the id of the object to acquire

Parameters Template

<getStatusLevel> 
    <statusLevelID>xs:long</statusLevelID>
</getStatusLevel>

Return Value Template

<getStatusLevelResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getStatusLevelResponse>

getStatusLevelByPoints

Used to get a status level by a point value. If the points exceeds that of the maximum status level, the maximum status level will be returned.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/statusLevelByPoints/{points}

Parameters

points: point value find a status level for

Parameters Template

<getStatusLevelByPoints> 
    <points>xs:long</points>
</getStatusLevelByPoints>

Return Value Template

<getStatusLevelByPointsResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getStatusLevelByPointsResponse>

getStatusLevelScenarioByCode

Returns a by its code.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/scenarios/{code}

Parameters

code: The code of the StatusLevelScenario.

Parameters Template

<getStatusLevelScenarioByCode> 
    <code>xs:string</code>
</getStatusLevelScenarioByCode>

Return Value Template

<getStatusLevelScenarioByCodeResponse> 
    <return>
        <!-- Contents of StatusLevelScenario -->
    <return>
</getStatusLevelScenarioByCodeResponse>

getUserStatusLevel

Returns the system wide status level for specific user, will return null if there is no status level for this user.

If the user belongs to a group status level the group status level will always be returned.

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/userStatusLevels/{userID}

Parameters

userID: IDof the user to find the status level for

Parameters Template

<getUserStatusLevel> 
    <userID>xs:long</userID>
</getUserStatusLevel>

Return Value Template

<getUserStatusLevelResponse> 
    <return>
        <!-- Contents of StatusLevel -->
    <return>
</getUserStatusLevelResponse>

isStatusLevelsEnabled

Returns true if status levels are enabled in the system

GET http://domain:port/clearspace_context/rpc/rest/statusLevelService/statusLevelsEnabled

Return Value Template

<isStatusLevelsEnabledResponse> 
    <return>xs:boolean</return>
</isStatusLevelsEnabledResponse>

setStatusLevelsEnabled

Sets whether status levels should be enabled in the system.

POST http://domain:port/clearspace_context/rpc/rest/statusLevelService/statusLevelsEnabled

Parameters

statusLevelsEnabled: true if status levels are statusLevelsEnabled, else false

Parameters Template

<setStatusLevelsEnabled> 
    <statusLevelsEnabled>xs:boolean</statusLevelsEnabled>
</setStatusLevelsEnabled>

updateStatusLevelScenario

Update the points and whether or not this scenario is included in status level results.

PUT http://domain:port/clearspace_context/rpc/rest/statusLevelService/scenarios

Parameters

scenario: the points and whether or not this scenario is included in status level results.

Parameters Template

<updateStatusLevelScenario> 
    <scenario>
        <!-- Contents of StatusLevelScenario -->
    <scenario>
</updateStatusLevelScenario>

systemPropertiesService

Provides a web service for managing Jive System Properties.

Method	Description
deleteProperty	Deletes a Jive System Property.
getProperties	Obtains all Jive System Properties.
saveProperty	Saves a name/value pair as a Jive System Property.

deleteProperty

Deletes a Jive System Property.

DELETE http://domain:port/clearspace_context/rpc/rest/systemPropertiesService/properties/{name}

Parameters

name: the property to delete.

Parameters Template

<deleteProperty> 
    <name>xs:string</name>
</deleteProperty>

getProperties

Obtains all Jive System Properties.

GET http://domain:port/clearspace_context/rpc/rest/systemPropertiesService/properties

Return Value Template

<getPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getPropertiesResponse>

saveProperty

Saves a name/value pair as a Jive System Property.

POST http://domain:port/clearspace_context/rpc/rest/systemPropertiesService/properties

Parameters

name: the name of the property to set.

value: the value of the property to set.

Parameters Template

<saveProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
</saveProperty>

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/clearspace_context/rpc/rest/tagService/objectTags

Parameters

tag: The object to add a tag for.

jiveObject: The tag, must be the unfiltered value.

Parameters Template

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

createTag

Creates a tag in the database.

POST http://domain:port/clearspace_context/rpc/rest/tagService/tags/{tagname}

Parameters

tagname: the name of the tag to create.

Parameters Template

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

Return Value Template

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

getTagByID

Returns a tag given a tag ID.

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

Parameters

tagID: The id of the tag.

Parameters Template

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

Return Value Template

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

getTagByName

Returns a tag by tag name.

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

Parameters

tagname: the name of the tag to lookup.

Parameters Template

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

Return Value Template

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

getTags

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

GET http://domain:port/clearspace_context/rpc/rest/tagService/objectTags/{id}/{objectType}

Parameters

jiveObject: Tags to acquire.

Parameters Template

<getTags> 
    <jiveObject>
        <!-- Contents of JiveObject -->
    <jiveObject>
</getTags>

Return Value Template

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

removeAllTags

Disassociates this object with all tags.

DELETE http://domain:port/clearspace_context/rpc/rest/tagService/removeAllTags/{id}/{objectType}

removeTag

Disassociates this object with the given tag.

DELETE http://domain:port/clearspace_context/rpc/rest/tagService/objectTags/{tag}/{id}/{objectType}

Parameters

tag: The jive Object to remove a tag for.

jiveObject: The tag, must be the unfiltered value.

Parameters Template

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

taskService

Method	Description
create
createPersonalTask
delete
getTaskCount
getTaskCountWithFilter
getTaskbyID
getTasks
getTasksByProject
getTasksWithFilter
getUncompleteTasksByUserID
update

create

POST http://domain:port/clearspace_context/rpc/rest/taskService/tasks

Parameters

projectID

creatorID

ownerID

subject

body

dueDate

Parameters Template

<create> 
    <projectID>xs:long</projectID>
    <creatorID>xs:long</creatorID>
    <ownerID>xs:long</ownerID>
    <subject>xs:string</subject>
    <body>xs:string</body>
    <dueDate>xs:dateTime</dueDate>
</create>

Return Value Template

<createResponse> 
    <return>
        <!-- Contents of Task -->
    <return>
</createResponse>

createPersonalTask

POST http://domain:port/clearspace_context/rpc/rest/taskService/personalTasks

Parameters

userID

subject

body

dueDate

Parameters Template

<createPersonalTask> 
    <userID>xs:long</userID>
    <subject>xs:string</subject>
    <body>xs:string</body>
    <dueDate>xs:dateTime</dueDate>
</createPersonalTask>

Return Value Template

<createPersonalTaskResponse> 
    <return>
        <!-- Contents of Task -->
    <return>
</createPersonalTaskResponse>

delete

DELETE http://domain:port/clearspace_context/rpc/rest/taskService/tasks/{taskID}

Parameters

taskID

Parameters Template

<delete> 
    <taskID>xs:long</taskID>
</delete>

getTaskCount

GET http://domain:port/clearspace_context/rpc/rest/taskService/taskCount

Return Value Template

<getTaskCountResponse> 
    <return>xs:int</return>
</getTaskCountResponse>

getTaskCountWithFilter

POST http://domain:port/clearspace_context/rpc/rest/taskService/taskCount

Parameters

filter

Parameters Template

<getTaskCountWithFilter> 
    <filter>
        <!-- Contents of TaskResultFilter -->
    <filter>
</getTaskCountWithFilter>

Return Value Template

<getTaskCountWithFilterResponse> 
    <return>xs:int</return>
</getTaskCountWithFilterResponse>

getTaskbyID

GET http://domain:port/clearspace_context/rpc/rest/taskService/tasks/{taskID}

Parameters

taskID

Parameters Template

<getTaskbyID> 
    <taskID>xs:long</taskID>
</getTaskbyID>

Return Value Template

<getTaskbyIDResponse> 
    <return>
        <!-- Contents of Task -->
    <return>
</getTaskbyIDResponse>

getTasks

GET http://domain:port/clearspace_context/rpc/rest/taskService/tasks

Return Value Template

<getTasksResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Task -->
    <return>
</getTasksResponse>

getTasksByProject

GET http://domain:port/clearspace_context/rpc/rest/taskService/tasksByProject/{projectID}

Parameters

projectID

Parameters Template

<getTasksByProject> 
    <projectID>xs:long</projectID>
</getTasksByProject>

Return Value Template

<getTasksByProjectResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Task -->
    <return>
</getTasksByProjectResponse>

getTasksWithFilter

POST http://domain:port/clearspace_context/rpc/rest/taskService/tasksWithFilter

Parameters

filter

Parameters Template

<getTasksWithFilter> 
    <filter>
        <!-- Contents of TaskResultFilter -->
    <filter>
</getTasksWithFilter>

Return Value Template

<getTasksWithFilterResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Task -->
    <return>
</getTasksWithFilterResponse>

getUncompleteTasksByUserID

GET http://domain:port/clearspace_context/rpc/rest/taskService/tasksByUserID/{userID}

Parameters

userID

Parameters Template

<getUncompleteTasksByUserID> 
    <userID>xs:long</userID>
</getUncompleteTasksByUserID>

Return Value Template

<getUncompleteTasksByUserIDResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Task -->
    <return>
</getUncompleteTasksByUserIDResponse>

update

PUT http://domain:port/clearspace_context/rpc/rest/taskService/tasks

Parameters

task

Parameters Template

<update> 
    <task>
        <!-- Contents of Task -->
    <task>
</update>

userService

Provides a webservice for managing user's, avatar's, and status levels.

For soap services this service can be accessed at /rpc/soap/UserService For rest services this service can be accessed at /rpc/rest/users

Method	Description
createUser	Create a new user.
createUserWithUser	Create a new user.
deleteUser	Delete the user with the specified id.
deleteUserProperty	Delete an extended property from a user.
disableUser	Used to disable a user.
enableUser	Used to enable a user.
getUser	Returns a user by its id.
getUserByEmailAddress	Returns a user object corresponding to the email address given.
getUserByUsername	Returns a user by its username.
getUserCount	Returns the number of users in the system.
getUserNames	Returns the names of the all users names.
getUserProperties	Return all extended properties for the user with the specified id.
getUsers	Returns the IDs of the first 1000 users.
getUsersBounded	Returns the IDs of users begining at startIndex and until the number results equals numResults.
isReadOnly	Returns true if this UserService is read-only.
setPassword	Used to change a user's password.
setUserProperty	Set an extended property for a user.
updateUser	Used to update user information in the system.

createUser

Create a new user.

POST http://domain:port/clearspace_context/rpc/rest/userService/users/create

Parameters

username: The name of user.

password: The password for the user.

email: The email address of the user.

Parameters Template

<createUser> 
    <username>xs:string</username>
    <password>xs:string</password>
    <email>xs:string</email>
</createUser>

Return Value Template

<createUserResponse> 
    <return>
        <!-- Contents of User -->
    <return>
</createUserResponse>

createUserWithUser

Create a new user. The id field is ignored, after creation the user object returned will have the correct user id.

POST http://domain:port/clearspace_context/rpc/rest/userService/users

Parameters

user: The user to create.

Parameters Template

<createUserWithUser> 
    <user>
        <!-- Contents of User -->
    <user>
</createUserWithUser>

Return Value Template

<createUserWithUserResponse> 
    <return>
        <!-- Contents of User -->
    <return>
</createUserWithUserResponse>

deleteUser

Delete the user with the specified id.

DELETE http://domain:port/clearspace_context/rpc/rest/userService/users/{userID}

Parameters

userID: The id of the user to delete.

Parameters Template

<deleteUser> 
    <userID>xs:long</userID>
</deleteUser>

deleteUserProperty

Delete an extended property from a user.

DELETE http://domain:port/clearspace_context/rpc/rest/userService/properties/{userID}/{name}

Parameters

name: Name of the extended property to delete.

userID: The id of the user to delete the extended property from.

Parameters Template

<deleteUserProperty> 
    <name>xs:string</name>
    <userID>xs:long</userID>
</deleteUserProperty>

disableUser

Used to disable a user.

PUT http://domain:port/clearspace_context/rpc/rest/userService/enable

Parameters

userID: The id of the user to disable.

Parameters Template

<disableUser> 
    <userID>xs:long</userID>
</disableUser>

enableUser

Used to enable a user.

PUT http://domain:port/clearspace_context/rpc/rest/userService/disable

Parameters

userID: The id of the user to enable.

Parameters Template

<enableUser> 
    <userID>xs:long</userID>
</enableUser>

getUser

Returns a user by its id.

GET http://domain:port/clearspace_context/rpc/rest/userService/usersByID/{userID}

Parameters

userID: The id of the user.

Parameters Template

<getUser> 
    <userID>xs:long</userID>
</getUser>

Return Value Template

<getUserResponse> 
    <return>
        <!-- Contents of User -->
    <return>
</getUserResponse>

getUserByEmailAddress

Returns a user object corresponding to the email address given.

GET http://domain:port/clearspace_context/rpc/rest/userService/usersByEmail/{emailAddress}

Parameters

emailAddress: The email address of the user.

Parameters Template

<getUserByEmailAddress> 
    <emailAddress>xs:string</emailAddress>
</getUserByEmailAddress>

Return Value Template

<getUserByEmailAddressResponse> 
    <return>
        <!-- Contents of User -->
    <return>
</getUserByEmailAddressResponse>

getUserByUsername

Returns a user by its username.

GET http://domain:port/clearspace_context/rpc/rest/userService/users/{username}

Parameters

username: The username of the user.

Parameters Template

<getUserByUsername> 
    <username>xs:string</username>
</getUserByUsername>

Return Value Template

<getUserByUsernameResponse> 
    <return>
        <!-- Contents of User -->
    <return>
</getUserByUsernameResponse>

getUserCount

Returns the number of users in the system.

GET http://domain:port/clearspace_context/rpc/rest/userService/users/count

Return Value Template

<getUserCountResponse> 
    <return>xs:int</return>
</getUserCountResponse>

getUserNames

Returns the names of the all users names.

GET http://domain:port/clearspace_context/rpc/rest/userService/userNames

Return Value Template

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

getUserProperties

Return all extended properties for the user with the specified id.

GET http://domain:port/clearspace_context/rpc/rest/userService/properties/{userID}

Parameters

userID: The user's id.

Parameters Template

<getUserProperties> 
    <userID>xs:long</userID>
</getUserProperties>

Return Value Template

<getUserPropertiesResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Property -->
    <return>
</getUserPropertiesResponse>

getUsers

Returns the IDs of the first 1000 users.

GET http://domain:port/clearspace_context/rpc/rest/userService/users

Return Value Template

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

getUsersBounded

Returns the IDs of users begining at startIndex and until the number results equals numResults.

GET http://domain:port/clearspace_context/rpc/rest/userService/usersBounded/{startIndex}/{numResults}

Parameters

startIndex: The startIndex to grab results from.

numResults: The total number of results to be returned.

Parameters Template

<getUsersBounded> 
    <startIndex>xs:int</startIndex>
    <numResults>xs:int</numResults>
</getUsersBounded>

Return Value Template

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

isReadOnly

Returns true if this UserService is read-only. When read-only, users can not be created, deleted, or modified.

GET http://domain:port/clearspace_context/rpc/rest/userService/isReadOnly

Return Value Template

<isReadOnlyResponse> 
    <return>xs:boolean</return>
</isReadOnlyResponse>

setPassword

Used to change a user's password.

PUT http://domain:port/clearspace_context/rpc/rest/userService/password

Parameters

userID: The id of the user to change the password for.

password: The new password in plain text.

Parameters Template

<setPassword> 
    <userID>xs:long</userID>
    <password>xs:string</password>
</setPassword>

setUserProperty

Set an extended property for a user.

POST http://domain:port/clearspace_context/rpc/rest/userService/properties

Parameters

name: The name of the extended property.

value: The value of the extended property.

userID: The user to set an extended property for.

Parameters Template

<setUserProperty> 
    <name>xs:string</name>
    <value>xs:string</value>
    <userID>xs:long</userID>
</setUserProperty>

updateUser

Used to update user information in the system.

PUT http://domain:port/clearspace_context/rpc/rest/userService/users

Parameters

user: User information to update.

Parameters Template

<updateUser> 
    <user>
        <!-- Contents of User -->
    <user>
</updateUser>

watchService

A service for manipulating a user's watches on objects.

Method	Description
createCommunityWatch	Create a watch on a community for the specified user.
createThreadWatch	Create a watch on a thread for the specified user.
createUserWatch	Create a watch on a user for the specified user.
deleteWatch	Delete the specified watch.
deleteWatches	Deletes all watches that a user has.
getCommunityWatch	Returns a watch on a particular community, or null if there isn't a watch.
getCommunityWatchCount	Return the count of all community watches in a particular communityID for the given userID.
getCommunityWatches	Returns an array of IDs for all the community objects a user is watching in a community.
getDeleteDays	Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
getThreadWatch	Returns a watch on a particular thread, or null if there isn't a watch.
getTotalWatchCount	Returns a count of all watches that a userID has of a particular type.
getUserWatch	Returns a watch on a particular user, or null if there isn't a watch.
getWatchList	Returns an array of Watch objects for a particular object type that the given user is watching.
getWatchUsers	Returns all the users who are watching this objectType and objectID.
isCommunityWatched	Returns true if the user is watching the specified community.
isThreadWatched	Returns true if the user is watching the specified thread.
isUserWatched	Returns true if the user is watching the specified user.
setDeleteDays	Sets the number of days that a watched object can remain inactive before watches on that object are deleted.

createCommunityWatch

Create a watch on a community for the specified user.

POST http://domain:port/clearspace_context/rpc/rest/watchService/communityWatches

Parameters

userID: The ID of the user to set the watch for.

communityID: The ID of the community to watch.

Parameters Template

<createCommunityWatch> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</createCommunityWatch>

Return Value Template

<createCommunityWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</createCommunityWatchResponse>

createThreadWatch

Create a watch on a thread for the specified user.

POST http://domain:port/clearspace_context/rpc/rest/watchService/threadWatches

Parameters

userID: The ID of the user to set the watch for.

threadID: The ID of thread to watch.

Parameters Template

<createThreadWatch> 
    <userID>xs:long</userID>
    <threadID>xs:long</threadID>
</createThreadWatch>

Return Value Template

<createThreadWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</createThreadWatchResponse>

createUserWatch

Create a watch on a user for the specified user.

POST http://domain:port/clearspace_context/rpc/rest/watchService/userWatches

Parameters

userID: The ID of the user to set the watch for.

watchedUserID: The ID of the user to watch.

Parameters Template

<createUserWatch> 
    <userID>xs:long</userID>
    <watchedUserID>xs:long</watchedUserID>
</createUserWatch>

Return Value Template

<createUserWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</createUserWatchResponse>

deleteWatch

Delete the specified watch.

DELETE http://domain:port/clearspace_context/rpc/rest/watchService/watches/{userID}/{objectID}/{objectType}

Parameters

watch: The watch to delete.

Parameters Template

<deleteWatch> 
    <watch>
        <!-- Contents of Watch -->
    <watch>
</deleteWatch>

deleteWatches

Deletes all watches that a user has.

DELETE http://domain:port/clearspace_context/rpc/rest/watchService/users/{userID}

Parameters

userID: The ID of the user.

Parameters Template

<deleteWatches> 
    <userID>xs:long</userID>
</deleteWatches>

getCommunityWatch

Returns a watch on a particular community, or null if there isn't a watch.

GET http://domain:port/clearspace_context/rpc/rest/watchService/communityWatches/{userID}/{communityID}

Parameters

userID: The ID of the user to acquire a watch for.

communityID: The ID of the community to acquire the watch for.

Parameters Template

<getCommunityWatch> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</getCommunityWatch>

Return Value Template

<getCommunityWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</getCommunityWatchResponse>

getCommunityWatchCount

Return the count of all community watches in a particular communityID for the given userID.

GET http://domain:port/clearspace_context/rpc/rest/watchService/communityWatches/count/{userID}/{communityID}

Parameters

userID: The userID to return the watch count for.

communityID: The communityID to return the watch count for.

Parameters Template

<getCommunityWatchCount> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</getCommunityWatchCount>

Return Value Template

<getCommunityWatchCountResponse> 
    <return>xs:int</return>
</getCommunityWatchCountResponse>

getCommunityWatches

Returns an array of IDs for all the community objects a user is watching in a community.

GET http://domain:port/clearspace_context/rpc/rest/watchService/allCommunityWatches/{userID}/{communityID}

Parameters

userID: The ID of the user.

communityID: The ID of the community.

Parameters Template

<getCommunityWatches> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</getCommunityWatches>

Return Value Template

<getCommunityWatchesResponse> 
    <!-- List of ... -->
    <return>xs:long</return>
</getCommunityWatchesResponse>

getDeleteDays

Returns the number of days that a watched object can remain inactive before watches on that object are deleted.

GET http://domain:port/clearspace_context/rpc/rest/watchService/deleteDays

Return Value Template

<getDeleteDaysResponse> 
    <return>xs:int</return>
</getDeleteDaysResponse>

getThreadWatch

Returns a watch on a particular thread, or null if there isn't a watch.

GET http://domain:port/clearspace_context/rpc/rest/watchService/threadWatches/{userID}/{threadID}

Parameters

userID: The ID of the user with the watch.

threadID: The ID of the thread being watched.

Parameters Template

<getThreadWatch> 
    <userID>xs:long</userID>
    <threadID>xs:long</threadID>
</getThreadWatch>

Return Value Template

<getThreadWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</getThreadWatchResponse>

getTotalWatchCount

Returns a count of all watches that a userID has of a particular type. Valid object types are:

GET http://domain:port/clearspace_context/rpc/rest/watchService/watches/count/{userID}/{objectType}

Parameters

userID: The ID of the user to get the watch count for.

objectType: The object type to get a watch count for.

Parameters Template

<getTotalWatchCount> 
    <userID>xs:long</userID>
    <objectType>xs:int</objectType>
</getTotalWatchCount>

Return Value Template

<getTotalWatchCountResponse> 
    <return>xs:int</return>
</getTotalWatchCountResponse>

getUserWatch

Returns a watch on a particular user, or null if there isn't a watch.

GET http://domain:port/clearspace_context/rpc/rest/watchService/userWatches/{userID}/{watchedUserID}

Parameters

userID: the userID with the watch.

watchedUserID: the userID being watched.

Parameters Template

<getUserWatch> 
    <userID>xs:long</userID>
    <watchedUserID>xs:long</watchedUserID>
</getUserWatch>

Return Value Template

<getUserWatchResponse> 
    <return>
        <!-- Contents of Watch -->
    <return>
</getUserWatchResponse>

getWatchList

Returns an array of Watch objects for a particular object type that the given user is watching. Valid objectType's are:

GET http://domain:port/clearspace_context/rpc/rest/watchService/watches/{userID}/{objectType}

Parameters

userID: the userID to retrieve watches for

objectType: the object type.

Parameters Template

<getWatchList> 
    <userID>xs:long</userID>
    <objectType>xs:int</objectType>
</getWatchList>

Return Value Template

<getWatchListResponse> 
    <!-- List of ... -->
    <return>
        <!-- Contents of Watch -->
    <return>
</getWatchListResponse>

getWatchUsers

Returns all the users who are watching this objectType and objectID.

GET http://domain:port/clearspace_context/rpc/rest/watchService/users/{objectType}/{objectID}/{watchType}

Parameters

objectType: the type of object being watched.

objectID: the ID of the object being watched.

watchType: the type of watch (EMAIL, BATCH).

Parameters Template

<getWatchUsers> 
    <objectType>xs:int</objectType>
    <objectID>xs:long</objectID>
    <watchType>xs:int</watchType>
</getWatchUsers>

Return Value Template

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

isCommunityWatched

Returns true if the user is watching the specified community.

GET http://domain:port/clearspace_context/rpc/rest/watchService/isCommunityWatched/{userID}/{communityID}

Parameters

userID: The ID of the user.

communityID: The ID of the community.

Parameters Template

<isCommunityWatched> 
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
</isCommunityWatched>

Return Value Template

<isCommunityWatchedResponse> 
    <return>xs:boolean</return>
</isCommunityWatchedResponse>

isThreadWatched

Returns true if the user is watching the specified thread.

GET http://domain:port/clearspace_context/rpc/rest/watchService/isThreadWatched/{userID}/{threadID}

Parameters

userID: The ID of the user.

threadID: The ID of the thread.

Parameters Template

<isThreadWatched> 
    <userID>xs:long</userID>
    <threadID>xs:long</threadID>
</isThreadWatched>

Return Value Template

<isThreadWatchedResponse> 
    <return>xs:boolean</return>
</isThreadWatchedResponse>

isUserWatched

Returns true if the user is watching the specified user.

GET http://domain:port/clearspace_context/rpc/rest/watchService/isUserWatched/{userID}/{watchedUserID}

Parameters

userID: The ID of the user.

watchedUserID: The ID of the watched user.

Parameters Template

<isUserWatched> 
    <userID>xs:long</userID>
    <watchedUserID>xs:long</watchedUserID>
</isUserWatched>

Return Value Template

<isUserWatchedResponse> 
    <return>xs:boolean</return>
</isUserWatchedResponse>

setDeleteDays

Sets the number of days that a watched object can remain inactive before watches on that object are deleted.

POST http://domain:port/clearspace_context/rpc/rest/watchService/deleteDays

Parameters

deleteDays: The number days a watch can be inactive before being automatically deleted.

Parameters Template

<setDeleteDays> 
    <deleteDays>xs:int</deleteDays>
</setDeleteDays>

Complex Types

ApprovalStatus

Contains information on whether a user has approved a document edit and when.

Type Template

    <approved>xs:boolean</approved>
    <approvedDate>xs:dateTime</approvedDate>
    <userID>xs:long</userID>

Attachment

Type Template

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

Avatar

An object that represents a user's avatar. Avatars give a user the ability to specify an image that will be displayed alongside their username throughout the application.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <attachment>
        <!-- Contents of Attachment -->
    <attachment>
    <owner>
        <!-- Contents of User -->
    <owner>
    <properties>HashMap</properties>

BinaryBody

An object that encapsulates a binary document body. Each binary body object has a unique ID and is made up of three parts: binary data (read and written using an InputStream), a name, and content type. A binary body might have a name "technote.pfg" and corresponding content type of "application/pdf". A full listing of possible content types can be found at: ftp://ftp.iana.org/in-notes/iana/assignments/media-types/ The storage mechanism of binary body objects is controlled via the ; the default implementation puts binary body objects in the database.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <contentType>xs:string</contentType>
    <!-- List of ... -->
    <data>xs:base64Binary</data>
    <downloadCount>xs:int</downloadCount>
    <name>xs:string</name>
    <size>xs:long</size>

Blog

A container for a list of blog postings by a user or group of users. Every blog is associated with one or more users and contains a name and a short description. Each blog can have an arbitrary number of extended properties, which allow extra data about the blog to be stored.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <!-- List of ... -->
    <allBlogPostIDs>Long</allBlogPostIDs>
    <blogPostCount>xs:int</blogPostCount>
    <commentAuthenticationStrategy>xs:int</commentAuthenticationStrategy>
    <commentCount>xs:int</commentCount>
    <commentModerationEnabled>xs:boolean</commentModerationEnabled>
    <commentNotificationEnabled>xs:boolean</commentNotificationEnabled>
    <containerBlog>xs:boolean</containerBlog>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <displayName>xs:string</displayName>
    <feedEnabled>xs:boolean</feedEnabled>
    <feedFullContent>xs:boolean</feedFullContent>
    <firstPostID>xs:long</firstPostID>
    <lastPostID>xs:long</lastPostID>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <overridePing>xs:boolean</overridePing>
    <pingServices>xs:string</pingServices>
    <!-- List of ... -->
    <popularTags>
        <!-- Contents of TagCount -->
    <popularTags>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <!-- List of ... -->
    <recentBlogPostIDs>Long</recentBlogPostIDs>
    <!-- List of ... -->
    <recentCommentIDs>Long</recentCommentIDs>
    <!-- List of ... -->
    <tags>
        <!-- Contents of TagCount -->
    <tags>
    <trackbackCount>xs:int</trackbackCount>
    <trackbackModerationEnabled>xs:boolean</trackbackModerationEnabled>
    <trackbackNotificationEnabled>xs:boolean</trackbackNotificationEnabled>
    <userCount>xs:int</userCount>
    <!-- List of ... -->
    <userIDs>Long</userIDs>

BlogPost

A container for blog post data and for a hierarchy of blog comments.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <attachmentCount>xs:int</attachmentCount>
    <blogID>xs:long</blogID>
    <body>xs:string</body>
    <commentCount>xs:int</commentCount>
    <commentStatus>xs:int</commentStatus>
    <creationDate>xs:dateTime</creationDate>
    <imageCount>xs:int</imageCount>
    <modificationDate>xs:dateTime</modificationDate>
    <nextPostID>xs:long</nextPostID>
    <permalink>xs:string</permalink>
    <plainBody>xs:string</plainBody>
    <plainSubject>xs:string</plainSubject>
    <previousPostID>xs:long</previousPostID>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <publishDate>xs:dateTime</publishDate>
    <status>xs:int</status>
    <subject>xs:string</subject>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <trackbacksEnabled>xs:boolean</trackbacksEnabled>
    <unfilteredSubject>xs:string</unfilteredSubject>
    <user>
        <!-- Contents of User -->
    <user>

BlogPostResultFilter

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <blogID>xs:long</blogID>
    <onlyPublished>xs:boolean</onlyPublished>
    <publishDateRangeMax>xs:dateTime</publishDateRangeMax>
    <publishDateRangeMin>xs:dateTime</publishDateRangeMin>

BlogResultFilter

Filters and sorts s.

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <onlyCommunity>xs:boolean</onlyCommunity>
    <onlyPersonal>xs:boolean</onlyPersonal>
    <prefix>xs:string</prefix>

BlogTagResultFilter

Type Template

    <minimum>xs:int</minimum>
    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <publishDateRangeMax>xs:dateTime</publishDateRangeMax>
    <publishDateRangeMin>xs:dateTime</publishDateRangeMin>

CheckPoint

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <dueDate>xs:dateTime</dueDate>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>

Comment

Type Template

    <anonymous>xs:boolean</anonymous>
    <body>xs:string</body>
    <commentObjectID>xs:long</commentObjectID>
    <commentObjectType>xs:int</commentObjectType>
    <creationDate>xs:dateTime</creationDate>
    <email>xs:string</email>
    <ID>xs:long</ID>
    <IPAddress>xs:string</IPAddress>
    <moderated>xs:boolean</moderated>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <objectType>xs:int</objectType>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <URL>xs:string</URL>
    <user>
        <!-- Contents of User -->
    <user>

CommentResultFilter

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <communityID>xs:long</communityID>
    <includeModerated>xs:boolean</includeModerated>

Community

A container for threads and a hierarchy of other communities. In other words, the community structure is a tree, with lists of communities for every community node. There is always a "root" community (ID of 1), of which all other communities are children.

Type Template

    <!-- List of ... -->
    <availableContentTypes>xs:string</availableContentTypes>
    <!-- List of ... -->
    <contentTypes>xs:string</contentTypes>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <displayName>xs:string</displayName>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <communityCount>xs:int</communityCount>
    <communityDepth>xs:int</communityDepth>
    <finalLocale>
        <!-- Contents of Locale -->
    <finalLocale>
    <latestMessageID>xs:long</latestMessageID>
    <locale>
        <!-- Contents of Locale -->
    <locale>
    <messageCount>xs:int</messageCount>
    <parentCommunityID>xs:long</parentCommunityID>
    <recursiveCommunityCount>xs:int</recursiveCommunityCount>
    <threadCount>xs:int</threadCount>

ContentTag

Container for tags associated with a taggable object.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <creationDate>xs:dateTime</creationDate>
    <name>xs:string</name>
    <unfilteredName>xs:string</unfilteredName>

Document

A Document object encapsulates a document in the Clearspace system. Each document can belong to one or more communities and consists of document fields, attachments, images, comments, ratings, relationships and properties. The main content of a document is held within the document body(text or binary) and document fields. The body of a Document object can either be textual or binary but not both. Having the body of a document be a binary object such as a pdf can be useful in a lot of situations especially if the document was created as part of an import process. Not all aspects of a document is versioned. The only changes that will trigger a new version of a document to be created are changes to the follow: author, language, title, body (text or binary), document fields, attachments or images. To get an instance of this class use the method.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <anonymous>xs:boolean</anonymous>
    <approvalEnabled>xs:boolean</approvalEnabled>
    <attachmentCount>xs:int</attachmentCount>
    <authorCount>xs:int</authorCount>
    <body>xs:string</body>
    <commentStatus>xs:int</commentStatus>
    <containerID>xs:long</containerID>
    <containerType>xs:int</containerType>
    <creationDate>xs:dateTime</creationDate>
    <documentID>xs:string</documentID>
    <documentState>xs:string</documentState>
    <documentTypeID>xs:long</documentTypeID>
    <expirationDate>xs:dateTime</expirationDate>
    <imageCount>xs:int</imageCount>
    <language>xs:string</language>
    <modificationDate>xs:dateTime</modificationDate>
    <!-- List of ... -->
    <properties>
        <!-- Contents of Property -->
    <properties>
    <subject>xs:string</subject>
    <textBody>xs:boolean</textBody>
    <trackbacksEnabled>xs:boolean</trackbacksEnabled>
    <unfilteredSubject>xs:string</unfilteredSubject>
    <userID>xs:long</userID>

FeedbackResultFilter

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <includeModerated>xs:boolean</includeModerated>

ForumMessage

A ForumMessage encapsulates message data. Each message belongs to a thread, and relates to other messages in a thread in a tree relationship. This system allows messages to represent threaded conversations.

Type Template

    <anonymous>xs:boolean</anonymous>
    <attachmentCount>xs:int</attachmentCount>
    <body>xs:string</body>
    <creationDate>xs:dateTime</creationDate>
    <forumThreadID>xs:long</forumThreadID>
    <html>xs:boolean</html>
    <ID>xs:long</ID>
    <imageCount>xs:int</imageCount>
    <jiveContainerID>xs:long</jiveContainerID>
    <jiveContainerType>xs:int</jiveContainerType>
    <moderationValue>xs:int</moderationValue>
    <modificationDate>xs:dateTime</modificationDate>
    <parentMessageID>xs:long</parentMessageID>
    <subject>xs:string</subject>
    <unfilteredSubject>xs:string</unfilteredSubject>
    <user>
        <!-- Contents of User -->
    <user>

ForumThread

A ForumThread is a container for a hierarchy of ForumMessages.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <communityID>xs:long</communityID>
    <creationDate>xs:dateTime</creationDate>
    <latestMessageID>xs:long</latestMessageID>
    <messageCount>xs:int</messageCount>
    <moderationValue>xs:int</moderationValue>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <rootMessage>
        <!-- Contents of ForumMessage -->
    <rootMessage>

Group

Organizes users into a group for easier permissions management. In this way, groups essentially serve the same purpose that they do in Unix or Windows.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <memberCount>xs:int</memberCount>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>

Image

Type Template

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

JiveObject

Super-class of other jive webservice objects. Contains the unique id of the object and its type.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>

Locale

Webservice object that contains locale information such as the country code and language code.

Type Template

    <countryCode>xs:string</countryCode>
    <languageCode>xs:string</languageCode>

Poll

Poll webervices object.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <commentStatus>xs:int</commentStatus>
    <containerObjectID>xs:long</containerObjectID>
    <containerObjectType>xs:int</containerObjectType>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <endDate>xs:dateTime</endDate>
    <expirationDate>xs:dateTime</expirationDate>
    <mode>xs:long</mode>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <optionCount>xs:int</optionCount>
    <!-- List of ... -->
    <options>xs:string</options>
    <startDate>xs:dateTime</startDate>
    <user>
        <!-- Contents of User -->
    <user>
    <voteCount>xs:int</voteCount>

PrivateMessage

Represents a private message.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <body>xs:string</body>
    <date>xs:dateTime</date>
    <folderID>xs:long</folderID>
    <ownerID>xs:long</ownerID>
    <recipientID>xs:long</recipientID>
    <senderID>xs:long</senderID>
    <subject>xs:string</subject>

PrivateMessageFolder

Represents a private message folder.

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <messageCount>xs:int</messageCount>
    <name>xs:string</name>
    <ownerID>xs:long</ownerID>
    <unreadMessageCount>xs:int</unreadMessageCount>

ProfileField

A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'. It does not contain any user data related to the field. A profile field can be a variety of types (textfield, select list, etc) and collectively create a user's profile.

Type Template

    <description>xs:string</description>
    <editable>xs:boolean</editable>
    <filterable>xs:boolean</filterable>
    <ID>xs:long</ID>
    <index>xs:int</index>
    <name>xs:string</name>
    <!-- List of ... -->
    <options>
        <!-- Contents of ProfileFieldOption -->
    <options>
    <required>xs:boolean</required>
    <searchable>xs:boolean</searchable>
    <typeID>xs:int</typeID>
    <visible>xs:boolean</visible>

ProfileFieldOption

Represents a possible option of a

Type Template

    <defaultOption>xs:boolean</defaultOption>
    <fieldID>xs:long</fieldID>
    <index>xs:int</index>
    <value>xs:string</value>

ProfileSearchFilter

This class can filter user search results based on specific values for a .

Type Template

    <fieldID>xs:long</fieldID>
    <maxValue>xs:string</maxValue>
    <minValue>xs:string</minValue>
    <value>xs:string</value>

ProfileSearchQuery

Contains the necessary information required to perform a user search.

Type Template

    <community>xs:long</community>
    <!-- List of ... -->
    <filters>
        <!-- Contents of ProfileSearchFilter -->
    <filters>
    <keywords>xs:string</keywords>
    <searchEmail>xs:boolean</searchEmail>
    <searchName>xs:boolean</searchName>
    <searchProfile>xs:boolean</searchProfile>
    <searchUsername>xs:boolean</searchUsername>
    <sort>xs:int</sort>

Project

Type Template

    <!-- List of ... -->
    <availableContentTypes>xs:string</availableContentTypes>
    <!-- List of ... -->
    <contentTypes>xs:string</contentTypes>
    <creationDate>xs:dateTime</creationDate>
    <description>xs:string</description>
    <displayName>xs:string</displayName>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <dueDate>xs:dateTime</dueDate>
    <parentContainerID>xs:long</parentContainerID>
    <parentContainerType>xs:int</parentContainerType>
    <userID>xs:long</userID>

Property

Represents 1 extended property on an object.

Type Template

    <name>xs:string</name>
    <value>xs:string</value>

Query

Provides the ability to create complex search queries.

Type Template

    <afterDate>xs:dateTime</afterDate>
    <beforeDate>xs:dateTime</beforeDate>
    <queryString>xs:string</queryString>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>

Rating

Type Template

    <description>xs:string</description>
    <score>xs:int</score>

ResultFilter

Filters and sorts lists of threads and messages. This allows for a very rich set of possible queries that can be run on community data. Some examples are: "Show all messages posted in the community during the last year by a certain user" or "Show all threads in the community, sorted by their modification date". The class also supports pagination of results with the setStartIndex(int) and setNumResults(int) methods. If the start index is not set, it will begin at index 0 (the start of results). If the number of results is not set, it will be unbounded and return as many results as available. By default, result filters will obey the moderation rules as they are set for each community. You can override this behavior by setting a moderation range.

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>

StatusLevel

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <description>xs:string</description>
    <group>
        <!-- Contents of Group -->
    <group>
    <imagePath>xs:string</imagePath>
    <largeImagePath>xs:string</largeImagePath>
    <maxPoints>xs:int</maxPoints>
    <minPoints>xs:int</minPoints>
    <name>xs:string</name>

StatusLevelScenario

Type Template

    <ID>xs:long</ID>
    <objectType>xs:int</objectType>
    <code>xs:string</code>
    <enabled>xs:boolean</enabled>
    <i18nKey>xs:string</i18nKey>
    <points>xs:long</points>

TagCount

Container for tag and its count.

Type Template

    <name>xs:string</name>
    <uses>xs:int</uses>

TagResultFilter

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <minimum>xs:int</minimum>

Task

Type Template

    <assignor>
        <!-- Contents of User -->
    <assignor>
    <body>xs:string</body>
    <completed>xs:boolean</completed>
    <creationDate>xs:dateTime</creationDate>
    <dueDate>xs:dateTime</dueDate>
    <ID>xs:long</ID>
    <modificationDate>xs:dateTime</modificationDate>
    <owner>
        <!-- Contents of User -->
    <owner>
    <parentObjectID>xs:long</parentObjectID>
    <parentObjectType>xs:int</parentObjectType>
    <subject>xs:string</subject>
    <user>
        <!-- Contents of User -->
    <user>

TaskResultFilter

Type Template

    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <dueDateRangeMax>xs:dateTime</dueDateRangeMax>
    <dueDateRangeMin>xs:dateTime</dueDateRangeMin>
    <onlyComplete>xs:boolean</onlyComplete>
    <onlyIncomplete>xs:boolean</onlyIncomplete>
    <onlyPersonal>xs:boolean</onlyPersonal>
    <onlyProject>xs:boolean</onlyProject>
    <ownerID>xs:long</ownerID>
    <projectID>xs:long</projectID>

User

Provides information about and services for users of the system. Users can be identified by a unique id or username. Users can also be organized into groups for easier management of permissions.

Type Template

    <creationDate>xs:dateTime</creationDate>
    <email>xs:string</email>
    <emailVisible>xs:boolean</emailVisible>
    <enabled>xs:boolean</enabled>
    <ID>xs:long</ID>
    <modificationDate>xs:dateTime</modificationDate>
    <name>xs:string</name>
    <nameVisible>xs:boolean</nameVisible>
    <password>xs:string</password>
    <username>xs:string</username>

UserContentCommentResultFilter

A result filter for use in creating queries which return all comments on content created by a given user.

Type Template

    <communityID>xs:long</communityID>
    <includeModerated>xs:boolean</includeModerated>
    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>xs:int</moderationRangeMax>
    <moderationRangeMin>xs:int</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>xs:int</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>xs:int</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>xs:int</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>xs:long</userID>
    <includeAuthorsInUserFilter>xs:boolean</includeAuthorsInUserFilter>
    <includeDocumentBackChannelComments>xs:boolean</includeDocumentBackChannelComments>
    <includeOwnComments>xs:boolean</includeOwnComments>

UserProfile

Contains user data for a particular .

Type Template

    <fieldID>xs:long</fieldID>
    <value>xs:string</value>
    <!-- List of ... -->
    <values>xs:string</values>

Watch

A watch is a way for a user to track updates to an object. Users create watches on individual objects and can specify whether or not they want to be notified by email (or some other way) each time the object is updated. Three kinds of watch types are available:

"Normal" watches are passive watches. This means the user doesn't get explicit notifications of object updates, but will see that has been updated the next time they visit.
Email update watches send an email to the user whenever the object is updated. Typically, this email message will include a link back to the online site, but messages are highly configurable. Email notifications are disabled by default, but can be enabled through the admin screens. Users will not receive email watch notifications for objects that they post themselves, since doing so would be rather pointless.
Batch email update watches are the same as normal email watch updates except that the email is sent to the user only periodically and include all the updates that have occurred since the last email was sent.

Type Template

    <expirable>xs:boolean</expirable>
    <objectID>xs:long</objectID>
    <objectType>xs:int</objectType>
    <userID>xs:long</userID>
    <watchType>xs:int</watchType>