Upsource API Documentation Index

Services

View as JSON

S UpsourceRPC

Main RPC service
NameArgumentReturn ValueDescription
acceptUserAgreement VoidMessage VoidMessage
Accepts the end user agreement for a given user
getUserAgreementText VoidMessage UserAgreementTextDTO
Returns the text of the end user agreement
getAllProjects ProjectIdListDTO ShortProjectInfoListDTO
In the case of an empty request, returns the list of all short project infos. Otherwise returns the list of project infos for a given set of project IDs. In any case only the projects the user has access to are returned.
findProjects FindProjectsRequestDTO ShortProjectInfoListDTO
Returns the list of projects matching a given search criteria
getProjectInfo ProjectIdDTO ProjectInfoDTO
Returns basic information about the project - name, project model, latest revision, etc.
getProjectVcsLinks ProjectIdDTO VcsRepoListDTO
Returns VCS repository URL(s) for a given project
getProjectReadme ProjectIdDTO ProjectReadmeResponseDTO
Returns README (README.md) contents from the latest revision
getCodeReviewPatterns VoidMessage CodeReviewPatternsDTO
Returns all registered code review patterns across all projects
getHeadRevision ProjectIdDTO RevisionInfoDTO
Returns the revision descriptor for the latest revision - ID, date, commit message, authors, parent revisions, etc.
getRevisionsList RevisionsListRequestDTO RevisionDescriptorListDTO
Returns the list of revisions in a given project (optionally with revision graph)
getRevisionsListFiltered RevisionsListFilteredRequestDTO RevisionDescriptorListDTO
Returns the list of revisions that match the given search query
getUserRevisionsList UserRevisionsListRequestDTO RevisionDescriptorListDTO
Returns the list of revisions across all projects authored by the specified user and (optionally) matching the specified query
getRevisionsListUpdate RevisionsListUpdateRequestDTO RevisionsListUpdateResponseDTO
Returns the list of revisions since the given revision
getRevisionInfo RevisionInProjectDTO RevisionInfoDTO
Returns the revision descriptor - ID, date, commit message, authors, parent revisions, etc.
getRevisionChanges RevisionChangesRequestDTO RevisionsDiffDTO
Returns the list of changes (files that were added, removed, or modified) in a revision
getRevisionBranches RevisionInProjectDTO RevisionBranchesResponseDTO
Returns the list of branches a revision is part of
getProjectSubtree FileInRevisionDTO ProjectItemsListDTO
Returns the project structure tree starting from the given file
getFileMeta FileInRevisionDTO FileMetaResponseDTO
Returns meta information about a file (is deleted, is latest revision, etc.)
getFileAnnotation FileInRevisionDTO FileAnnotationResponseDTO
Returns the line-by-line file annotation
getFileContributors FileInRevisionDTO FileContributorsResponseDTO
Returns the file contributors
getFileFragmentAuthors FileFragmentAuthorsRequestDTO UsersListDTO
Returns the authors of the given file fragment
getFileHistory FileHistoryRequestDTO FileHistoryResponseDTO
Returns the history (list of revision IDs and change types) of the file
getFileDiff FileDiffRequestDTO FileDiffResponseDTO
Returns the diff (changed lines and ranges) between the given revisions of a file
getFileInlineDiff FileDiffRequestDTO FileInlineDiffResponseDTO
Returns the inline diff (changed lines and ranges, line numbers mapping) for the given file
getFileMergeInlineDiff FileMergeInlineDiffRequestDTO FileInlineDiffResponseDTO
Returns the inline diff of a file after the merge with the base branch
getFileContent FileInRevisionDTO FileContentResponseDTO
Returns the contents of the given file
getFilePsi FilePsiRequestDTO FilePsiResponseDTO
Returns the semantic markup of the given file
getStubNavigationRange StubIdDTO NavigationTargetItemDTO
Returns the text range of the given PSI element
getElementDescription PsiElementIdDTO TargetDescriptionDTO
Returns the text representation of the given PSI element
getElementDocumentation PsiElementIdDTO ElementDocumentationDTO
Returns the documentation (e.g. Javadoc) for the given PSI element
findUsages PsiElementIdDTO FindUsagesResponseDTO
Returns the list of usages for the given PSI element
getUsagesDiff UsagesDiffRequestDTO UsagesDiffResponseDTO
Returns the usages diff for the given PSI element between two revisions
findHierarchy PsiElementIdDTO FindHierarchyResultDTO
Returns the list of inheritors and ancestors for the given PSI element
gotoFileByName GotoFileRequestDTO GotoFileResponseDTO
Returns the files matched by the search query in a given revision, review, project-wide, or service-wide
textSearch TextSearchRequestDTO TextSearchResponseDTO
Performs full-text search across all commits and files (either service-wide or project-wide)
findBranches FindBranchRequestDTO FindBranchResponseDTO
Performs project-wide search by branch name
getBranchDiff BranchRequestDTO RevisionsDiffDTO
Returns the list of changes in the given branch
getRevisionsDiff RevisionsDiffRequestDTO RevisionsDiffDTO
Returns the list of changes between any two revisions
getCompareInfo CompareRequestDTO CompareInfoDTO
Compare page
getCompareGraph RevisionsDiffRequestDTO CompareGraphDTO
Revision graph for compare page
getBranchInfo BranchRequestDTO BranchInfoDTO
Branch page
getBranchGraph BranchRequestDTO BranchGraphDTO
Revision graph for branch page
getBranches BranchesRequestDTO BranchListDTO
Returns the list of branches in a project
findCommits FindCommitsRequestDTO FindCommitsResponseDTO
Finds commit(s) with the given commit hash
getProjectDiscussions DiscussionsInProjectRequestDTO DiscussionsInProjectDTO
Returns the discussions in the project, matching given query
getFileDiscussions FileInRevisionDTO DiscussionsInFileDTO
Returns the discussions in the given file
getInlineDiscussionsInRevision RevisionInProjectDTO DiscussionsInFilesDTO
Returns the discussions in the given revision
createDiscussion CreateDiscussionRequestDTO DiscussionInFileDTO
Creates a new discussion
resolveDiscussion ResolveDiscussionRequestDTO ResolveDiscussionResponseDTO
Updates a discussion
getCurrentUserCanResolveDiscussion DiscussionIdDTO VoidMessage
Checks if current user can resolve the given discussion
addDiscussionLabel UpdateDiscussionLabelRequestDTO LabelDTO
Adds a label to a discussion
addReviewLabel UpdateReviewLabelRequestDTO UpdateReviewLabelResponseDTO
Adds a label to a review
removeDiscussionLabel UpdateDiscussionLabelRequestDTO VoidMessage
Removes a label from a discussion
removeReviewLabel UpdateReviewLabelRequestDTO UpdateReviewLabelResponseDTO
Removes a label from a review
starDiscussion UpdateDiscussionFlagRequestDTO VoidMessage
Stars a discussion
readDiscussion UpdateDiscussionFlagRequestDTO VoidMessage
Toggles the read/unread state of a discussion
addComment AddCommentRequestDTO CommentDTO
Adds a comment to the discussion
updateComment UpdateCommentRequestDTO UpdateCommentResponseDTO
Updates the comment
removeComment RemoveCommentRequestDTO RemoveCommentResponseDTO
Removes the comment
updateTaskList UpdateTaskListRequestDTO UpdateCommentResponseDTO
Updates the task list embedded in a comment
toggleReaction ToggleReactionRequestDTO VoidMessage
Adds or removes a reaction to a specified target
getFeed FeedRequestDTO FeedDTO
Returns the news feed
getRevisionDiscussions RevisionInProjectDTO DiscussionsInRevisionDTO
Returns the discussions in the given revision
getRevisionReviewInfo RevisionListDTO RevisionReviewInfoListDTO
Returns short review information for a set of revisions
getSuggestedReviewsForRevisions RevisionListDTO SuggestedReviewListDTO
Returns review suggestions for a set of revisions
getSuggestedReviewForGhosts UncommittedRevisionDTO ReviewSuggestDTO
Returns review suggestion for the uncommitted revision
getRevisionDiscussionCounters RevisionDiscussionCountersRequestDTO RevisionDiscussionCountersListDTO
Returns discussion counters for a set of revisions
getRevisionBuildStatus RevisionListDTO RevisionBuildStatusListDTO
Returns build status for revisions
getRevisionsOwnershipSummary RevisionListDTO RevisionsOwnershipSummaryDTO
Returns the code ownership summary for given revisions
getRevisionsExternalInspectionsDiff RevisionListDTO RevisionsExternalInspectionsDiffResponseDTO
Returns the diff of external inspections compared to the previous run
getUsersForMention UsersForMentionRequestDTO UsersListDTO
Returns the suggested users to be mentioned in a comment
getUsersForReview UsersForReviewRequestDTO UsersForReviewDTO
Returns the suggested reviewers for a given review
getProjectUserGroups ProjectUserGroupsRequestDTO UserGroupsListDTO
Returns the list of non-empty user groups relevant to a given project
getUserGroupsByIds UserGroupsIdsListDTO UserGroupsListDTO
Returns the list of user groups by given IDs
findUsers FindUsersRequestDTO UserInfoResponseDTO
Returns the list of users matching a given search criteria
getLabels LabelsRequestDTO LabelsListDTO
Returns the list of discussion labels
getReviewLabels LabelsRequestDTO LabelsListDTO
Returns the list of review labels
getReviews ReviewsRequestDTO ReviewListDTO
Returns the list of reviews
createReview CreateReviewRequestDTO ReviewDescriptorDTO
Creates a review
closeReview CloseReviewRequestDTO CloseReviewResponseDTO
Closes a review
renameReview RenameReviewRequestDTO RenameReviewResponseDTO
Renames a review
editReviewDescription EditReviewDescriptionRequestDTO EditReviewDescriptionResponseDTO
Sets review description
getReviewDetails ReviewIdDTO ReviewDescriptorDTO
Returns review details
getReviewOwnershipSummary ReviewIdDTO ReviewOwnershipSummaryDTO
Returns the code ownership summary for a given review
getReviewProgress ReviewIdDTO ReviewProgressDTO
Returns participants' progress in a given review
getReviewInspectionsDiff ReviewInspectionsDiffRequestDTO InspectionsDiffDTO
Returns the diff of inspections between two revisions
addRevisionToReview RevisionsInReviewDTO VoidMessage
Attaches a revision to a review
startBranchTracking StartBranchTrackingRequestDTO VoidMessage
Initiates branch tracking for a given review
stopBranchTracking StopBranchTrackingRequestDTO VoidMessage
Stops branch tracking for a given review
squashReviewRevisions ReviewIdDTO VoidMessage
Rebase the review to a single squashed revision
removeRevisionFromReview RevisionsInReviewDTO VoidMessage
Removes a revision from a review
getRevisionsInReview ReviewIdDTO RevisionsInReviewResponseDTO
Returns the list of revisions in a review
getSuggestedRevisionsForReview ReviewIdDTO SuggestedRevisionListDTO
Returns the list of suggested revisions for a particular review
addParticipantToReview ParticipantInReviewRequestDTO VoidMessage
Adds a participant (reviewer or watcher) to a review
addGroupToReview AddGroupToReviewRequestDTO AddGroupToReviewResponseDTO
Adds a group of participants (reviewers or watchers) to a review
updateParticipantInReview UpdateParticipantInReviewRequestDTO UpdateParticipantInReviewResponseDTO
Updates the participant's state
removeParticipantFromReview ParticipantInReviewRequestDTO VoidMessage
Removes a participant from a review
toggleReviewMuted ToggleReviewMutedRequestDTO VoidMessage
Mutes activities taking place in a certain review or cancels muting that was previously set
setReviewDeadline ReviewDeadlineRequestDTO VoidMessage
Sets/clears review due date
setReviewTargetBranch ReviewTargetBranchDTO SetReviewTargetBranchResponseDTO
Merge review: sets target branch
getReviewSummaryChanges ReviewSummaryChangesRequestDTO ReviewSummaryChangesResponseDTO
Returns the list of changes (sum of all revisions) in a review
getFileInReviewSummaryInlineChanges FileInReviewDiffRequestDTO FileInlineDiffResponseDTO
Returns the diff (sum of all revisions) of a file in review
getFileInReviewSummaryDiff FileInReviewDiffRequestDTO FileDiffResponseDTO
Returns the diff (sum of all revisions) of a file in review
setFileInReviewReadStatus FileInReviewReadStatusRequestDTO VoidMessage
Track file read status
getReviewSummaryDiscussions ReviewSummaryDiscussionsRequestDTO DiscussionsInFilesDTO
Returns the review discussions
removeReview ReviewIdDTO VoidMessage
Removes the review
getMatchingRevisionsForStacktrace StacktraceDTO MatchingRevisionsResponseDTO
Returns matching revisions for stacktrace
getStacktraceInContextOfRevision StacktraceDTO StacktracePositionsDTO
Returns full paths and vcs commit ids for lines of stacktrace in context of revision
getCurrentUser VoidMessage CurrentUserResponseDTO
Returns the user info for a currently logged-in user
getCurrentUserCanCloseReview ReviewIdDTO VoidMessage
Checks if current user can close given review
getCurrentUserCanDeleteReview ReviewIdDTO VoidMessage
Checks if current user can delete given review
getUserInfo UserInfoRequestDTO UserInfoResponseDTO
Returns user info for given users
getUsersPresenceInfo UserInfoRequestDTO UsersPresenceInfoResponseDTO
Returns presence info for given users
bindVcsUsername BindVcsUsernameRequestDTO VoidMessage
Maps a VCS username/email to a Hub account
getUserProjects UserProjectsRequestDTO UserProjectsResponseDTO
Returns the list of projects the specified user contributed to
setUserAbsence UserAbsenceRequestDTO VoidMessage
Sets or clears a user absence
getUserSetting GetSettingRequestDTO GetSettingResponseDTO
Returns the value of a user setting by name
setUserSetting SetSettingRequestDTO VoidMessage
Updates the value of a user setting by name
getClusterSetting GetSettingRequestDTO GetSettingResponseDTO
Returns the value of a cluster-wide setting by name
setClusterSetting SetSettingRequestDTO VoidMessage
Updates the value of a cluster-wide setting by name
setMotto SetMottoRequestDTO VoidMessage
Sets the server motto
getProjectSetting GetProjectSettingRequestDTO GetSettingResponseDTO
Returns the value of a project setting by name
setProjectSetting SetProjectSettingRequestDTO VoidMessage
Updates the value of a project setting by name
setProjectWebhooks SetProjectWebhooksRequestDTO VoidMessage
Updates the set of webhooks in a project
createProject CreateProjectRequestDTO VoidMessage
Creates a project
loadProject ProjectIdDTO ProjectSettingsDTO
Loads project settings
editProject EditProjectRequestDTO VoidMessage
Updates project settings
deleteProject ProjectIdDTO VoidMessage
Deletes a project
resetProject ProjectIdDTO VoidMessage
Completely reset a project
getProjectConfigurationParameters VoidMessage ProjectConfigurationResponseDTO
Loads project settings
getVcsHostingServices VcsHostingRequestDTO VcsHostingResponseDTO
Loads VCS Hosting services
createOrEditLabel EditLabelRequestDTO LabelDTO
Creates/updates a discussion label in a project
createOrEditReviewLabel EditLabelRequestDTO LabelDTO
Creates/updates a review label in a project
hidePredefinedLabels HidePredefinedLabelsRequestDTO VoidMessage
Hides predefined discussion labels in a project
hidePredefinedReviewLabels HidePredefinedLabelsRequestDTO VoidMessage
Hides predefined review labels in a project
deleteLabel EditLabelRequestDTO VoidMessage
Deletes a discussion label from a project
deleteReviewLabel EditLabelRequestDTO VoidMessage
Deletes a review label from a project
mergeLabels EditLabelsRequestDTO LabelDTO
Merges two or more discussion labels into one
testVcsConnection TestConnectionRequestDTO TestConnectionResponseDTO
Checks connection to a given VCS repository
testPOP3Mailbox TestPOP3MailboxRequestDTO TestPOP3MailboxResponseDTO
Checks availability of a given POP3 mailbox
getReadOnlyMode VoidMessage ReadOnlyModeDTO
Checks if server is in read-only mode
setReadOnlyMode ReadOnlyModeDTO VoidMessage
Enables/disables the read-only mode
getEmailBounces VoidMessage EmailBouncesResponseDTO
resetEmailBounces VoidMessage VoidMessage
getAllRoles VoidMessage AllRolesResponseDTO
Returns all roles available in Hub
getUsersRoles UsersRolesRequestDTO UsersRolesResponseDTO
Returns users that have any access to the project and role keys associated with each user
addUserRole AddRoleRequestDTO VoidMessage
Adds a user role
deleteUserRole DeleteRoleRequestDTO VoidMessage
Deletes a user role (not the role itself, but the association)
inviteUser InviteUserRequestDTO InviteUserResponseDTO
Searches for user in Hub by an email, and sends an invitation if not found
exportData VoidMessage ExportDataResponseDTO
Exports user-generated data - reviews, discussions, settings
getProjectActivity ProjectActivityRequestDTO ProjectActivityDTO
Returns project activity distribution over time, i.e. the number of commits per time period
getContributorsDistribution ContributorsDistributionRequestDTO ContributorsDistributionDTO
Returns contributors distribution over time, i.e. the number of commits per time period per committer
getResponsibilityDistribution ResponsibilityDistributionRequestDTO ResponsibilityDistributionDTO
Returns commits distribution in a given date range over all committers and modules
getProjectCommitters ProjectIdDTO ProjectCommittersDTO
Returns all committers throughout the project history
getUserActivity UserActivityRequestDTO UserActivityDTO
Returns project activity distribution over time, i.e. the number of commits per time period for a specified set of committers
getModulesDistribution ModulesDistributionRequestDTO ModulesDistributionDTO
Returns per-module activity distribution in the project
getCommitsSummary CommitsSummaryRequestDTO CommitsSummaryDTO
Returns the summary for the specified date range and set of committers: total number of commits, number of commits that aren't part of any module, total number of modules changed
getCommitsDetails CommitsDetailsRequestDTO CommitsDetailsDTO
Returns the revisions in the specified module, in the specified date range and for the specified committers
getFileHistoryChart FileHistoryChartRequestDTO FileHistoryChartDTO
Returns the data required to display an animated chart of distribution of individual files in project across "edits - age" plane
getProjectTreeMap ProjectTreeMapRequestDTO ProjectTreeMapDTO
Returns the list of files in a project and their content sizes required to build the interactive treemap chart
getProjectPulse ProjectPulseRequestDTO PulseResponseDTO
Returns the activity pulse for a specified project
getUserPulse UserPulseRequestDTO PulseResponseDTO
Returns the activity pulse of a given user across all projects (`allValues` time series is always empty)
getReviewStatistics ReviewStatisticsRequestDTO ReviewStatisticsDTO
Returns the general review statistics in the project
getReviewCoverage ReviewCoverageRequestDTO ReviewCoverageDTO
Returns the number of revisions covered by reviews in the project
getReviewTimeStatistics ReviewTimeStatisticsRequestDTO ReviewTimeStatisticsDTO
Returns the time distribution of reviews and review iterations
getReviewersGraph ReviewersGraphRequestDTO ReviewersGraphDTO
Returns review activity graph for the project
updateUserTimezone UpdateUserTimezoneDTO VoidMessage
Updates user timezone
updateAchievementsLastSeen UserActionNotificationDTO VoidMessage
Updates the time when the user last saw the list of his/her achievements
getUnlockedUserAchievements UserAchievementsRequestDTO AchievementsListDTO
Returns the list of achievements the user has unlocked
getUnreadUnlockedUserAchievementsCount VoidMessage UserAchievementsCountDTO
Returns a count of unread achievements the user has unlocked
getUserAchievements UserAchievementsRequestDTO AchievementsListDTO
Returns the list of all achievements with information about whether the achievement was unlocked by the user or not
getAvailableIssueTrackerProviders VoidMessage IssueTrackerProvidersListDTO
Returns the list of available issue trackers
getIssueInfo IssueInfoRequestDTO IssueInfoDTO
Returns detailed issue information
createIssueFromDiscussion CreateIssueFromDiscussionRequestDTO IssueIdDTO
Creates an issue from the discussion in a given issue tracker
createIssueFromReview CreateIssueFromReviewRequestDTO IssueIdDTO
Creates an issue from the review in a given issue tracker