public interface ICollabNetSoap
User2SoapList
objects.User2SoapList
objects.User2SoapList
objects.User2SoapList
objects.User2SoapDO
objects.User2SoapDO
objects.User2SoapDO
objects.Modifier and Type | Method and Description |
---|---|
void |
addProjectGroupAdmins(String sessionId,
String projectGroupId,
String[] usernames)
Makes the users given in the usernames parameter as administrators of the Project Group represented by the projectGroupId.
|
void |
addProjectGroupMember(String sessionId,
String projectGroupId,
String userName)
Makes a user a member of a project group.
|
void |
addProjectMember(String sessionId,
String projectId,
String userName)
Makes a user a member of a project.
|
void |
addProjectsToProjectGroup(String sessionId,
String projectGroupId,
String[] projectIds)
Adds the given projects to a project group.
|
void |
addUserGroupMember(String sessionId,
String userGroupId,
String userName)
Adds a user to a user group.
|
boolean |
canReceiveOwnUpdates(String sessionId)
Returns whether the current user receives notifications for the user's own updates.
|
void |
changeIAObjectTitle(String sessionId,
String pluggableObjectId,
String pluggableObjectTitle)
Updates the title for Pluggable objects only.
|
boolean |
changePassword(String sessionId,
String userName,
String newPassword)
Allows the user to change the password
Note: From 16.7, the length of password cannot exceed the value of the configuration variable "MAX_PASSWORD_LENGTH" specified in the site-options.conf file. |
void |
createAssociation(String sessionId,
String originId,
String targetId,
String description)
Creates an association between two objects.
|
void |
createAssociationWithTitles(String sessionId,
String originId,
String originTitle,
String targetId,
String targetTitle,
String description)
Creates an association between two objects with specified title.
|
ProjectSoapDO |
createOrReplaceProjectTemplate(String sessionId,
String projectId,
String title,
String description,
String[] contentChoices,
String templateId)
Creates or replaces a template from an existing project
|
ProjectSoapDO |
createProject(String sessionId,
String name,
String title,
String description)
Creates a project.
|
ProjectSoapDO |
createProjectFromTemplate(String sessionId,
String templateId,
String name,
String title,
String description)
Creates a project from template.
|
ProjectGroupSoapDO |
createProjectGroup(String sessionId,
String title,
String description)
Creates a Project Group.
|
String |
createProjectLinkedApp(String sessionId,
String projectId,
String title,
String applicationUrl,
String iconKey,
String iconFileName,
String iconMimeType,
boolean singleSignon)
Creates linked application in a given project and return the created application Id
|
String |
createProjectLinkedApp2(String sessionId,
String projectId,
String title,
String applicationUrl,
String iconKey,
String iconFileName,
String iconMimeType,
boolean singleSignon,
String toolId)
Creates linked application in a given project and return the created application Id
|
String |
createSiteWideLinkedApp(String sessionId,
String title,
String applicationUrl,
String applicationType,
boolean singleSignon)
Create a site-wide linked application and return the created application Id
|
UserSoapDO |
createUser(String sessionId,
String userName,
String email,
String fullName,
String organization,
String locale,
String timeZone,
String licenseType,
boolean isSuperUser,
boolean isRestrictedUser,
String password)
Creates a new user with the specified parameters.
|
UserGroupSoapDO |
createUserGroup(String sessionId,
String fullName,
String description)
Creates a new user group with the specified parameters.
|
void |
deleteAssociation(String sessionId,
String originId,
String targetId)
Deletes an association between two objects
|
void |
deleteAttachment(String sessionId,
String objectId,
String attachmentId)
Deletes the specified attachment of the specified object.
|
void |
deleteLinkedApp(String sessionId,
String linkedAppId)
Delete the linked application.
|
void |
deleteProject(String sessionId,
String projectId,
boolean noNotification,
boolean forceDeleteEvenIfChildFound)
Deletes a project.
|
void |
deleteProjectGroup(String sessionId,
String projectGroupId,
boolean forceDeleteEvenIfMemberProjectFound)
Deletes a project group.
|
void |
deleteUserGroup(String sessionId,
String groupId)
Deletes a user group.
|
String |
doMandatoryPasswordChange(String userName,
String oldPassword,
String newPassword)
Allows user to change the password if and only if the password was set by an administrator.
|
ProjectSoapList |
findProjects(String sessionId,
String queryString)
Finds a list of projects matching a search string.
|
UserSoapList |
findUsers(String sessionId,
String queryString)
Finds a list of users matching a search string.
|
String |
getApiVersion()
Gets TeamForge API version.
|
AssociationSoapList |
getAssociationList(String sessionId,
String objectId)
Lists all of the associations for a given object.
|
AuditHistorySoapList |
getAuditHistoryList(String sessionId,
String objectId,
boolean includeDerivedChanges)
Returns the list of changes made to the specified object in reverse chronological order.
|
String |
getBroadCastMessage(String sessionId)
Gets broadcast message
|
CommentSoapList |
getCommentList(String sessionId,
String objectId)
Gets list of comments for object.
|
String |
getConfigurationValue(String sessionId,
String keyValue)
Gets Configuration value for the passed key.
|
long |
getCurrentTime(String sessionId)
Returns the current server time in milliseconds.
|
UserSoapDO |
getCurrentUserData(String sessionId)
Gets the user details for a given user session id.
|
String |
getJSessionBySoapId(String soapId)
Deprecated.
instead use
getJSessionId |
String |
getJSessionId(String oneTimeToken)
Returns current user Jsession Id using one time token id
|
LinkedApplicationSoapDO |
getLinkedApplicationData(String sessionId,
String linkedAppId)
Gets Linked Application Data by Linked Application Id
|
LinkedApplication2SoapDO |
getLinkedApplicationData2(String sessionId,
String linkedAppId)
Gets Linked Application Data by Linked Application Id
|
ProjectSoapList |
getMemberProjectsForProjectGroup(String sessionId,
String projectGroupId)
Gets the Project List for project group.
|
String |
getOneTimeToken(String sessionId)
Gives one time token for active sessionId.
|
int |
getProjectAccessLevel(String sessionId,
String projectId)
Gets the project's access level.
|
ProjectSoapDO |
getProjectByPath(String sessionId,
String projectPath)
Gets the project data for a given project path.
|
ProjectSoapDO |
getProjectData(String sessionId,
String projectId)
Gets a project object which includes the parent project ID, project hierarchy path and locked status flag.
|
long |
getProjectDiskUsage(String sessionId,
String projectId)
Gets the filestorage disk utilization of a project specified by a project id
|
ProjectGroupSoapDO |
getProjectGroupData(String sessionId,
String projectGroupId)
Gets the Project Group Data by project group id.
|
ProjectGroupMemberSoapList |
getProjectGroupMemberList(String sessionId,
String projectGroupId)
Returns project group membership list.
|
ProjectGroupSoapList |
getProjectGroupsForProject(String sessionId,
String projectId)
Deprecated.
in favour of getProjectGroupsForProject1
|
ProjectGroupSoapList |
getProjectGroupsForProject1(String sessionId,
String projectId)
Gets ProjectGroupList by project and user should have view permission
|
com.collabnet.ce.soap60.types.SoapNamedValues |
getProjectHierarchyPaths(String sessionId,
String[] projectIds)
Returns the hierarchy path of the given projects.
|
ProjectSoapList |
getProjectList(String sessionId,
boolean fetchHierarchyPath)
Returns a list of all projects visible to the user.
|
ProjectSoapList |
getProjectListForUser(String sessionId,
String username,
boolean fetchHierarchyPath,
boolean includeGroupMembership)
Returns a list of projects the user passed as parameter is a member of (the list contains only the projects that the soap caller has the right to see).
|
ProjectMemberSoapList |
getProjectMemberList(String sessionId,
String projectId)
Returns project membership list.
|
long |
getProjectQuota(String sessionId,
String projectId)
Gets the disk quota for a project.
|
String |
getSessionId(String oneTimeToken)
Returns current user session Id using one time token id
|
ProjectSoapList |
getSubprojectList(String sessionId,
String projectId,
boolean fetchHierarchyPath)
Returns a list of the immediate sub projects of a project.
|
UserSoapDO |
getUserByEmail(String sessionId,
String email)
Returns the user information for the given email address.
|
UserSoapDO |
getUserByName(String sessionId,
String fullname)
Returns the user information for the given full name.
|
UserSoapDO |
getUserData(String sessionId,
String username)
Gets the user details for the given username.
|
User2SoapDO |
getUserData2(String sessionId,
String username)
Gets the user details for the given username.
|
String |
getUserEffectiveMode(String sessionId)
Gets effective mode (ALM or SCM) for the current user
|
UserGroupSoapDO |
getUserGroupData(String sessionId,
String groupId)
Returns the user group information.
|
UserGroupSoapList |
getUserGroupList(String sessionId)
Gets a list of all user groups on the system.
|
UserGroupSoapList |
getUserGroupListForProject(String sessionId,
String projectOrProjectGroupId)
Returns a list of user groups that have a role in the project.
|
UserGroupSoapList |
getUserGroupListForUser(String sessionId,
String username)
Gets a list of all user groups the user belongs.
|
UserSoapList |
getUserGroupMembers(String sessionId,
String groupId)
Gets a list of active users who are members of a user group
|
UserSoapList |
getUserList(String sessionId,
com.collabnet.ce.soap60.types.SoapFilter soapFilter)
Deprecated.
use getUserList2 instead, which includes organization, alternate emails, locale and timeZone details in the result.
|
User2SoapList |
getUserList2(String sessionId,
com.collabnet.ce.soap60.types.SoapFilter soapFilter)
Gets a list of all users on the system.
|
String |
getUserSessionBySoapId(String soapId)
gets the access token using soap Id.
|
String |
getVersion(String sessionId)
Gets TeamForge version.
|
VersionInformationSoapList |
getVersionInformationList(String sessionId,
String folderId)
Obtains a list of versions and last modified dates for the objects residing in the specified folder.
|
String |
getWebAndSoapSessionId(String oneTimeToken)
Gets the web and soap session id's separated by &
|
boolean |
hasGeneralPermission(String sessionId,
String username,
String projectId,
String operationString,
String objectId)
Checks if the user has general permission for the resource (specified by objectid).
|
boolean |
hasPermission(String sessionId,
String username,
String projectId,
String operationString,
String objectId)
Checks whether the given user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
|
boolean |
hasPermission2(String sessionId,
String projectId,
String operationString,
String objectId)
Checks whether the current user has permission for an operation on a specified object Note on an exceptional behavior: It returns false, if the calling user does not have 'Project view' permission.
|
boolean |
hasSitewideRolePermission(String sessionId,
String operationString)
Checks if the current user has the given site wide permission to perform the operation.
|
boolean |
isHostedMode(String sessionId)
Verifies if the TeamForge appserver is running in Hosted Mode.
|
boolean |
isSoapRedirectPostOnlyMode(String sessionId)
Verifies if TeamForge is running in SoapRedirect Post-Only mode.
|
void |
keepAlive(String sessionId)
Deprecated.
This operation is no longer supported. Acquire new access token by logging in again.
|
AttachmentSoapList |
listAttachments(String sessionId,
String objectId)
Lists the attachments associated with the object, the attachment itself is not part of the returned object.
|
UserGroupSoapList |
listGroupsWithGeneralPermission(String sessionId,
String projectId,
String operationString,
String folderId,
boolean includeInherited)
Returns a list of user groups which have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
|
UserSoapList |
listProjectAdmins(String sessionId,
String projectId)
Returns project administrators list.
|
ProjectGroupSoapList |
listProjectGroups(String sessionId)
Returns a list of all projects groups.
|
LinkedApplicationSoapList |
listProjectLinkedApps(String sessionId,
String projectId)
Lists project-level linked applications for a given project.
|
LinkedApplication2SoapList |
listProjectLinkedApps2(String sessionId,
String projectId)
Lists project-level linked applications for a given project.
|
LinkedApplicationSoapList |
listSiteWideLinkedApps(String sessionId)
Lists site-wide linked applications.
|
ProjectSoapList |
listTemplates(String sessionId)
Lists project templates within the installation.
|
UserSoapList |
listUsersWithGeneralPermission(String sessionId,
String projectId,
String operationString,
String folderId)
Returns a list of users who have some permission to perform the given operation in the given folder (Doesn't check default access permission nor site admins)
|
UserSoapList |
listUsersWithPermissionOnObject(String sessionId,
String operationString,
String objectId,
int flag)
Returns the list of users who have the given permission on the given object.
|
ProjectSoapDO |
lockProject(String sessionId,
String projectId)
Locks project.
|
String |
login(String userName,
String password)
Logs in a user and creates a new session.This will throw login fault if the user's password was set by an administrator and if the user has not changed it yet.
|
String |
loginAnonymous(String anonSharedSecret)
This method allows to login as anonymous to get TF default access.
|
String |
loginWithToken(String username,
String oneTimeToken)
Logs in a user and creates a new session.
|
void |
logoff(String userName,
String sessionId)
Ends a user's session, but the token can still be used until it expires.
|
void |
reindexObject(String sessionId,
String objectId)
Re-indexes the contents of the specified project, folder, item or user.
|
void |
removeProjectGroupAdmins(String sessionId,
String projectGroupId,
String[] usernames)
Removes the users given in the usernames parameter from the administrator role of the Project Group represented by the projectGroupId.
|
void |
removeProjectGroupMember(String sessionId,
String projectGroupId,
String userName)
Removes a user from a project group.
|
void |
removeProjectMember(String sessionId,
String projectId,
String userName)
Removes a user from a project.
|
void |
removeProjectsFromProjectGroup(String sessionId,
String[] projectMemberIds,
String projectGroupId)
Removes projects from project group
|
void |
removeUserGroupMember(String sessionId,
String userGroupId,
String userName)
Removes a user from a user group.
|
void |
setLinkedApplicationData(String sessionId,
LinkedApplicationSoapDO linkedApplicationSoapDO,
String iconKey,
String iconFileName,
String iconMimeType)
Sets the linked application.
|
void |
setLinkedApplicationData2(String sessionId,
LinkedApplication2SoapDO linkedApplication2SoapDO,
String iconKey,
String iconFileName,
String iconMimeType)
Sets the linked application.
|
void |
setParentProject(String sessionId,
String projectId,
String parentProjectId)
Sets the parent of a project.
|
void |
setProjectAccessLevel(String sessionId,
String projectId,
int accessLevel)
Sets the project access level.
|
void |
setProjectGroupData(String sessionId,
ProjectGroupSoapDO projectGroupData)
Sets the project group's data with the data represented in the projectGroupData parameter.
|
void |
setProjectQuota(String sessionId,
String projectId,
long quota)
Sets the disk quota for a project.
|
void |
setUserData(String sessionId,
UserSoapDO userData)
Sets the user information.
|
void |
setUserData2(String sessionId,
User2SoapDO userData)
Sets the user information.
|
void |
setUserGroupData(String sessionId,
UserGroupSoapDO groupData)
Sets the user group information.
|
ProjectSoapDO |
unLockProject(String sessionId,
String projectId)
Un-Locks project.
|
String getVersion(String sessionId) throws RemoteException
sessionId
- the session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.RemoteException
String getApiVersion() throws RemoteException
RemoteException
void keepAlive(String sessionId) throws RemoteException
sessionId
- the session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.RemoteException
String loginAnonymous(String anonSharedSecret) throws RemoteException
anonSharedSecret
- Shared secret for anonymous login. Its value must match the value set for SOAP_ANONYMOUS_SHARED_SECRET configuration variable set in site-options.conf file.com.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrect.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String login(String userName, String password) throws RemoteException
userName
- Name of the user.password
- User password.com.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrect.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String loginWithToken(String username, String oneTimeToken) throws RemoteException
username
- Name of the user.oneTimeToken
- a one time token for login.com.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrect.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void logoff(String userName, String sessionId) throws RemoteException
userName
- User's name.sessionId
- Session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String doMandatoryPasswordChange(String userName, String oldPassword, String newPassword) throws RemoteException
userName
- login nameoldPassword
- current passwordnewPassword
- new passwordcom.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrect.com.collabnet.ce.soap60.fault.InvalidOperationFault
- if the user has already changed the passwordcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.InvalidSessionFault
- If there is a session fault.com.collabnet.ce.soap60.fault.InvalidPasswordFault
- If the new password is not valid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have permissions to change passwordcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If invalid user name is passedRemoteException
boolean changePassword(String sessionId, String userName, String newPassword) throws RemoteException
sessionId
- User session keyuserName
- login namenewPassword
- new passwordcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.InvalidSessionFault
- If there is a session fault.com.collabnet.ce.soap60.fault.InvalidPasswordFault
- If the new password is not valid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have permissions to change passwordcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If invalid user name is passedRemoteException
UserGroupSoapList listGroupsWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId, boolean includeInherited) throws RemoteException
sessionId
- The current user session idprojectId
- Project for which permission is checkedoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.folderId
- Id of the folder for which permission needs to be checked.includeInherited
- true includes groups inherited from parent projects, false otherwisecom.collabnet.ce.soap60.fault.InvalidSessionFault
- When Session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the folderId does not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the operationString is in an invalid formatcom.collabnet.ce.soap60.fault.SystemFault
- Any other exceptionscom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have project view permissionRemoteException
boolean hasPermission(String sessionId, String username, String projectId, String operationString, String objectId) throws RemoteException
sessionId
- the current user session idusername
- the name of the user to check permissionprojectId
- the project in which the operation is definedoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.objectId
- the object for which we are doing the permission check. Null if we're checking permission on the app folder of a projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- The specified projectId or folderId was invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the operationString is in an invalid formatRemoteException
OperationConstants
boolean hasPermission2(String sessionId, String projectId, String operationString, String objectId) throws RemoteException
sessionId
- the current user session idprojectId
- the project in which the operation is definedoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.objectId
- the object for which we are doing the permission check. Null if we're checking permission on the app folder of a projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- The specified projectId or folderId was invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the operationString is in an invalid formatRemoteException
OperationConstants
ProjectSoapList getProjectList(String sessionId, boolean fetchHierarchyPath) throws RemoteException
sessionId
- User session key.fetchHierarchyPath
- flag indicating whether to fetch the hierarchy path for each projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
ProjectSoapList getProjectListForUser(String sessionId, String username, boolean fetchHierarchyPath, boolean includeGroupMembership) throws RemoteException
sessionId
- User session key.username
- User name.fetchHierarchyPath
- flag indicating whether to fetch the hierarchy path for each projectincludeGroupMembership
- flag indicating whether to return projects which are accessible by group membership.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
ProjectSoapList getSubprojectList(String sessionId, String projectId, boolean fetchHierarchyPath) throws RemoteException
sessionId
- User session key.projectId
- Project id (not a project group id).fetchHierarchyPath
- flag indicating whether to fetch the hierarchy path for each projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the project passed as parameter does not exist or if the project id is in fact a project group id.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
ProjectSoapDO createProject(String sessionId, String name, String title, String description) throws RemoteException
sessionId
- User session key.name
- The name of the project (can be null, will fall back to title or id)title
- The title of the projectdescription
- The description of the projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the project with that name already exists.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when specified argument is invalid.IllegalArgumentException
- Invalid data was passed inRemoteException
ProjectSoapDO createOrReplaceProjectTemplate(String sessionId, String projectId, String title, String description, String[] contentChoices, String templateId) throws RemoteException
sessionId
- The session id.projectId
- The project to copy into a templatetitle
- The title of the templatedescription
- The description of the templatecontentChoices
- the desired application content in the template, see constants belowtemplateId
- the id of the template to replace, if null (not empty string but null), a new template will be createdcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the template or project does not exist.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when illegal argument is passed.RemoteException
ProjectSoapDO.INCLUDE_ALL_CONTENT
,
ProjectSoapDO.INCLUDE_DISCUSSIONS_CONTENT
,
ProjectSoapDO.INCLUDE_DOCUMENTS_CONTENT
,
ProjectSoapDO.INCLUDE_FRS_CONTENT
,
ProjectSoapDO.INCLUDE_PLANNING_FOLDERS
,
ProjectSoapDO.INCLUDE_PROJECT_PAGES
,
ProjectSoapDO.INCLUDE_REPORTS_CONTENT
,
ProjectSoapDO.INCLUDE_SAVED_SEARCHES
,
ProjectSoapDO.INCLUDE_TASKS_CONTENT
,
ProjectSoapDO.INCLUDE_TRACKER_CONTENT
,
ProjectSoapDO.INCLUDE_WIKI_CONTENT
,
ProjectSoapDO.INCLUDE_TEAMS
ProjectSoapDO createProjectFromTemplate(String sessionId, String templateId, String name, String title, String description) throws RemoteException
sessionId
- User session key.templateId
- The template project idname
- The name of the project (can be null, will fall back to title or id)title
- The title of the projectdescription
- The description of the projectcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the project with that name already exists.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when illegal argument is passed.RemoteException
ProjectSoapList listTemplates(String sessionId) throws RemoteException
sessionId
- User session key.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectSoapList findProjects(String sessionId, String queryString) throws RemoteException
sessionId
- User session id.queryString
- Query string.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the query string is invalid.RemoteException
ProjectSoapDO lockProject(String sessionId, String projectId) throws RemoteException
sessionId
- User session key.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.ProjectAlreadyLockedFault
- When a user tries to lock an already locked projectRemoteException
ProjectSoapDO unLockProject(String sessionId, String projectId) throws RemoteException
sessionId
- User session key.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectSoapDO getProjectData(String sessionId, String projectId) throws RemoteException
sessionId
- User session key.projectId
- Project id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectMemberSoapList getProjectMemberList(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Id of the project.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapList listProjectAdmins(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- Id of the project.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserGroupSoapList getUserGroupListForProject(String sessionId, String projectOrProjectGroupId) throws RemoteException
sessionId
- User session id.projectOrProjectGroupId
- Project/ProjectGroup Id.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addProjectMember(String sessionId, String projectId, String userName) throws RemoteException
sessionId
- User session id.projectId
- Id project Id.userName
- Name of the new user.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addProjectGroupMember(String sessionId, String projectGroupId, String userName) throws RemoteException
sessionId
- User session id.projectGroupId
- ProjectGroup id.userName
- Name of the new user.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void removeProjectMember(String sessionId, String projectId, String userName) throws RemoteException
sessionId
- User session id.projectId
- Id of the project.userName
- Name of the new user.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.RemoveOnlyProjectAdminFault
- attempting to remove last project adminRemoteException
UserGroupSoapDO createUserGroup(String sessionId, String fullName, String description) throws RemoteException
sessionId
- User's session id.fullName
- Full name of the new group.description
- Description of the new group.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the specified group already exists.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when one or more group parameters are invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserGroupSoapDO getUserGroupData(String sessionId, String groupId) throws RemoteException
sessionId
- User's session id.groupId
- User Group id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified group id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void setUserGroupData(String sessionId, UserGroupSoapDO groupData) throws RemoteException
sessionId
- User's session id.groupData
- User Group data.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- The user group version being edited is not the latest onecom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when a user group with the specified user group name already exists.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the specified user group name is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occursRemoteException
void deleteUserGroup(String sessionId, String groupId) throws RemoteException
sessionId
- User session key.groupId
- The id of the user group to be deletedcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if we can't find the project with the specified user group idcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalUserModificationFault
- when a user tries to delete system created user group.RemoteException
UserGroupSoapList getUserGroupList(String sessionId) throws RemoteException
sessionId
- User session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.RemoteException
UserGroupSoapList getUserGroupListForUser(String sessionId, String username) throws RemoteException
sessionId
- User session id.username
- the name of the usercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapList getUserGroupMembers(String sessionId, String groupId) throws RemoteException
sessionId
- User session id.groupId
- the user group idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if we can't find the project with the specified user group id.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void addUserGroupMember(String sessionId, String userGroupId, String userName) throws RemoteException
sessionId
- User session id.userGroupId
- User Group to which the user should be addeduserName
- User to be added to the user groupcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the user group and/or user does not existcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalGroupMemberAddFault
- when an users in the system is added to system created user group.RemoteException
void removeUserGroupMember(String sessionId, String userGroupId, String userName) throws RemoteException
sessionId
- User session id.userGroupId
- User Group from which the user should be removed.userName
- User to be removed.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the user group and/or user does not existcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapDO createUser(String sessionId, String userName, String email, String fullName, String organization, String locale, String timeZone, String licenseType, boolean isSuperUser, boolean isRestrictedUser, String password) throws RemoteException
sessionId
- User's session id.userName
- Name of the new user.email
- Email of the new user.fullName
- Full name of the new user.organization
- organization name of the new user.locale
- Locale of the new user (currently supported locales are "en" for English, "ja" for Japanese).timeZone
- User's time zone. The ID for a TimeZone
, either an abbreviation such as "PST", a full name such as "America/Los_Angeles", or a custom ID such as "GMT-8:00".licenseType
- User's license type. Multiple license types can be given for a user as ALM,DEVOPSisSuperUser
- Should user be given super-user privileges?isRestrictedUser
- Should user be given restricted privileges?password
- Password of the new user.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the specified user already exists.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when one or more user parameters are invalid.com.collabnet.ce.soap60.fault.UserLimitExceededFault
- The user limit was exceededcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapDO getUserData(String sessionId, String username) throws RemoteException
sessionId
- User session id.username
- User name (login name)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the username is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
User2SoapDO getUserData2(String sessionId, String username) throws RemoteException
sessionId
- User session id.username
- User name (login name)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the username is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapDO getUserByEmail(String sessionId, String email) throws RemoteException
sessionId
- User session id.email
- the email address of a registered usercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the username is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapDO getUserByName(String sessionId, String fullname) throws RemoteException
sessionId
- User session id.fullname
- the full name of a usercom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the username is invalidcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapDO getCurrentUserData(String sessionId) throws RemoteException
sessionId
- user session idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- if the given session id is invalid.RemoteException
void setUserData2(String sessionId, User2SoapDO userData) throws RemoteException
sessionId
- User session id.userData
- User data which includes user's profile picture link.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- The user version being edited is not the latest onecom.collabnet.ce.soap60.fault.LastSuperUserFault
- The user being edited is the last super user and cannot be un-superuseredcom.collabnet.ce.soap60.fault.IllegalUserModificationFault
- If someone tried to edit a restricted property on a special user (like the status on the admin user).com.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to do this (only site admins and users with site-wide user edit permissions can perform this operation)com.collabnet.ce.soap60.fault.UserLimitExceededFault
- The user limit was exceededcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void setUserData(String sessionId, UserSoapDO userData) throws RemoteException
sessionId
- User session id.userData
- User datacom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- The user version being edited is not the latest onecom.collabnet.ce.soap60.fault.LastSuperUserFault
- The user being edited is the last super user and cannot be un-superuseredcom.collabnet.ce.soap60.fault.IllegalUserModificationFault
- If someone tried to edit a restricted property on a special user (like the status on the admin user).com.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to do this (only site admins and users with site-wide user edit permissions can perform this operation)com.collabnet.ce.soap60.fault.UserLimitExceededFault
- The user limit was exceededcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapList findUsers(String sessionId, String queryString) throws RemoteException
sessionId
- User session id.queryString
- Query string.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when the query string is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
UserSoapList getUserList(String sessionId, com.collabnet.ce.soap60.types.SoapFilter soapFilter) throws RemoteException
sessionId
- User session id.soapFilter
- Search filter. See UserSoapDO.FILTER constants for supported filter names.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permissionRemoteException
User2SoapList getUserList2(String sessionId, com.collabnet.ce.soap60.types.SoapFilter soapFilter) throws RemoteException
sessionId
- User session id.soapFilter
- Search filter. See UserSoapDO.FILTER constants for supported filter names.com.collabnet.ce.soap60.fault.SearchQuerySyntaxFault
- when the specified search query string is syntactically invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permissionRemoteException
int getProjectAccessLevel(String sessionId, String projectId) throws RemoteException
sessionId
- User session IdprojectId
- The project Idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user doesn't have permission to perform the operationcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the project id is not a valid project id or if it is a Project Group's idRemoteException
ProjectSoapDO.PUBLIC
,
ProjectSoapDO.GATED_COMMUNITY
,
ProjectSoapDO.PRIVATE
void setProjectAccessLevel(String sessionId, String projectId, int accessLevel) throws RemoteException
getConfigurationValue
to check this flag.sessionId
- User session IdprojectId
- The project IdaccessLevel
- The access level to set the project tocom.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user doesn't have permission to perform the operationcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the project id is not a valid project idcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- When the accessLevel is invalid or if the "PROJECT_ACCESS_EDITABLE" configuration's value is falseRemoteException
getConfigurationValue(java.lang.String, java.lang.String)
CommentSoapList getCommentList(String sessionId, String objectId) throws RemoteException
sessionId
- User session id.objectId
- Object id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- When the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the object id is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user doesn't have permission to perform the operationcom.collabnet.ce.soap60.fault.SystemFault
- When an unexpected system level error occurs.RemoteException
AttachmentSoapList listAttachments(String sessionId, String objectId) throws RemoteException
sessionId
- user session idobjectId
- the id of the object from which attachments are to be listedcom.collabnet.ce.soap60.fault.InvalidSessionFault
- When the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the object id is not valid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user doesn't have permission to perform the operation.com.collabnet.ce.soap60.fault.SystemFault
- If an unexpected system fault occurs.RemoteException
void deleteAttachment(String sessionId, String objectId, String attachmentId) throws RemoteException
sessionId
- User session id.objectId
- The id of the object from which attachment has to be deleted.attachmentId
- The attachment id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void createAssociation(String sessionId, String originId, String targetId, String description) throws RemoteException
sessionId
- User session id.originId
- the origin object's id (Only CTF objects can be passed as origin id)targetId
- the target object's id (Incase of pluggable app object, provide the object id for targetId parameter)description
- the description for the associationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- if the user's session is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to create the associationcom.collabnet.ce.soap60.fault.SystemFault
- if an unexpected system error occurscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the origin or target objects do not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if a valid association cannot be created between the given objectsRemoteException
void createAssociationWithTitles(String sessionId, String originId, String originTitle, String targetId, String targetTitle, String description) throws RemoteException
sessionId
- User session id.originId
- the origin object's id (Only CTF objects can be passed as origin id)originTitle
- the origin object's title (As of 7.0 originTitle will be ignored completely)targetId
- the target object's id (For pluggable app object, provide the object id for targetId parameter)targetTitle
- the target object's title (CTF objects title will not be stored. Only title supplied for IAF Objects will be stored)description
- the description for the associationcom.collabnet.ce.soap60.fault.InvalidSessionFault
- if the user's session is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to create the associationcom.collabnet.ce.soap60.fault.SystemFault
- if an unexpected system error occurscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the origin or target objects do not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if a valid association cannot be created between the given objectsRemoteException
void changeIAObjectTitle(String sessionId, String pluggableObjectId, String pluggableObjectTitle) throws RemoteException
sessionId
- User session id.pluggableObjectId
- The pluggable app object id, provide the object id for which the title needs to be updatedpluggableObjectTitle
- the pluggable object's title (Pluggable objects could pass the object title to be updated in CTF)com.collabnet.ce.soap60.fault.InvalidSessionFault
- if the user's session is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to create the associationcom.collabnet.ce.soap60.fault.SystemFault
- if an unexpected system error occurscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the origin or target objects do not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if a valid association cannot be created between the given objectsRemoteException
void deleteAssociation(String sessionId, String originId, String targetId) throws RemoteException
sessionId
- User session id.originId
- the origin object's id (Only CTF objects can be passed as origin id)targetId
- the target object's idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- if the user's session is not validcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to delete the associationcom.collabnet.ce.soap60.fault.SystemFault
- if an unexpected system error occurscom.collabnet.ce.soap60.fault.NoSuchObjectFault
- if the origin or target objects do not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if an association does not exist between the given objectsRemoteException
void deleteProject(String sessionId, String projectId, boolean noNotification, boolean forceDeleteEvenIfChildFound) throws RemoteException
sessionId
- User session key.projectId
- The id of the project to be deletednoNotification
- if true no notifications will be sent.forceDeleteEvenIfChildFound
- delete even if there are child projectscom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if we can't find the project with the specified project idcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.ParentRoleUsedInChildProjectsFault
- when a role of the project is used in its child projects.com.collabnet.ce.soap60.fault.ChildProjectsFoundFault
- thrown if any child projects are found for the project that is deleted.RemoteException
AssociationSoapList getAssociationList(String sessionId, String objectId) throws RemoteException
sessionId
- The current session id.objectId
- The id of the object that has associations.com.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session is not valid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- If the object does not exist or is deleted.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If you are not allowed to view the object or its associations.com.collabnet.ce.soap60.fault.SystemFault
- If an unexpected error occurs.RemoteException
AuditHistorySoapList getAuditHistoryList(String sessionId, String objectId, boolean includeDerivedChanges) throws RemoteException
sessionId
- The current session id.objectId
- ID of the object.includeDerivedChanges
- whether we want to get the derived entries(effort fields changed for autosummed artfs)com.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session is not valid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- If the object does not exist or is deleted.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If you are not allowed to view the object or its associations.com.collabnet.ce.soap60.fault.SystemFault
- If an unexpected error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the objectId is not a task or an artifact.RemoteException
VersionInformationSoapList getVersionInformationList(String sessionId, String folderId) throws RemoteException
sessionId
- Soap session idfolderId
- Folder to obtain the list forcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the folder does not exist.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when permissions are denied for the operation.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected error occurs.RemoteException
void reindexObject(String sessionId, String objectId) throws RemoteException
sessionId
- User session ID (must be a system administrator to perform this operation)objectId
- Project to re-index.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user does not have sufficient privileges (must be a system admin).com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object ID is invalid.RemoteException
String getUserEffectiveMode(String sessionId) throws RemoteException
sessionId
- Session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.RemoteException
boolean isHostedMode(String sessionId) throws RemoteException
sessionId
- Session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.RemoteException
long getProjectDiskUsage(String sessionId, String projectId) throws RemoteException
sessionId
- the soap session keyprojectId
- the id of the projectcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- thrown if the project was not found.com.collabnet.ce.soap60.fault.InvalidSessionFault
- thrown if the session id is not valid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- thrown if sessionId is not a session started by an admin.com.collabnet.ce.soap60.fault.SystemFault
- If there was a problem checking the permissions.RemoteException
long getProjectQuota(String sessionId, String projectId) throws RemoteException
sessionId
- The id of the current session.projectId
- The id of the project.com.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session id is not valid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- If the project id does not exist.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user is not allowed to view this information.com.collabnet.ce.soap60.fault.SystemFault
- If there was a problem checking the permissions.RemoteException
void setProjectQuota(String sessionId, String projectId, long quota) throws RemoteException
sessionId
- The id of the current session.projectId
- The id of the project.quota
- The disk quota to be set for the project.com.collabnet.ce.soap60.fault.InvalidSessionFault
- If the session id is not valid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- If the project id does not exist.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If the user is not allowed to view this information.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.RemoteException
String getConfigurationValue(String sessionId, String keyValue) throws RemoteException
sessionId
- The id of the current session.keyValue
- of the configuration parameter sought for as String.(Currently supported for 'RequireAssociationOnDocumentCreate', 'RequireArtifactToBeOpenOnDocumentAssociation', 'AllowedAssociationTypeOnDocumentCreate', 'ProjectAccessEditable')com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectSoapDO getProjectByPath(String sessionId, String projectPath) throws RemoteException
sessionId
- user session idprojectPath
- path for which the project info. is requestedcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
UserSoapList listUsersWithGeneralPermission(String sessionId, String projectId, String operationString, String folderId) throws RemoteException
sessionId
- user session idprojectId
- project for which permission is checkedoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.folderId
- id of the folder for which permission needs to be checked.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the objectId does not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the operationString is in an invalid formatcom.collabnet.ce.soap60.fault.SystemFault
- any other exceptionscom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have project view permissionRemoteException
boolean hasGeneralPermission(String sessionId, String username, String projectId, String operationString, String objectId) throws RemoteException
sessionId
- User sessionusername
- user for which permission needs to be checkedprojectId
- Project for which permission is checkedoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.objectId
- Object id can't be null for which permission needs to be checked.com.collabnet.ce.soap60.fault.InvalidSessionFault
- When Session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the objectId does not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- Illegal arguments for the operation stringcom.collabnet.ce.soap60.fault.SystemFault
- Any other exceptionsRemoteException
boolean hasSitewideRolePermission(String sessionId, String operationString) throws RemoteException
sessionId
- User session idoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the sessionId is invalidcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the operationString is in an invalid formatcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occursRemoteException
void setParentProject(String sessionId, String projectId, String parentProjectId) throws RemoteException
sessionId
- User session id.projectId
- Id of the project whose parent needs to be set.parentProjectId
- Id of the project which is to be set as parent; null/empty, removes the parent.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- if the parent is one of the child projects or is same as the project.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have permission to do this (only site admins can perform this operation)com.collabnet.ce.soap60.fault.ChangeParentNotAllowedFault
- if the project is system project (look project).com.collabnet.ce.soap60.fault.ParentRoleUsedInChildProjectsFault
- if any role of this or ancestor project is used by child of this project.com.collabnet.ce.soap60.fault.SystemFault
- unexpected errorRemoteException
com.collabnet.ce.soap60.types.SoapNamedValues getProjectHierarchyPaths(String sessionId, String[] projectIds) throws RemoteException
sessionId
- User session key.projectIds
- An array of project Ids.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs or if one of the projectIds passed is a Project Group's Id.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges on any of the given projects.RemoteException
long getCurrentTime(String sessionId) throws RemoteException
sessionId
- user session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.RemoteException
boolean canReceiveOwnUpdates(String sessionId) throws RemoteException
sessionId
- user session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when anything unexpected happen.RemoteException
ProjectGroupSoapDO createProjectGroup(String sessionId, String title, String description) throws RemoteException
sessionId
- User session key.title
- The title of the project groupdescription
- The description of the project groupcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.ObjectAlreadyExistsFault
- when the project group with that name already exists.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when invalid data was passed inRemoteException
void addProjectsToProjectGroup(String sessionId, String projectGroupId, String[] projectIds) throws RemoteException
sessionId
- the user session idprojectGroupId
- the project group idprojectIds
- the project idscom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.IllegalArgumentFault
- when invalid data was passed inRemoteException
ProjectGroupSoapList listProjectGroups(String sessionId) throws RemoteException
sessionId
- User session key.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
RemoteException
ProjectGroupSoapDO getProjectGroupData(String sessionId, String projectGroupId) throws RemoteException
sessionId
- user session idprojectGroupId
- project group Idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.RemoteException
void setProjectGroupData(String sessionId, ProjectGroupSoapDO projectGroupData) throws RemoteException
sessionId
- user session idprojectGroupData
- project group's ProjectGroupSoapDOcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.VersionMismatchFault
- when the project group version being edited is not the latest oneRemoteException
void addProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames) throws RemoteException
sessionId
- user session idprojectGroupId
- project group's idusernames
- The username of the users that need to be made as admins for this Project Groupcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid or if the projectGroupId is in fact not a Project Group's id.RemoteException
void removeProjectGroupAdmins(String sessionId, String projectGroupId, String[] usernames) throws RemoteException
sessionId
- user session idprojectGroupId
- project group's idusernames
- The username of the users that need to be made as admins for this Project Groupcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.RemoteException
ProjectSoapList getMemberProjectsForProjectGroup(String sessionId, String projectGroupId) throws RemoteException
sessionId
- the user session idprojectGroupId
- the project group idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the given projectGroupId does not exist.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void removeProjectsFromProjectGroup(String sessionId, String[] projectMemberIds, String projectGroupId) throws RemoteException
sessionId
- user session idprojectMemberIds
- project members in project groupprojectGroupId
- project group idcom.collabnet.ce.soap60.fault.InvalidSessionFault
com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.RemoteException
void removeProjectGroupMember(String sessionId, String projectGroupId, String userName) throws RemoteException
sessionId
- User session id.projectGroupId
- Id of the project group.userName
- Name of the new user.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.RemoveOnlyProjectAdminFault
- attempting to remove last project group adminRemoteException
ProjectGroupMemberSoapList getProjectGroupMemberList(String sessionId, String projectGroupId) throws RemoteException
sessionId
- User session id.projectGroupId
- Id of the project group.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified object id is invalid.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectGroupSoapList getProjectGroupsForProject(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- project idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
ProjectGroupSoapList getProjectGroupsForProject1(String sessionId, String projectId) throws RemoteException
sessionId
- User session id.projectId
- project idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- when the specified project id is invalid.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
void deleteProjectGroup(String sessionId, String projectGroupId, boolean forceDeleteEvenIfMemberProjectFound) throws RemoteException
sessionId
- User session key.projectGroupId
- The id of the project group to be deletedforceDeleteEvenIfMemberProjectFound
- delete the project group even if it has member project(s)com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- if we can't find the project group with the specified projectGroupIdcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- when the user has insufficient privileges.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.ChildProjectsFoundFault
- if the project group has any member project(s)RemoteException
UserSoapList listUsersWithPermissionOnObject(String sessionId, String operationString, String objectId, int flag) throws RemoteException
sessionId
- User sessionoperationString
- The string representation of the operation. This should be in the format <objectTypeName>.<operationCategory>.<operationName>. For a list of operation strings for various object types, see OperationConstants interface. For integrated application, this should be in the format PluggableLink.<id of the integrated app>.<permission name>.<permission name>.objectId
- The object to check permission for the users with access; It can't be nullflag
- either WITHOUT_SUPERUSERS or WITH_SUPERUSERS or WITH_PROJECT_MEMBERS or WITH_ASSIGNED_GROUP_MEMBERS or WITHOUT_GROUP_MEMBERScom.collabnet.ce.soap60.fault.InvalidSessionFault
- when the specified session id is invalid.com.collabnet.ce.soap60.fault.NoSuchObjectFault
- When the objectId is invalid or does not existcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If the operationString is in an invalid formatcom.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system level error occurs.com.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have project view permissionRemoteException
OperationConstants
,
UserSoapDO.WITHOUT_SUPERUSERS
,
UserSoapDO.WITH_SUPERUSERS
,
UserSoapDO.WITH_PROJECT_MEMBERS
,
UserSoapDO.WITH_ASSIGNED_GROUP_MEMBERS
,
UserSoapDO.WITHOUT_GROUP_MEMBERS
String getSessionId(String oneTimeToken) throws RemoteException
oneTimeToken
- a one time token for login.com.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrect.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String getJSessionId(String oneTimeToken) throws RemoteException
oneTimeToken
- a one time token for login.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.RemoteException
String getWebAndSoapSessionId(String oneTimeToken) throws RemoteException
oneTimeToken
- a one time token for login.com.collabnet.ce.soap60.fault.SystemFault
- when an unexpected system error occurs.com.collabnet.ce.soap60.fault.LoginFault
- when the login information is incorrectRemoteException
String getBroadCastMessage(String sessionId) throws RemoteException
sessionId
- the session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when fault occurs.RemoteException
String getJSessionBySoapId(String soapId) throws RemoteException
getJSessionId
soapId
- webservice soap idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when fault occurs.RemoteException
String getUserSessionBySoapId(String soapId) throws RemoteException
soapId
- webservice soap idcom.collabnet.ce.soap60.fault.InvalidSessionFault
- when fault occurs.RemoteException
String createSiteWideLinkedApp(String sessionId, String title, String applicationUrl, String applicationType, boolean singleSignon) throws RemoteException
title
- A name for the linked application, which appears on the linkapplicationUrl
- the location url of the linked applicationapplicationType
- determines how the linked app should appear The following are the valid options: 'same' - To open the linked app in same window and it takes over the entire browser window. 'new' - To open the linked app in a new window 'iframe' - To open the linked app in a box in the same window framed by Collabnet's headersingleSignon
- Whether single signon should be enabled. When its enabled the authentication is managed through CollabnetTeamForge authentication system. Users are not required to log into linked app after they have logged into TeamForge. When single sign on is not enabled users will be required to log in to the linked application using its native authentication system. Only site admin users can enable this. When non site admin users attempt to enable this, it will be set to false as default.com.collabnet.ce.soap60.fault.InvalidSessionFault
- When Session is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- When an attempt to retrieve the created linked app results in errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- If any arguments is of invalid formatcom.collabnet.ce.soap60.fault.SystemFault
- Any other exceptions, such as object already existscom.collabnet.ce.soap60.fault.PermissionDeniedFault
- If user does not have site admin permissionRemoteException
String createProjectLinkedApp(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon) throws RemoteException
sessionId
- user sessionprojectId
- id of the given projecttitle
- name for the linked application, which appears on the linkapplicationUrl
- the URL of the linked applicationsingleSignon
- indicates whether single signon should be enabled.iconKey
- the key of the icon (e.g. guid9baa2613b27278f720000c58). This key can be obtained from SimpleFileStorageApp SOAP that is used to upload the icon.iconFileName
- the file name of the icon (e.g. "iconFile.jpg")iconMimeType
- the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.com.collabnet.ce.soap60.fault.InvalidSessionFault
- whem sesion is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when an attempt to retrieve the created linked app results in errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if any argument is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have admin permissioncom.collabnet.ce.soap60.fault.SystemFault
- any other exceptionRemoteException
String createProjectLinkedApp2(String sessionId, String projectId, String title, String applicationUrl, String iconKey, String iconFileName, String iconMimeType, boolean singleSignon, String toolId) throws RemoteException
sessionId
- user sessionprojectId
- id of the given projecttitle
- name for the linked application, which appears on the linkapplicationUrl
- the URL of the linked applicationsingleSignon
- indicates whether single signon should be enabled.iconKey
- the key of the icon (e.g. guid9baa2613b27278f720000c58). This key can be obtained from SimpleFileStorageApp SOAP that is used to upload the icon.iconFileName
- the file name of the icon (e.g. "iconFile.jpg")toolId
- the id of tool in orchestrateiconMimeType
- the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.com.collabnet.ce.soap60.fault.InvalidSessionFault
- whem sesion is invalidcom.collabnet.ce.soap60.fault.NoSuchObjectFault
- when an attempt to retrieve the created linked app results in errorcom.collabnet.ce.soap60.fault.IllegalArgumentFault
- if any argument is invalidcom.collabnet.ce.soap60.fault.PermissionDeniedFault
- if the user does not have admin permissioncom.collabnet.ce.soap60.fault.SystemFault
- any other exceptionRemoteException
LinkedApplicationSoapDO getLinkedApplicationData(String sessionId, String linkedAppId) throws RemoteException
sessionId
- linkedAppId
- RemoteException
LinkedApplication2SoapDO getLinkedApplicationData2(String sessionId, String linkedAppId) throws RemoteException
sessionId
- linkedAppId
- RemoteException
void setLinkedApplicationData(String sessionId, LinkedApplicationSoapDO linkedApplicationSoapDO, String iconKey, String iconFileName, String iconMimeType) throws RemoteException
sessionId
- user sessionlinkedApplicationSoapDO
- the linkedApplication Data ObjecticonKey
- the key of the icon (e.g. guid9baa2613b27278f720000c58)iconFileName
- the file name of the icon (e.g. "iconFile.jpg")iconMimeType
- the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.RemoteException
void setLinkedApplicationData2(String sessionId, LinkedApplication2SoapDO linkedApplication2SoapDO, String iconKey, String iconFileName, String iconMimeType) throws RemoteException
sessionId
- user sessionlinkedApplication2SoapDO
- the linkedApplication Data ObjecticonKey
- the key of the icon (e.g. guid9baa2613b27278f720000c58)iconFileName
- the file name of the icon (e.g. "iconFile.jpg")iconMimeType
- the mime type of the icon (e.g. "image/jpg") Supported formats are: JPG, GIF and PNG.RemoteException
void deleteLinkedApp(String sessionId, String linkedAppId) throws RemoteException
sessionId
- the session idlinkedAppId
- - LinkedApplication Id which is requested to be deletedcom.collabnet.ce.soap60.fault.InvalidSessionFault
com.collabnet.ce.soap60.fault.NoSuchObjectFault
com.collabnet.ce.soap60.fault.IllegalArgumentFault
com.collabnet.ce.soap60.fault.PermissionDeniedFault
com.collabnet.ce.soap60.fault.SystemFault
RemoteException
LinkedApplicationSoapList listSiteWideLinkedApps(String sessionId) throws RemoteException
sessionId
- user sessionRemoteException
LinkedApplicationSoapList listProjectLinkedApps(String sessionId, String projectId) throws RemoteException
sessionId
- user sessionprojectId
- id of the given projectRemoteException
LinkedApplication2SoapList listProjectLinkedApps2(String sessionId, String projectId) throws RemoteException
sessionId
- user sessionprojectId
- id of the given projectRemoteException
boolean isSoapRedirectPostOnlyMode(String sessionId) throws RemoteException
sessionId
- Session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.RemoteException
String getOneTimeToken(String sessionId) throws RemoteException
sessionId
- Session id.com.collabnet.ce.soap60.fault.InvalidSessionFault
- when the user session ID is invalid or timed out.RemoteException
Copyright © 2016 CollabNet. All Rights Reserved.