|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RemoteApi
Defines the CodeBeamer RemoteService API. Please note: All methods throw an IllegalStateException if no RemoteSession is active or has expired
Method Summary | |
---|---|
void |
addUserToRole(java.lang.String token,
java.lang.Integer userId,
java.lang.Integer projectId,
java.lang.Integer roleId)
Adds the user to an existing portal-scope or project-scope role. |
ArtifactDto |
createAndUploadArtifact(java.lang.String token,
ArtifactDto artifact,
byte[] data,
java.lang.String comment,
java.lang.String commentFormat)
Creates a new file-type artifact and initializes its binary content. |
ArtifactDto |
createArtifact(java.lang.String token,
ArtifactDto artifact)
Creates a new artifact. |
ArtifactCommentDto |
createArtifactComment(java.lang.String token,
ArtifactCommentDto comment)
Creates a new artifact comment. |
AssociationDto |
createAssociation(java.lang.String token,
AssociationDto association)
Creates a new association. |
BuildDto |
createBuild(java.lang.String token,
BuildDto build)
Creates a new build. |
ForumDto |
createForum(java.lang.String token,
ForumDto forum)
Creates a new forum. |
ForumDto |
createForumFromTemplate(java.lang.String token,
ForumDto forum,
java.lang.Integer templateForumId)
Creates a new forum based on another forum as template. |
ForumPostDto |
createForumPost(java.lang.String token,
ForumPostDto post)
Creates a new forum post. |
LabelDto |
createLabel(java.lang.String token,
LabelDto label)
Creates a new label. |
ProjectDto |
createProject(java.lang.String token,
ProjectDto project)
Creates a new project. |
ProjectDto |
createProjectFromTemplate(java.lang.String token,
ProjectDto project,
java.lang.Integer templateProjectId)
Creates a new project from template. |
TrackerDto |
createTracker(java.lang.String token,
TrackerDto tracker)
Creates a new tracker. |
TrackerDto |
createTrackerFromTemplate(java.lang.String token,
TrackerDto tracker,
java.lang.Integer templateTrackerId)
Creates a new tracker based on another tracker as template. |
TrackerItemDto |
createTrackerItem(java.lang.String token,
TrackerItemDto item)
Creates a new tracker item. |
TrackerItemAttachmentDto |
createTrackerItemAttachment(java.lang.String token,
TrackerItemAttachmentDto attachment)
Creates a new tracker item attachment. |
TrackerItemCommentDto |
createTrackerItemComment(java.lang.String token,
TrackerItemCommentDto comment)
Creates a new tracker item comment. |
void |
createTrackerItemHistory(java.lang.String token,
TrackerItemHistoryEntryDto[] history)
Creates a batch of tracker item history entries at once |
void |
createTrackerItemHistoryEntry(java.lang.String token,
TrackerItemHistoryEntryDto historyEntry)
Creates a tracker item history entry. |
UserDto |
createUser(java.lang.String token,
UserDto user)
Creates a new user account. |
WikiPageDto |
createWikiPage(java.lang.String token,
WikiPageDto wikiPage,
java.lang.String content,
java.lang.String comment,
java.lang.String commentFormat)
Creates a new wiki page. |
WikiPageDto |
createWikiPage(java.lang.String token,
WikiPageDto wikiPage,
java.lang.String content,
java.lang.String comment,
java.lang.String commentFormat,
boolean rewriteLinks)
Creates a new wiki page with optional link rewriting. |
WikiPageCommentDto |
createWikiPageComment(java.lang.String token,
WikiPageCommentDto comment)
Creates a new wiki page comment. |
WorkingSetDto |
createWorkingSet(java.lang.String token,
WorkingSetDto workingSet,
java.lang.Integer[] projectIds)
Creates new working set. |
void |
deleteArtifact(java.lang.String token,
java.lang.Integer artifactId)
Deletes an existing artifact. |
void |
deleteArtifactComment(java.lang.String token,
java.lang.Integer commentId)
Deletes an existing artifact comment. |
void |
deleteAssociation(java.lang.String token,
java.lang.Integer associationId)
Deletes an existing association. |
void |
deleteBuild(java.lang.String token,
java.lang.Integer buildId)
Deletes an existing build. |
void |
deleteForum(java.lang.String token,
java.lang.Integer forumId)
Deletes an existing forum. |
void |
deleteForumPost(java.lang.String token,
java.lang.Integer forumPostId)
Deletes an existing forum post. |
void |
deleteLabel(java.lang.String token,
java.lang.Integer labelId)
Deletes an existing label. |
void |
deleteProject(java.lang.String token,
java.lang.Integer projectId)
Deletes an existing project. |
void |
deleteTracker(java.lang.String token,
java.lang.Integer trackerId)
Deletes an existing tracker. |
void |
deleteTrackerChoiceOptions(java.lang.String token,
java.lang.Integer trackerId)
Deletes the choice options for all the fields in the tracker with the given identifier. |
void |
deleteTrackerItem(java.lang.String token,
java.lang.Integer trackerItemId)
Deletes an existing tracker item. |
void |
deleteTrackerItemAttachment(java.lang.String token,
java.lang.Integer attachmentId)
Deletes an existing tracker item attachment. |
void |
deleteTrackerItemComment(java.lang.String token,
java.lang.Integer commentId)
Deletes an existing tracker item comment. |
void |
deleteUser(java.lang.String token,
java.lang.Integer userId)
Deletes an existing user account. |
void |
deleteWikiPage(java.lang.String token,
java.lang.Integer wikiPageId)
Deletes an existing wiki page. |
void |
deleteWikiPageComment(java.lang.String token,
java.lang.Integer commentId)
Deletes an existing wiki page comment. |
void |
deleteWorkingSet(java.lang.String token,
java.lang.Integer workingSetId)
Deletes an existing working set. |
byte[] |
downloadArtifact(java.lang.String token,
java.lang.Integer artifactId)
Returns the binary content of a file-type artifact or null otherwise. |
byte[] |
downloadArtifactRevision(java.lang.String token,
java.lang.Integer artifactId,
java.lang.String revision)
Returns the binary content of a file-type artifact given revision or null otherwise. |
java.lang.String |
downloadWikiPage(java.lang.String token,
java.lang.Integer wikiPageId,
boolean render)
Returns the content of the latest revision of a wiki page. |
byte[] |
downloadWikiPageInExternalFormat(java.lang.String token,
java.lang.Integer wikiPageId)
Returns the content of the latest revision of a wiki page in external format. |
byte[] |
executeAndDownloadReport(java.lang.String token,
java.lang.Integer reportId,
int format,
boolean exportComments,
boolean exportDescriptions,
java.lang.String recordSeparator,
java.lang.String fieldSeparator)
Executes the report with the given identifier and returns the binary representation of report file. |
BuildLogDto |
executeBuildById(java.lang.String token,
java.lang.Integer buildId)
Executes the build with the given identifier. |
TrackerItemDto[][] |
executeReport(java.lang.String token,
java.lang.Integer reportId)
Executes the report with the given identifier. |
AssociationDto[] |
findAllAssociations(java.lang.String token)
Returns all the associations related to any kind of entities. |
LabelDto[] |
findAllPrivateLabels(java.lang.String token)
Returns all the private labels of the given user. |
ProjectDto[] |
findAllProjects(java.lang.String token)
Returns all the projects. |
LabelDto[] |
findAllPublicLabels(java.lang.String token)
Returns all the public labels. |
TrackerDto[] |
findAllTrackers(java.lang.String token)
Returns all the trackers. |
UserDto[] |
findAllUsers(java.lang.String token)
Returns all the user accounts. |
TrackerItemDto[] |
findAllUserTrackerItems(java.lang.String token)
Returns all the tracker items related to (assigned to or submitted by) the given user. |
WorkingSetDto[] |
findAllWorkingSets(java.lang.String token)
Returns all working sets available for the user. |
ArtifactDto |
findArtifactById(java.lang.String token,
java.lang.Integer artifactId)
Returns the artifact with the given identifier. |
ArtifactCommentDto |
findArtifactCommentById(java.lang.String token,
java.lang.Integer commentId)
Returns the artifact comment with the given identifier. |
ArtifactCommentDto[] |
findArtifactCommentsByArtifactId(java.lang.String token,
java.lang.Integer artifactId)
Returns all the artifact comments from the given artifact. |
ArtifactHistoryEntryDto[] |
findArtifactHistory(java.lang.String token,
java.lang.Integer artifactId)
Returns the history records of the given artifact, beginning with the most recent one. |
ArtifactDto[] |
findArtifactsByParentArtifact(java.lang.String token,
java.lang.Integer parentArtifactId)
Returns all the artifacts that are children of the given directory-type artifact. |
AssociationDto |
findAssociationById(java.lang.String token,
java.lang.Integer associationId)
Returns the association with the given identifier. |
AssociationDto[] |
findAssociationsByEntity(java.lang.String token,
java.lang.Integer entityTypeId,
java.lang.Integer entityId,
boolean bidirectional)
Returns the associations related to the given entity. |
BuildDto |
findBuildById(java.lang.String token,
java.lang.Integer buildId)
Returns the build with the given identifier. |
BuildLogDto[] |
findBuildLogsByBuildId(java.lang.String token,
java.lang.Integer buildId,
long startTime)
Returns the most recent build log of the build with the given identifier. |
BuildDto[] |
findBuildsByProjectId(java.lang.String token,
java.lang.Integer projectId)
Returns all the builds that belong to the project with the given identifier. |
BuildStatsDto |
findBuildStatsByBuildId(java.lang.String token,
java.lang.Integer buildId)
Returns the statistics for the given build. |
BuildStatsDto |
findBuildStatsByProjectId(java.lang.String token,
java.lang.Integer projectId)
Returns the aggregated build statistics for the given project. |
ScmChangeSetDto[] |
findCommitsByTrackerItem(java.lang.String token,
java.lang.Integer trackerItemId)
Returns all change-sets related to the tracker item with the given identifier. |
ScmChangeSetDto[] |
findCommitsByTrackerItems(java.lang.String token,
java.lang.Integer[] trackerItemIds)
Returns all change-sets related to the tracker items with the given IDs. |
EntityLabelDto[] |
findEntititesByLabel(java.lang.String token,
java.lang.Integer labelId)
Returns all the entities which the given label is assigned to. |
EntityReferenceDto[] |
findEntityReferencesBySource(java.lang.String token,
java.lang.Integer fromTypeId,
java.lang.Integer fromId)
Returns the entity references with the given source end. |
EntityReferenceDto[] |
findEntityReferencesByTarget(java.lang.String token,
java.lang.Integer toTypeId,
java.lang.Integer toId)
Returns the entity references with the given target end. |
ForumDto |
findForumById(java.lang.String token,
java.lang.Integer forumId)
Returns the forum with the given identifier. |
ForumPostDto |
findForumPostById(java.lang.String token,
java.lang.Integer forumPostId)
Returns the forum post with the given identifier. |
ForumPostDto[] |
findForumPostsByForum(java.lang.String token,
java.lang.Integer forumId,
int maxCount)
Returns the most recent forum posts that were posted to the forum with the given identifier. |
ForumDto[] |
findForumsByProject(java.lang.String token,
java.lang.Integer projectId)
Returns all the forums that belong to the project with the given identifier. |
LabelDto |
findLabelById(java.lang.String token,
java.lang.Integer labelId)
Returns the label with the given identifier. |
EntityLabelDto[] |
findLabelsByEntity(java.lang.String token,
java.lang.Integer entityTypeId,
java.lang.Integer entityId)
Returns all the labels assigned to the given entity: these include all the public labels, and all the private labels of the current remote user. |
PermissionDto |
findPermissionByName(java.lang.String token,
java.lang.String permissionName)
Returns the permission with the given name. |
PermissionDto[] |
findPermissionsByNames(java.lang.String token,
java.lang.String[] permissionNames)
Returns the permissions with the given names. |
ReferableDto[] |
findPossibleReferenceFieldValues(java.lang.String token,
java.lang.Integer trackerId,
java.lang.Integer fieldId)
Get the possible values for a reference/dynamic choice field. |
ProjectDto |
findProjectById(java.lang.String token,
java.lang.Integer projectId)
Returns the project with the given identifier. |
ProjectDto |
findProjectByName(java.lang.String token,
java.lang.String projectName)
Returns the project with the given name. |
ProjectDto[] |
findProjectsByWorkingSet(java.lang.String token,
java.lang.Integer workingSetId)
Returns all projects defined in the working sets. |
ArtifactDto[] |
findReportsByProject(java.lang.String token,
java.lang.Integer projectId)
Returns all reports in the project with the given identifier. |
RoleDto[] |
findRolesByProject(java.lang.String token,
java.lang.Integer projectId)
Returns all the roles defined for the portal or for the project with the given identifier. |
RoleDto[] |
findRolesByProjectAndUser(java.lang.String token,
java.lang.Integer projectId,
java.lang.Integer userId)
Returns all the roles that user is assigned to on portal-scope or in the project with the given identifier. |
SourceFileDto |
findSourceFileById(java.lang.String token,
java.lang.Integer sourceFileId)
Returns the source code file with the given identifier. |
SourceFileDto |
findSourceFileByProjectAndPath(java.lang.String token,
java.lang.Integer projectId,
java.lang.String path)
Returns the source code file with the given path, in the project with the given identifier. |
SourceFileDto[] |
findSourceFilesByProject(java.lang.String token,
java.lang.Integer projectId)
Returns all the source code files in the project with the given identifier. |
SourceFileDto[] |
findSourceFilesByProjectsAndFileNamePattern(java.lang.String token,
java.lang.Integer[] projectIds,
java.lang.String likePattern)
Returns the source files that match the like-expression search criteria in the specified projects. |
ForumStatsDto |
findStatsByForumId(java.lang.String token,
java.lang.Integer forumId)
Returns the basic statistics of the forum with the given identifier for the currently signed-in user or null if the forum is not accessible. |
TrackerStatsDto |
findStatsByTrackerId(java.lang.String token,
java.lang.Integer trackerId)
Returns the basic statistics of the tracker with the given identifier for the currently signed-in user or null if the tracker is not accessible. |
ArtifactDto[] |
findTopArtifactsByProject(java.lang.String token,
java.lang.Integer projectId)
Returns the top-level artifacts (items in the "root") of the given project. |
WikiPageDto[] |
findTopWikiPagesByProject(java.lang.String token,
java.lang.Integer projectId)
Returns the top-level wiki pages (pages in the "root") of the given project. |
TrackerDto |
findTrackerById(java.lang.String token,
java.lang.Integer trackerId)
Returns the tracker with the given identifier. |
TrackerChoiceOptionDto[] |
findTrackerChoiceOptions(java.lang.String token,
java.lang.Integer trackerId,
java.lang.Integer fieldId)
Returns the possible choices for a field in the given tracker or zero-length array if there are no choice options for the field. |
TrackerItemAttachmentDto |
findTrackerItemAttachmentById(java.lang.String token,
java.lang.Integer attachmentId)
Returns the tracker item attachment with the given identifier. |
TrackerItemAttachmentDto[] |
findTrackerItemAttachmentsByTrackerItemId(java.lang.String token,
java.lang.Integer trackerItemId)
Returns all the tracker item attachments from the given tracker item. |
TrackerItemDto |
findTrackerItemById(java.lang.String token,
java.lang.Integer trackerItemId)
Returns the tracker item with the given identifier. |
TrackerItemCommentDto |
findTrackerItemCommentById(java.lang.String token,
java.lang.Integer commentId)
Returns the tracker item comment with the given identifier. |
TrackerItemCommentDto[] |
findTrackerItemCommentsByTrackerItemId(java.lang.String token,
java.lang.Integer trackerItemId)
Returns all the tracker item comments from the given tracker item. |
TrackerItemHistoryEntryDto[] |
findTrackerItemHistory(java.lang.String token,
java.lang.Integer trackerItemId)
Returns the history records of the given tracker item, beginning with the most recent one. |
TrackerItemDto[] |
findTrackerItemsByTrackerId(java.lang.String token,
java.lang.Integer trackerId)
Returns all the tracker items from the given tracker. |
TrackerItemDto[] |
findTrackerItemsByTrackerIdAndUserId(java.lang.String token,
java.lang.Integer trackerId,
java.lang.Integer userId)
Returns all the tracker items from the given tracker, submitted by and/or assigned to the given user. |
TrackerStatsDto[] |
findTrackerItemStatsByTrackers(java.lang.String token,
java.lang.Integer[] trackerIds)
Returns tracker item statistics related to given trackers and to the current user. |
TrackerLayoutDto |
findTrackerLayout(java.lang.String token,
java.lang.Integer trackerId)
Returns the layout of the tracker with the given identifier. |
TrackerDto[] |
findTrackersByProject(java.lang.String token,
java.lang.Integer projectId)
Returns all the trackers that belong to the project with the given identifier. |
UserDto |
findUserById(java.lang.String token,
java.lang.Integer userId)
Returns the user account with the given identifier. |
PermissionDto[] |
findUserPermissions(java.lang.String token)
Returns all global permissions that are granted for the current user. |
PermissionDto[] |
findUserPermissionsByEntity(java.lang.String token,
java.lang.Integer entityTypeId,
java.lang.Integer entityId)
Returns all permissions on the given entity that are granted for the current user. |
UserDto[] |
findUsersByIds(java.lang.String token,
java.lang.Integer[] userIds)
Returns the user accounts with the given identifiers. |
UserDto[] |
findUsersByProject(java.lang.String token,
java.lang.Integer projectId,
boolean includeLinkedRoles)
Returns all the user accounts who are stakeholders in the project with the given identifier. |
UserTrackerItemStatsDto |
findUserTrackerItemStats(java.lang.String token)
Returns tracker item statistics related to the current user. |
WikiPageDto |
findWikiPageById(java.lang.String token,
java.lang.Integer wikiPageId)
Returns the wiki page with the given identifier. |
WikiPageDto |
findWikiPageByProjectAndName(java.lang.String token,
java.lang.Integer projectId,
java.lang.String name)
Returns the wiki page with the given name in the project with the given identifier or null if not found. |
WikiPageCommentDto |
findWikiPageCommentById(java.lang.String token,
java.lang.Integer commentId)
Returns the wiki page comment with the given identifier. |
WikiPageCommentDto[] |
findWikiPageCommentsByWikiPageId(java.lang.String token,
java.lang.Integer wikiPageId)
Returns all the wiki page comments from the given wiki page. |
ArtifactHistoryEntryDto[] |
findWikiPageHistory(java.lang.String token,
java.lang.Integer wikiPageId)
Returns the history records of the given wiki page, beginning with the most recent one. |
WikiPageDto[] |
findWikiPagesByParentWikiPage(java.lang.String token,
java.lang.Integer parentWikiPageId)
Returns all the wiki pages that are children of the given wiki page. |
WorkingSetDto |
findWorkingSetById(java.lang.String token,
java.lang.Integer workingSetId)
Returns a working set by the given id. |
ProjectPreferencesDto |
getProjectPreferences(java.lang.String token,
java.lang.Integer projectId)
Returns the preferences of the project with the given identifier. |
java.util.List<ProjectDto> |
getSelectedWorkingSetProjects(java.lang.String token)
Get the projects in the currently selected workingset. |
ServerInfo |
getServerInfo()
Returns general information about the remote server. |
java.lang.String |
getSessionLastRequestId(java.lang.String token)
Returns the unique identifier of the last request in this session |
UserDto |
getSessionUser(java.lang.String token)
Returns the user who is currently logged in |
boolean |
hasUserPermission(java.lang.String token,
java.lang.Integer permissionId)
Returns whether the current user has a global permission granted. |
boolean |
hasUserPermissionOnEntity(java.lang.String token,
java.lang.Integer permissionId,
java.lang.Integer entityTypeId,
java.lang.Integer entityId)
Returns whether the current user has a permission on the given entity granted. |
BinaryStreamDto |
loadArtifactCommentBlob(java.lang.String token,
java.lang.Integer abstractCommentDtoId)
Load the blob info from the ArtifactCommentDto's table |
BinaryStreamDto |
loadForumPostBlob(java.lang.String token,
java.lang.Integer forumPostId)
Load the blob info from the ForumPostDto's table |
BinaryStreamDto |
loadTrackerItemAttachmentBlob(java.lang.String token,
java.lang.Integer trackerItemAttachmentDtoId)
Load the blob info from the TrackerItemAttachmentDto's table |
java.lang.String |
login(java.lang.String username,
java.lang.String password)
This is the very first method the client has to call. |
void |
logout(java.lang.String token)
Terminates the remote session. |
void |
removeTrackerItem(java.lang.String token,
java.lang.Integer trackerItemId)
Logically deletes an existing tracker item. |
void |
removeUserFromRole(java.lang.String token,
java.lang.Integer userId,
java.lang.Integer projectId,
java.lang.Integer roleId)
Removes the user from a portal-scope or project-scope role (but will not delete the role). |
java.lang.String |
renderContent(java.lang.String token,
java.lang.String wikiMarkupText)
Renders wiki markup text into HTML markup output. |
void |
saveArtifactCommentBlob(java.lang.String token,
java.lang.Integer abstractCommentDtoId,
BinaryStreamDto binaryStreamDto)
Save blob data to the ArtifactCommentDto's table |
void |
saveForumPostBlob(java.lang.String token,
java.lang.Integer forumPostId,
BinaryStreamDto binaryStreamDto)
Save blob data to the ForumPostDto's table |
void |
saveTrackerItemAttachmentBlob(java.lang.String token,
java.lang.Integer trackerItemAttachmentDtoId,
BinaryStreamDto binaryStreamDto)
Save blob data to the TrackerItemAttachmentDto's table |
void |
selectWorkingSet(java.lang.String token,
java.lang.Integer workingSetId)
Select a workingSet. |
void |
setArtifactLock(java.lang.String token,
java.lang.Integer artifactId,
boolean lock)
Sets or releases a hard lock for the given artifact. |
void |
setArtifactLock(java.lang.String token,
java.lang.Integer artifactId,
boolean lock,
boolean hard)
Sets or releases a soft- or hard lock for the given artifact. |
void |
setEntityLabels(java.lang.String token,
java.lang.Integer entityTypeId,
java.lang.Integer entityId,
LabelDto[] labels)
Sets the labels assigned to the given entity. |
void |
setProjectPreferences(java.lang.String token,
ProjectPreferencesDto projectPreferences)
Sets the preferences for the given project. |
void |
setTrackerChoiceOptions(java.lang.String token,
java.util.List choiceOptions)
Creates new choice options. |
void |
updateArtifact(java.lang.String token,
ArtifactDto artifact)
Updates an existing artifact. |
void |
updateArtifactComment(java.lang.String token,
ArtifactCommentDto comment)
Updates an existing artifact comment. |
void |
updateAssociation(java.lang.String token,
AssociationDto association)
Updates an existing association. |
void |
updateBuild(java.lang.String token,
BuildDto build)
Updates an existing build. |
void |
updateForumPost(java.lang.String token,
ForumPostDto post)
Updates an existing forum post. |
void |
updateLabel(java.lang.String token,
LabelDto label)
Updates an existing label. |
void |
updateProject(java.lang.String token,
ProjectDto project)
Updates an existing project. |
void |
updateTracker(java.lang.String token,
TrackerDto tracker)
Updates an existing tracker. |
void |
updateTrackerItem(java.lang.String token,
TrackerItemDto item)
Updates an existing tracker item. |
void |
updateTrackerItemAsModified(java.lang.String token,
TrackerItemDto item)
Updates the modifiedAt and modifietAt properties an existing tracker item. |
void |
updateTrackerItemAttachment(java.lang.String token,
TrackerItemAttachmentDto attachment)
Updates an existing tracker item attachment. |
void |
updateTrackerItemComment(java.lang.String token,
TrackerItemCommentDto comment)
Updates an existing tracker item comment. |
void |
updateTrackerLayout(java.lang.String token,
TrackerLayoutDto trackerLayout)
Updates the layout of an existing tracker. |
void |
updateUser(java.lang.String token,
UserDto user)
Updates an existing user account. |
void |
updateWikiPage(java.lang.String token,
WikiPageDto wikiPage)
Updates an existing wiki page. |
void |
updateWikiPageComment(java.lang.String token,
WikiPageCommentDto comment)
Updates an existing wiki page comment. |
void |
updateWorkingSet(java.lang.String token,
WorkingSetDto workingSet,
java.lang.Integer[] projectIds)
Updates an existing working set. |
void |
uploadArtifact(java.lang.String token,
java.lang.Integer artifactId,
byte[] data,
java.lang.String comment,
java.lang.String commentFormat,
java.lang.String checksum)
Stores binary content to a file-type artifact. |
void |
uploadArtifactTemporary(java.lang.String token,
java.lang.Integer artifactId,
byte[] data,
java.lang.String checksum)
Uploads artifact content to the temporary space. |
void |
uploadWikiPage(java.lang.String token,
java.lang.Integer wikiPageId,
java.lang.String content,
java.lang.String comment,
java.lang.String commentFormat)
Saves new content to an existing wiki page. |
void |
uploadWikiPage(java.lang.String token,
java.lang.Integer wikiPageId,
java.lang.String content,
java.lang.String comment,
java.lang.String commentFormat,
boolean rewriteLinks)
Saves new content to an existing wiki page with optional link rewriting. |
void |
uploadWikiPageInExternalFormat(java.lang.String token,
java.lang.Integer wikiPageId,
byte[] content,
java.lang.String comment,
java.lang.String commentFormat,
java.lang.String checksum)
Stores new content to an existing wiki page. |
Method Detail |
---|
ServerInfo getServerInfo()
java.lang.String login(java.lang.String username, java.lang.String password)
java.security.AccessControlException
- if login is deniedvoid logout(java.lang.String token)
UserDto getSessionUser(java.lang.String token)
java.lang.IllegalStateException
- if no active session existsjava.lang.String getSessionLastRequestId(java.lang.String token)
java.lang.IllegalStateException
- if no active session existsUserDto createUser(java.lang.String token, UserDto user) throws ChangeVetoedException
ChangeVetoedException
void deleteUser(java.lang.String token, java.lang.Integer userId) throws ChangeVetoedException
userId
- identifier of the user account.
ChangeVetoedException
void updateUser(java.lang.String token, UserDto user) throws ChangeVetoedException
ChangeVetoedException
UserDto[] findAllUsers(java.lang.String token)
UserDto findUserById(java.lang.String token, java.lang.Integer userId)
userId
- identifier of the user account.UserDto[] findUsersByIds(java.lang.String token, java.lang.Integer[] userIds)
userIds
- identifiers of the user accounts.UserDto[] findUsersByProject(java.lang.String token, java.lang.Integer projectId, boolean includeLinkedRoles)
projectId
- identifier of the project.includeLinkedRoles
- if false
then only actual members will be returned.
If true
then the result includes also those users who are not members,
but can access the project through their group membership.ProjectDto createProject(java.lang.String token, ProjectDto project) throws AccessRightsException, ChangeVetoedException
AccessRightsException
ChangeVetoedException
ProjectDto createProjectFromTemplate(java.lang.String token, ProjectDto project, java.lang.Integer templateProjectId) throws AccessRightsException, ChangeVetoedException
templateProjectId
- the template project identifier.
AccessRightsException
ChangeVetoedException
void deleteProject(java.lang.String token, java.lang.Integer projectId) throws AccessRightsException, ChangeVetoedException
projectId
- identifier of the project.
AccessRightsException
ChangeVetoedException
void updateProject(java.lang.String token, ProjectDto project) throws AccessRightsException, ChangeVetoedException
project
- the project to be updated.
AccessRightsException
ChangeVetoedException
ProjectPreferencesDto getProjectPreferences(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.void setProjectPreferences(java.lang.String token, ProjectPreferencesDto projectPreferences) throws AccessRightsException
AccessRightsException
ProjectDto[] findAllProjects(java.lang.String token)
ProjectDto findProjectById(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.ProjectDto findProjectByName(java.lang.String token, java.lang.String projectName)
projectName
- name of the project.void addUserToRole(java.lang.String token, java.lang.Integer userId, java.lang.Integer projectId, java.lang.Integer roleId)
userId
- identifier of the user account to add to the role.projectId
- if null
, role will be treated as portal-scope.void removeUserFromRole(java.lang.String token, java.lang.Integer userId, java.lang.Integer projectId, java.lang.Integer roleId)
userId
- identifier of the user account to remove from the role.projectId
- if null
, role will be treated as portal-scope.RoleDto[] findRolesByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- if null
, portal-scope roles will be returned.RoleDto[] findRolesByProjectAndUser(java.lang.String token, java.lang.Integer projectId, java.lang.Integer userId)
projectId
- if null
, portal-scope roles will be returned.PermissionDto findPermissionByName(java.lang.String token, java.lang.String permissionName)
permissionName
- see the constants in PermissionDto
.PermissionDto[] findPermissionsByNames(java.lang.String token, java.lang.String[] permissionNames)
permissionNames
- see the constants in PermissionDto
.boolean hasUserPermission(java.lang.String token, java.lang.Integer permissionId)
boolean hasUserPermissionOnEntity(java.lang.String token, java.lang.Integer permissionId, java.lang.Integer entityTypeId, java.lang.Integer entityId)
entityTypeId
- is one of the constants defined in GroupType
.PermissionDto[] findUserPermissions(java.lang.String token)
PermissionDto[] findUserPermissionsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId)
entityTypeId
- is one of the constants defined in GroupType
.ArtifactDto createArtifact(java.lang.String token, ArtifactDto artifact) throws AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
ArtifactDto createAndUploadArtifact(java.lang.String token, ArtifactDto artifact, byte[] data, java.lang.String comment, java.lang.String commentFormat) throws AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
data
- binary content of the artifact.
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
DescriptionFormat
void deleteArtifact(java.lang.String token, java.lang.Integer artifactId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
artifactId
- identifier of the artifact.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void updateArtifact(java.lang.String token, ArtifactDto artifact) throws AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
uploadArtifact(String, Integer, byte[], String, String, String)
void uploadArtifact(java.lang.String token, java.lang.Integer artifactId, byte[] data, java.lang.String comment, java.lang.String commentFormat, java.lang.String checksum) throws AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
artifactId
- identifier of the artifact.data
- binary content of the artifact.comment
- checkin comment.commentFormat
- checkin comment format.checksum
- is a MD5 data checksum, or null
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
DescriptionFormat
void uploadArtifactTemporary(java.lang.String token, java.lang.Integer artifactId, byte[] data, java.lang.String checksum) throws DocumentSccException, AccessRightsException
artifactId
- data
- checksum
- is a MD5 data checksum, or null
DocumentSccException
AccessRightsException
byte[] downloadArtifact(java.lang.String token, java.lang.Integer artifactId) throws DocumentSccException
null
otherwise.
artifactId
- identifier of the artifact.
DocumentSccException
byte[] downloadArtifactRevision(java.lang.String token, java.lang.Integer artifactId, java.lang.String revision) throws DocumentSccException
null
otherwise.
artifactId
- identifier of the artifact.revision
- revision number.
DocumentSccException
ArtifactDto[] findTopArtifactsByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.ArtifactDto[] findArtifactsByParentArtifact(java.lang.String token, java.lang.Integer parentArtifactId)
parentArtifactId
- identifier of the parent directory-type artifactArtifactDto findArtifactById(java.lang.String token, java.lang.Integer artifactId)
artifactId
- identifier of the artifact.ArtifactHistoryEntryDto[] findArtifactHistory(java.lang.String token, java.lang.Integer artifactId)
artifactId
- identifier of the artifact.void setArtifactLock(java.lang.String token, java.lang.Integer artifactId, boolean lock)
artifactId
- identifier of the artifact.lock
- is whether to lock (true
) or unlock (false
) it.void setArtifactLock(java.lang.String token, java.lang.Integer artifactId, boolean lock, boolean hard)
artifactId
- identifier of the artifact.lock
- is whether to lock (true
) or unlock (false
) it.hard
- is whether to work on a hard- (true
) or soft lock (false
).ArtifactCommentDto createArtifactComment(java.lang.String token, ArtifactCommentDto comment)
comment
- encapsulates also the binary content (attachment) of the comment.
void deleteArtifactComment(java.lang.String token, java.lang.Integer commentId)
commentId
- identifier of the artifact comment.void updateArtifactComment(java.lang.String token, ArtifactCommentDto comment)
comment
- encapsulates also the binary content (attachment) of the comment.ArtifactCommentDto findArtifactCommentById(java.lang.String token, java.lang.Integer commentId)
commentId
- identifier of the artifact comment.ArtifactCommentDto[] findArtifactCommentsByArtifactId(java.lang.String token, java.lang.Integer artifactId)
artifactId
- identifier of the artifact.TrackerDto createTracker(java.lang.String token, TrackerDto tracker) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
TrackerDto createTrackerFromTemplate(java.lang.String token, TrackerDto tracker, java.lang.Integer templateTrackerId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
templateTrackerId
- the template tracker identifier.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void deleteTracker(java.lang.String token, java.lang.Integer trackerId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
trackerId
- identifier of the tracker.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void updateTracker(java.lang.String token, TrackerDto tracker) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
TrackerDto[] findAllTrackers(java.lang.String token)
TrackerDto findTrackerById(java.lang.String token, java.lang.Integer trackerId)
trackerId
- identifier of the tracker.TrackerDto[] findTrackersByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.void updateTrackerLayout(java.lang.String token, TrackerLayoutDto trackerLayout) throws AccessRightsException
AccessRightsException
TrackerLayoutDto findTrackerLayout(java.lang.String token, java.lang.Integer trackerId)
trackerId
- identifier of the tracker.void setTrackerChoiceOptions(java.lang.String token, java.util.List choiceOptions) throws AccessRightsException
choiceOptions
- is a List
of TrackerChoiceOptionDto
objects.
AccessRightsException
void deleteTrackerChoiceOptions(java.lang.String token, java.lang.Integer trackerId) throws AccessRightsException
AccessRightsException
TrackerChoiceOptionDto[] findTrackerChoiceOptions(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer fieldId)
trackerId
- identifier of the tracker.fieldId
- identifier of the field. See the constants in TrackerLayoutLabelDto
.ReferableDto[] findPossibleReferenceFieldValues(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer fieldId) throws AccessRightsException
findTrackerChoiceOptions()
method instead.
TODO: be careful, the result data can be huge (like all issues in a tracker)!
trackerId
- The identifier of the trackerfieldId
- identifier of the field. See the constants in TrackerLayoutLabelDto
.
java.lang.IllegalArgumentException
- If the tracker or field is not found, or when the field is not a dynamic-choice field.
AccessRightsException
- Thrown if the user has no permission to edit this field, thus not returning possible valuesTrackerStatsDto findStatsByTrackerId(java.lang.String token, java.lang.Integer trackerId)
null
if the tracker is not accessible.
trackerId
- identifier of the tracker.TrackerItemDto createTrackerItem(java.lang.String token, TrackerItemDto item) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException, java.util.concurrent.TimeoutException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException
void deleteTrackerItem(java.lang.String token, java.lang.Integer trackerItemId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException, java.util.concurrent.TimeoutException
trackerItemId
- identifier of the tracker item.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException
removeTrackerItem(String, Integer)
void updateTrackerItem(java.lang.String token, TrackerItemDto item) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException, java.util.concurrent.TimeoutException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
java.util.concurrent.TimeoutException
void updateTrackerItemAsModified(java.lang.String token, TrackerItemDto item) throws java.lang.IllegalArgumentException, AccessRightsException
modifiedAt
and modifietAt
properties an existing tracker item.
It requires System Administrator access rights.
The properties inaccessible by the remote user are ignored.
java.lang.IllegalArgumentException
AccessRightsException
void removeTrackerItem(java.lang.String token, java.lang.Integer trackerItemId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException, java.util.concurrent.TimeoutException
java.util.concurrent.TimeoutException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
deleteTrackerItem(String, Integer)
TrackerItemDto[] findAllUserTrackerItems(java.lang.String token)
TrackerItemDto[] findTrackerItemsByTrackerId(java.lang.String token, java.lang.Integer trackerId)
trackerId
- identifier of the tracker.TrackerItemDto findTrackerItemById(java.lang.String token, java.lang.Integer trackerItemId)
trackerItemId
- identifier of the tracker item.TrackerItemDto[] findTrackerItemsByTrackerIdAndUserId(java.lang.String token, java.lang.Integer trackerId, java.lang.Integer userId)
trackerId
- identifier of the tracker.userId
- identifier of the user.void createTrackerItemHistoryEntry(java.lang.String token, TrackerItemHistoryEntryDto historyEntry)
historyEntry
- the history entry to createvoid createTrackerItemHistory(java.lang.String token, TrackerItemHistoryEntryDto[] history)
history
- is the array of tracker item history entries to createTrackerItemHistoryEntryDto[] findTrackerItemHistory(java.lang.String token, java.lang.Integer trackerItemId)
trackerItemId
- identifier of the tracker item.UserTrackerItemStatsDto findUserTrackerItemStats(java.lang.String token)
TrackerStatsDto[] findTrackerItemStatsByTrackers(java.lang.String token, java.lang.Integer[] trackerIds)
TrackerItemCommentDto createTrackerItemComment(java.lang.String token, TrackerItemCommentDto comment) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void deleteTrackerItemComment(java.lang.String token, java.lang.Integer commentId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
commentId
- identifier of the tracker item comment.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void updateTrackerItemComment(java.lang.String token, TrackerItemCommentDto comment) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
TrackerItemCommentDto findTrackerItemCommentById(java.lang.String token, java.lang.Integer commentId) throws AccessRightsException
commentId
- identifier of the tracker item comment.
AccessRightsException
TrackerItemCommentDto[] findTrackerItemCommentsByTrackerItemId(java.lang.String token, java.lang.Integer trackerItemId) throws AccessRightsException
trackerItemId
- identifier of the tracker item.
AccessRightsException
TrackerItemAttachmentDto createTrackerItemAttachment(java.lang.String token, TrackerItemAttachmentDto attachment) throws java.lang.IllegalArgumentException, AccessRightsException
attachment
- encapsulates also the binary content of the attachment.
java.lang.IllegalArgumentException
AccessRightsException
void deleteTrackerItemAttachment(java.lang.String token, java.lang.Integer attachmentId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
attachmentId
- identifier of the tracker item attachment.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void updateTrackerItemAttachment(java.lang.String token, TrackerItemAttachmentDto attachment) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
attachment
- encapsulates also the binary content of the attachment.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
TrackerItemAttachmentDto findTrackerItemAttachmentById(java.lang.String token, java.lang.Integer attachmentId) throws AccessRightsException
attachmentId
- identifier of the tracker item attachment.
AccessRightsException
TrackerItemAttachmentDto[] findTrackerItemAttachmentsByTrackerItemId(java.lang.String token, java.lang.Integer trackerItemId) throws AccessRightsException
trackerItemId
- identifier of the tracker item.
AccessRightsException
AssociationDto createAssociation(java.lang.String token, AssociationDto association) throws ChangeVetoedException
ChangeVetoedException
void deleteAssociation(java.lang.String token, java.lang.Integer associationId) throws ChangeVetoedException
associationId
- identifier of the association.
ChangeVetoedException
void updateAssociation(java.lang.String token, AssociationDto association) throws ChangeVetoedException
ChangeVetoedException
AssociationDto[] findAllAssociations(java.lang.String token)
AssociationDto findAssociationById(java.lang.String token, java.lang.Integer associationId)
associationId
- identifier of the association.AssociationDto[] findAssociationsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId, boolean bidirectional)
entityTypeId
- is one of the constants defined in GroupType
.bidirectional
- if true
then both the arriving and leaving associations of
the given entity will be returned, if false
then
only the leaving ones.BuildDto createBuild(java.lang.String token, BuildDto build)
void deleteBuild(java.lang.String token, java.lang.Integer buildId)
buildId
- identifier of the build.void updateBuild(java.lang.String token, BuildDto build)
BuildDto[] findBuildsByProjectId(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.BuildDto findBuildById(java.lang.String token, java.lang.Integer buildId)
buildId
- identifier of the build.BuildLogDto[] findBuildLogsByBuildId(java.lang.String token, java.lang.Integer buildId, long startTime)
buildId
- identifier of the build.startTime
- start time for the build logs: all logs that are equal or more recent are returned.
If 0, all logs will be returned. If -1, then the very latest log will be returned.executeBuildById(String, Integer)
BuildStatsDto findBuildStatsByBuildId(java.lang.String token, java.lang.Integer buildId)
buildId
- identifier of the build.BuildStatsDto findBuildStatsByProjectId(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.BuildLogDto executeBuildById(java.lang.String token, java.lang.Integer buildId)
buildId
- identifier of the build.
SourceFileDto findSourceFileById(java.lang.String token, java.lang.Integer sourceFileId)
sourceFileId
- identifier of the source code file.SourceFileDto findSourceFileByProjectAndPath(java.lang.String token, java.lang.Integer projectId, java.lang.String path)
projectId
- identifier of the project.path
- full path of the source code file.SourceFileDto[] findSourceFilesByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.SourceFileDto[] findSourceFilesByProjectsAndFileNamePattern(java.lang.String token, java.lang.Integer[] projectIds, java.lang.String likePattern)
projectIds
- List
of Integer
objects, identifiers of the projects to search in.
Pass null
if you want to search in all the projects.likePattern
- case-insensitive pattern that has the same semantics like the patterns used in
standard SQL LIKE conditions.ScmChangeSetDto[] findCommitsByTrackerItem(java.lang.String token, java.lang.Integer trackerItemId)
trackerItemId
- identifier of the tracker item.ScmChangeSetDto[] findCommitsByTrackerItems(java.lang.String token, java.lang.Integer[] trackerItemIds)
trackerItemIds
- identifiers of the tracker items.ForumDto createForum(java.lang.String token, ForumDto forum) throws AccessRightsException, ChangeVetoedException
AccessRightsException
ChangeVetoedException
ForumDto createForumFromTemplate(java.lang.String token, ForumDto forum, java.lang.Integer templateForumId) throws AccessRightsException, ChangeVetoedException
templateForumId
- identifier of the template forum.
AccessRightsException
ChangeVetoedException
void deleteForum(java.lang.String token, java.lang.Integer forumId) throws AccessRightsException, ChangeVetoedException
forumId
- identifier of the forum.
AccessRightsException
ChangeVetoedException
ForumDto findForumById(java.lang.String token, java.lang.Integer forumId)
forumId
- identifier of the forum.ForumDto[] findForumsByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.ForumStatsDto findStatsByForumId(java.lang.String token, java.lang.Integer forumId)
null
if the forum is not accessible.
forumId
- identifier of the forum.ForumPostDto createForumPost(java.lang.String token, ForumPostDto post) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void deleteForumPost(java.lang.String token, java.lang.Integer forumPostId) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
forumPostId
- identifier of the forum post.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
void updateForumPost(java.lang.String token, ForumPostDto post) throws java.lang.IllegalArgumentException, AccessRightsException, ChangeVetoedException
post
- the forum post to be updated.
java.lang.IllegalArgumentException
AccessRightsException
ChangeVetoedException
ForumPostDto findForumPostById(java.lang.String token, java.lang.Integer forumPostId)
forumPostId
- identifier of the forum post.ForumPostDto[] findForumPostsByForum(java.lang.String token, java.lang.Integer forumId, int maxCount)
forumId
- identifier of the forum.maxCount
- upper limit for the count of posts returned.ArtifactDto[] findReportsByProject(java.lang.String token, java.lang.Integer projectId)
ArtifactDto
objects that represent report definition documents.TrackerItemDto[][] executeReport(java.lang.String token, java.lang.Integer reportId)
byte[] executeAndDownloadReport(java.lang.String token, java.lang.Integer reportId, int format, boolean exportComments, boolean exportDescriptions, java.lang.String recordSeparator, java.lang.String fieldSeparator) throws ObjectNotExistsException
format
- ReportType
exportComments
- whether to include tracker item comments in the output.exportDescriptions
- whether to include detailed tracker item descriptions in the output.recordSeparator
- what string to output between two records.
Used only with CSV format, ignored otherwise.fieldSeparator
- what string to output between two fields.
Used only with CSV format, ignored otherwise.
ObjectNotExistsException
WikiPageDto createWikiPage(java.lang.String token, WikiPageDto wikiPage, java.lang.String content, java.lang.String comment, java.lang.String commentFormat) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
content
- content of the wiki page, in wiki markup format.
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
WikiPageDto createWikiPage(java.lang.String token, WikiPageDto wikiPage, java.lang.String content, java.lang.String comment, java.lang.String commentFormat, boolean rewriteLinks) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
rewriteLinks
- whether to detect and rewrite interwiki links and resolve absolute URLs to relative ones.
Note: when you turn link rewriting off, interal incoming and outgoing links will not be detected, either.
Also, the first update on the web interface will rewrite the links automatically.
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
createWikiPage(String, WikiPageDto, String, String, String)
void updateWikiPage(java.lang.String token, WikiPageDto wikiPage) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
wikiPage
- the wiki page to be updated.
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
void deleteWikiPage(java.lang.String token, java.lang.Integer wikiPageId) throws java.lang.IllegalArgumentException, AccessRightsException, DocumentSccException, ChangeVetoedException
wikiPageId
- identifier of the wiki page.
java.lang.IllegalArgumentException
AccessRightsException
DocumentSccException
ChangeVetoedException
void uploadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, java.lang.String content, java.lang.String comment, java.lang.String commentFormat) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
content
- content of the wiki page, in wiki markup format.
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
void uploadWikiPageInExternalFormat(java.lang.String token, java.lang.Integer wikiPageId, byte[] content, java.lang.String comment, java.lang.String commentFormat, java.lang.String checksum) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
content
- content of the wiki page, in wiki markup format.
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
void uploadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, java.lang.String content, java.lang.String comment, java.lang.String commentFormat, boolean rewriteLinks) throws java.lang.IllegalArgumentException, AccessRightsException, ArtifactNameConflictException, DocumentSccException, ChangeVetoedException
java.lang.IllegalArgumentException
AccessRightsException
ArtifactNameConflictException
DocumentSccException
ChangeVetoedException
uploadWikiPage(String, Integer, String, String, String)
,
createWikiPage(String, WikiPageDto, String, String, String, boolean)
java.lang.String downloadWikiPage(java.lang.String token, java.lang.Integer wikiPageId, boolean render) throws DocumentSccException
render
- if true
it the page content will be returned as rendered HTML,
otherwise it will be returned as wiki markup.
DocumentSccException
byte[] downloadWikiPageInExternalFormat(java.lang.String token, java.lang.Integer wikiPageId) throws DocumentSccException
DocumentSccException
WikiPageDto findWikiPageById(java.lang.String token, java.lang.Integer wikiPageId)
wikiPageId
- identifier of the wiki page.WikiPageDto findWikiPageByProjectAndName(java.lang.String token, java.lang.Integer projectId, java.lang.String name)
null
if not found.
WikiPageDto[] findTopWikiPagesByProject(java.lang.String token, java.lang.Integer projectId)
projectId
- identifier of the project.WikiPageDto[] findWikiPagesByParentWikiPage(java.lang.String token, java.lang.Integer parentWikiPageId)
parentWikiPageId
- identifier of the parent wiki pageArtifactHistoryEntryDto[] findWikiPageHistory(java.lang.String token, java.lang.Integer wikiPageId)
wikiPageId
- identifier of the wiki page.java.lang.String renderContent(java.lang.String token, java.lang.String wikiMarkupText)
wikiMarkupText
- the wiki markup text to transform to HTML.
WikiPageCommentDto createWikiPageComment(java.lang.String token, WikiPageCommentDto comment)
comment
- encapsulates also the binary content (attachment) of the comment.
void deleteWikiPageComment(java.lang.String token, java.lang.Integer commentId)
commentId
- identifier of the wiki page comment.void updateWikiPageComment(java.lang.String token, WikiPageCommentDto comment)
comment
- encapsulates also the binary content (attachment) of the comment.WikiPageCommentDto findWikiPageCommentById(java.lang.String token, java.lang.Integer commentId)
commentId
- identifier of the wiki page comment.WikiPageCommentDto[] findWikiPageCommentsByWikiPageId(java.lang.String token, java.lang.Integer wikiPageId)
wikiPageId
- identifier of the wiki page.LabelDto createLabel(java.lang.String token, LabelDto label) throws AccessRightsException
AccessRightsException
void updateLabel(java.lang.String token, LabelDto label) throws AccessRightsException
label
- the label to be updated.
AccessRightsException
void deleteLabel(java.lang.String token, java.lang.Integer labelId) throws AccessRightsException
labelId
- identifier of the label.
AccessRightsException
LabelDto[] findAllPublicLabels(java.lang.String token)
LabelDto[] findAllPrivateLabels(java.lang.String token)
LabelDto findLabelById(java.lang.String token, java.lang.Integer labelId)
labelId
- identifier of the label.void setEntityLabels(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId, LabelDto[] labels) throws AccessRightsException
AccessRightsException
EntityLabelDto[] findLabelsByEntity(java.lang.String token, java.lang.Integer entityTypeId, java.lang.Integer entityId)
entityTypeId
- is one of the constants defined in GroupType
.EntityLabelDto[] findEntititesByLabel(java.lang.String token, java.lang.Integer labelId)
EntityReferenceDto[] findEntityReferencesBySource(java.lang.String token, java.lang.Integer fromTypeId, java.lang.Integer fromId)
fromTypeId
- is one of the constants defined in GroupType
.EntityReferenceDto[] findEntityReferencesByTarget(java.lang.String token, java.lang.Integer toTypeId, java.lang.Integer toId)
toTypeId
- is one of the constants defined in GroupType
.WorkingSetDto createWorkingSet(java.lang.String token, WorkingSetDto workingSet, java.lang.Integer[] projectIds) throws AccessRightsException
projectIds
- the list of project id to be included inside.
AccessRightsException
void updateWorkingSet(java.lang.String token, WorkingSetDto workingSet, java.lang.Integer[] projectIds) throws AccessRightsException
AccessRightsException
void deleteWorkingSet(java.lang.String token, java.lang.Integer workingSetId) throws AccessRightsException
AccessRightsException
WorkingSetDto[] findAllWorkingSets(java.lang.String token)
WorkingSetDto findWorkingSetById(java.lang.String token, java.lang.Integer workingSetId) throws AccessRightsException
AccessRightsException
ProjectDto[] findProjectsByWorkingSet(java.lang.String token, java.lang.Integer workingSetId)
workingSetId
- the working set id.
findAllWorkingSets(String)
void selectWorkingSet(java.lang.String token, java.lang.Integer workingSetId)
token
- The tokenworkingSetId
- The id of workingset, or null if you want to remove all previous workingset selection.java.util.List<ProjectDto> getSelectedWorkingSetProjects(java.lang.String token)
token
-
BinaryStreamDto loadForumPostBlob(java.lang.String token, java.lang.Integer forumPostId)
forumPostId
-
void saveForumPostBlob(java.lang.String token, java.lang.Integer forumPostId, BinaryStreamDto binaryStreamDto)
forumPostId
- binaryStreamDto
- BinaryStreamDto loadArtifactCommentBlob(java.lang.String token, java.lang.Integer abstractCommentDtoId)
abstractCommentDtoId
-
void saveArtifactCommentBlob(java.lang.String token, java.lang.Integer abstractCommentDtoId, BinaryStreamDto binaryStreamDto)
abstractCommentDtoId
- binaryStreamDto
- BinaryStreamDto loadTrackerItemAttachmentBlob(java.lang.String token, java.lang.Integer trackerItemAttachmentDtoId)
trackerItemAttachmentDtoId
-
void saveTrackerItemAttachmentBlob(java.lang.String token, java.lang.Integer trackerItemAttachmentDtoId, BinaryStreamDto binaryStreamDto)
trackerItemAttachmentDtoId
- binaryStreamDto
-
|
CodeBeamer 5.4.0.1-RC API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |