Upsource API Documentation Index

Messages

View as JSON

M AddCommentRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
Discussion ID
text string required
Text of the comment being added
parentId string optional
An ID of the comment you are replying to
markupType string optional
Currently not in use

M AddGroupToReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
groupId string required
ID of a user group
role RoleInReviewEnum required
Role of users getting assigned. See RoleInReviewEnum parameters

M AddGroupToReviewResponseDTO

FieldTypeLabelDescription
addedUsersCount int32 required
How many users from the specified group were added

M AddRoleRequestDTO

FieldTypeLabelDescription
projectId string required
ID of the Upsource project
userId string required
ID of the Upsource user
roleKey string required
Role key

M AllRolesResponseDTO

FieldTypeLabelDescription
roleDetails RoleDetailsDTO repeated
See RoleDetailsDTO parameters

M AnchorDTO

FieldTypeLabelDescription
range RangeDTO optional
Text range associated with an anchor
fileId string optional
File associated with an anchor
revisionId string optional
VCS revision ID
inlineInRevision string optional
Whether a comment was left in the inline diff

M BranchDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
name string required
Branch name
lastRevision RevisionInfoDTO required
See RevisionInfoDTO parameters
isDefault bool required
Whether the branch is a default one
stats BranchStatsDTO required
See BranchStatsDTO parameters
isHosted bool required
Whether the branch is from a hosted repository
reviewId ReviewIdDTO optional
ID of the branch review, if one exists

M BranchesRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
query string required
Search query
limit int32 required
Number of branches to return
sortBy string optional
Sort by: last updated ("updated", default), branch name ("name")

M BranchGraphDTO

FieldTypeLabelDescription
revisions RevisionInfoDTO repeated
See RevisionInfoDTO parameters
graph RevisionListGraphDTO required
See RevisionListGraphDTO parameters

M BranchInfoDTO

FieldTypeLabelDescription
commitsCount int32 required
Number of commits associated with the branch
filesCount int32 required
Number of files affected by the branch commits
branchingRevision string required
Revision where the branching took place
headRevision RevisionInfoDTO required
Latest revision in the branch. See RevisionInfoDTO parameters
reviewInfo ReviewDescriptorDTO optional
See ReviewDescriptorDTO parameters
canCreateReview CanCreateBranchReviewDTO required
A branch review can be created. See CanCreateBranchReviewDTO parameters.
stats BranchStatsDTO required
See BranchStatsDTO parameters
mergeInfo BranchMergeInfoDTO required
See BranchMergeInfoDTO parameters
isPullRequest bool required
Whether the branch is a pull request

M BranchingRevisionSuggestion

FieldTypeLabelDescription
revisionId string required
Revision ID to suggest
pathToLeftSize int32 required
The number of revisions to the left locator
pathToRightSize int32 required
The number of revisions to the right locator

M BranchListDTO

FieldTypeLabelDescription
branch BranchDTO repeated
See BranchDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request
totalBranches int32 required
How many branches
defaultBranch string optional
Name of the default branch
isDefaultBranchExists bool optional
Whether the project has the default branch

M BranchMergeInfoDTO

FieldTypeLabelDescription
mergeFiles string repeated
The list of files that are changed in both: given branch and base branch

M BranchRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
branch string required
Branch name

M BranchStatsDTO

FieldTypeLabelDescription
parentBranch string optional
The branch from which the given branch originated; null if the given branch is a default one or the only branch in the repository
commitsAhead int32 required
How many commits ahead of the parent branch; 0 for a default branch
commitsBehind int32 required
How many commits behind the parent branch; 0 for a default branch

M CanCreateBranchReviewDTO

FieldTypeLabelDescription
isAllowed bool required
A branch review can be created
message string optional
A message explaining the reason why a review can't be created

M CloseReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
isFlagged bool required
Pass 'true' to close a review, 'false' to reopen a closed review

M CloseReviewResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M CodeReviewPattern

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
pattern string required
Code review ID pattern

M CodeReviewPatternsDTO

FieldTypeLabelDescription
patterns CodeReviewPattern repeated
See CodeReviewPattern

M CommentDTO

FieldTypeLabelDescription
discussionId string required
ID of the discussion
commentId string required
ID of the comment
text string required
Text of the comment
authorId string required
User ID of the comment author
date int64 required
Unix timestamp of the comment
parentId string optional
ID of the parent comment
isEditable bool required
Whether the comment can be edited
markupType string optional
Currently not in use
isSynchronized bool required
Whether the discussion is in sync with GitHub
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters
isRead bool required
Whether the comment has been read by the requester
reactions ReactionDTO repeated
Reactions added to the comment

M CompareGraphDTO

FieldTypeLabelDescription
revisions RevisionInfoDTO repeated
See RevisionInfoDTO parameters
graph RevisionListGraphDTO required
See RevisionListGraphDTO parameters
pathToBaseLength int32 required
The length of the displayed path from the branching revision to the base
fullPathToBaseLength int32 required
The actual length of the path from the branching revision to the base
pathToSecondLength int32 required
The length of the displayed path from the branching revision to the second revision
fullPathToSecondLength int32 required
The actual length of the path from the branching revision to the second revision

M CompareInfoDTO

FieldTypeLabelDescription
leftRevisionId string required
Revision ID on the left hand side of the comparison
rightRevisionId string required
Revision ID on the right hand side of the comparison
heads string repeated
The list of project head names for completion
commitsCount int32 required
Number of commits that took place between the revisions
filesCount int32 required
Number of files affected by these commits
examples ExampleComparison repeated
See ExampleComparison parameters
suggestion BranchingRevisionSuggestion optional
See BranchingRevisionSuggestion parameters

M CompareRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
leftLocator string required
Name of a branch or a revision ID to be used in a comparison
rightLocator string required
Name of a branch or a revision ID to be used in a comparison

M CompletionRateDTO

FieldTypeLabelDescription
completedCount int32 required
Number of reviewers who completed the review, either by accepting or raising concern about the changes
reviewersCount int32 required
Total number of reviewers
hasConcern bool required
Whether someone has raised a concern about the changes

M CreateDiscussionRequestDTO

FieldTypeLabelDescription
anchor AnchorDTO required
See AnchorDTO parameters
reviewId ReviewIdDTO optional
See ReviewIdDTO parameters
text string required
Text of the discussion
projectId string required
Project ID in Upsource
markupType string optional
Currently not in use
labels LabelDTO repeated
Discussion labels. See LabelDTO parameters

M CreateProjectRequestDTO

FieldTypeLabelDescription
newProjectId string required
An ID of the new Upsource project
settings ProjectSettingsDTO required
See ProjectSettingsDTO parameters
custom SetSettingRequestDTO repeated
Optional custom settings

M CreateReviewRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
title string optional
Review title (unused, left for compatibility with older clients)
revisions string repeated
Revisions to attach
branch string optional
Branch name for branch review
mergeFromBranch string optional
Merge review: branch to merge from
mergeToBranch string optional
Merge review: branch to merge into

M DeleteRoleRequestDTO

FieldTypeLabelDescription
projectId string required
ID of the Upsource project
userId string required
ID of the Upsource user
roleKey string required
Role key

M DiscussionIdDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
ID of the discussion

M DiscussionInFeedDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
Discussion ID
anchor AnchorDTO required
See AnchorDTO parameters
comments CommentDTO repeated
See CommentDTO parameters
review ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameters
labels LabelDTO repeated
Discussion labels. See LabelDTO parameters
read ReadEnum optional
Whether a discussion has been read by the requester
isStarred bool optional
Whether a discussion has been starred by the requester
firstUnreadCommentId string optional
An ID of the first unread comment
issue string optional
An ID of the issue linked to the discussion
isResolved bool optional
Whether the discussion is resolved
resolvedBy string optional
If the discussion is resolved, contains the ID of the user who resolved it

M DiscussionInFileDTO

FieldTypeLabelDescription
discussionId string required
ID of the discussion
anchor AnchorDTO required
Current discussion anchor
origin AnchorDTO optional
Original discussion anchor
comments CommentDTO repeated
See CommentDTO parameters
read ReadEnum optional
See ReadEnum parameters
isStarred bool optional
Whether the discussion is starred
review ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameters
labels LabelDTO repeated
Discussion labels. See LabelDTO parameters
issue string optional
An ID of the issue linked to the discussion
isResolved bool optional
Whether the discussion is resolved
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M DiscussionInFileWithFileDTO

FieldTypeLabelDescription
revisionId string optional
VCS revision ID
fileName string required
A full path of the file starting with a slash (e.g. /folder/subfolder/file.txt )
discussionInFile DiscussionInFileDTO required
See DiscussionInFileDTO parameters

M DiscussionInReviewDTO

FieldTypeLabelDescription
discussionId string required
ID of the discussion
reviewId ReviewIdDTO required
See ReviewIdDTO parameters

M DiscussionsGroupDTO

FieldTypeLabelDescription
fileId string optional
Path to file
discussions DiscussionsInFileDTO required
Discussions contained in the file. See DiscussionsInFileDTO parameters

M DiscussionsInFileDTO

FieldTypeLabelDescription
discussions DiscussionInFileDTO repeated
See DiscussionInFileDTO parameters

M DiscussionsInFilesDTO

FieldTypeLabelDescription
discussions DiscussionInFileWithFileDTO repeated
See DiscussionInFileWithFileDTO parameters

M DiscussionsInProjectDTO

FieldTypeLabelDescription
discussions DiscussionInFileDTO repeated
See DiscussionInFileDTO parameters
hasMore bool optional
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request
totalCount int32 optional
Total number of discussions matching query

M DiscussionsInProjectRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
query string required
A query string
limit int32 required
Number of discussions to return
skip int32 optional
Number of discussions to skip from the top (for pagination)

M DiscussionsInRevisionDTO

FieldTypeLabelDescription
groups DiscussionsGroupDTO repeated
See DiscussionsGroupDTO parameters

M EditLabelRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
label LabelDTO required
See LabelDTO parameters

M EditLabelsRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
labelId string repeated
Discussion labels IDs

M EditProjectRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
settings ProjectSettingsDTO required
See ProjectSettingsDTO parameters

M EditReviewDescriptionRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
text string required
Review description (Markdown is supported)

M EditReviewDescriptionResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M ExampleComparison

FieldTypeLabelDescription
leftLocator string required
The left location in the example
rightLocator string required
The right location in the example (usually a default branch)
lastCommitTime int64 required
The last commit time

M ExternalInspectionDTO

FieldTypeLabelDescription
revisionId string required
VCS revision ID
fileName string required
Name of the file
line int32 required
Line number
severity InspectionSeverityEnum required
Inspection severity
message string required
Inspection message

M ExternalLinkDTO

FieldTypeLabelDescription
url string required
External link URL
prefix string required
External link prefix

M FeedDTO

FieldTypeLabelDescription
feedItems FeedItemDTO repeated
See FeedItemDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request

M FeedItemDTO

FieldTypeLabelDescription
feedItemId string required
News feed item ID
projectId string required
Project ID in Upsource
discussion DiscussionInFeedDTO optional
See DiscussionInFeedDTO parameters
addedRevisions RevisionInfoDTO repeated
See RevisionInfoDTO parameters
removedRevisions RevisionInfoDTO repeated
See RevisionInfoDTO parameters
newParticipantInReview ParticipantInReviewDTO optional
See ParticipantInReviewDTO parameters
removedParticipantFromReview string optional
Show removed participants
participantStateChanged ParticipantStateChangedDTO optional
See ParticipantStateChangedDTO parameters
createdReview ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameters
modifiedReview ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameters
removedReview ReviewIdDTO optional
See ReviewIdDTO parameters
reviewStateChanged ReviewStateChangedDTO optional
See ReviewStateChangedDTO parameters
branchTrackingStopped string optional
The branch name for the "Review stopped branch tracking" feed event
updatedDeadline int64 optional
pullRequest string optional
Whether the feed item relates to the pull request action
date int64 required
Unix timestamp
actorId string required
The ID of the user who performed the feed action
squashedToRevision RevisionInfoDTO optional
Indicates that a review was squashed to a single revision
removedDiscussionId string optional
Indicates that a discussion was removed

M FeedRequestDTO

FieldTypeLabelDescription
limit int32 required
Number of news feed messages returned
type FeedTypeEnum required
Feed type, see FeedTypeEnum for possible values
projectId string optional
Project ID in Upsource
reviewId string optional
Review ID
searchQuery string optional
Search query. Use '#my' to request the personal feed, or leave empty for the full feed
reviewFeedSort ReviewFeedSortEnum optional
Review feed sorting ('Natural' by default)

M FileAnnotationResponseDTO

FieldTypeLabelDescription
retrospective FileAnnotationSectionDTO repeated
See FileAnnotationSectionDTO parameters
perspective FileAnnotationSectionDTO repeated
See FileAnnotationSectionDTO parameters

M FileAnnotationSectionDTO

FieldTypeLabelDescription
startLine int32 required
Line number to start with
lineCount int32 required
How many lines
revision RevisionInfoDTO required
See RevisionInfoDTO parameters
filePath string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
priorChangeAnnotation FileAnnotationSectionDTO optional
A reference to the prior revision of this section (only revision and file, but not the line number / line count)

M FileDiffFragmentDTO

FieldTypeLabelDescription
leftFileStartLine int32 required
Line number to start with
leftFileLineCount int32 required
How many lines
rightFileStartLine int32 required
Line number to start with
rightFileLineCount int32 required
How many lines
isUnchanged bool required
Indicates that a fragment is unchanged ("true" for unchanged commented lines)
addedRanges RangeDTO repeated
Ranges of text that were added
deletedRanges RangeDTO repeated
Ranges of text that were deleted

M FileDiffRequestDTO

FieldTypeLabelDescription
leftFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
rightFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
ignoreWhitespace bool required
Whether to ignore whitespace changes
isLeftFileDefinedAsNull bool optional
Whether the left file for comparison is 'no-file' (for internal use only)
contextLines int32 optional
Number of context lines around the modified fragment

M FileDiffResponseDTO

FieldTypeLabelDescription
leftFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
rightFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
fragments FileDiffFragmentDTO repeated
See FileDiffFragmentDTO parameters

M FileDiffSummaryDTO

FieldTypeLabelDescription
file FileInRevisionDTO required
See FileInRevisionDTO parameters
addedLines int32 required
How many lines were added
removedLines int32 required
How many lines were deleted

M FileExternalInspectionsDiffResponseDTO

FieldTypeLabelDescription
fileId string required
Name of the file containing differing inspections
introduced InspectionsCountDTO optional
Count of introduced problems
fixed InspectionsCountDTO optional
Count of fixed problems

M FileFragmentAuthorsRequestDTO

FieldTypeLabelDescription
file FileInRevisionDTO required
See FileInRevisionDTO parameters
startLine int32 required
Line number the fragment starts with
endLine int32 required
Line number the fragment ends with

M FileHistoryItemDTO

FieldTypeLabelDescription
diffType DiffTypeEnum required
Type of change (see DiffTypeEnum)
revision RevisionInfoDTO required
See RevisionInfoDTO parameters
fileName string required
A full path of the file starting with a slash (e.g. /folder/subfolder/file.txt )

M FileHistoryRequestDTO

FieldTypeLabelDescription
file FileInRevisionDTO required
See FileInRevisionDTO parameters
limit int32 required
History size limit
skip int32 optional
Number of history entries (file revisions) to skip from the top (for pagination)

M FileHistoryResponseDTO

FieldTypeLabelDescription
history FileHistoryItemDTO repeated
See FileHistoryItemDTO parameters
graph RevisionListGraphDTO optional
See RevisionListGraphDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request

M FileInlineDiffResponseDTO

FieldTypeLabelDescription
isIdentical bool required
Whether file contents are identical in both revisions
text string required
Text of the diff
oldFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
newFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
contentType FileContentTypeDTO required
See FileContentTypeDTO parameters
addedLines int32 repeated
How many lines were added
removedLines int32 repeated
How many lines were removed
modifiedLines int32 repeated
How many lines were modified
collapsedLines RangeDTO repeated
Ranges of collapsed text (lines)
addedRanges RangeDTO repeated
Ranges of text that were added
removedRanges RangeDTO repeated
Ranges of text that were removed
isSyntaxSupported bool optional
Determines if syntax markup is supported for this file type
syntaxMarkup TextMarkupDTO repeated
See TextMarkupDTO parameters
diffToOldDocument RangeMappingDTO repeated
A mapping of diff ranges to ranges in the old document
diffToNewDocument RangeMappingDTO repeated
A mapping of diff ranges to ranges in the new document
oldLineNumbers int32 repeated
Line numbers as they appear in the old file
newLineNumbers int32 repeated
Line numbers as they appear in the new file
annotation FileAnnotationSectionDTO repeated
Authors of code fragments in the review diff
hasUnrelatedChanges bool optional
Some changes were filtered out (in the review diff)
conflictType ConflictTypeEnum optional
When the diff relates to the merge result, holds the conflict type (see ConflictTypeEnum)

M FileInReviewDiffRequestDTO

FieldTypeLabelDescription
file FileInReviewDTO required
See FileInReviewDTO parameters
ignoreWhitespace bool required
Whether to ignore whitespace changes
revisions RevisionsSetDTO optional
See RevisionsSetDTO parameters
showUnrelatedChanges bool optional
Whether to show the changes that were filtered out in the review diff. 'false' by default.
contextLines int32 optional
Number of context lines around the modified fragment

M FileInReviewDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
file FileInRevisionDTO required
See FileInRevisionDTO parameters

M FileInReviewReadStatusRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
file string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
revisions RevisionsSetDTO required
See RevisionsSetDTO parameters
markAsUnread bool optional
Pass 'true' to mark the file as unread

M FileMergeInlineDiffRequestDTO

FieldTypeLabelDescription
fileId FileInRevisionDTO required
See FileInRevisionDTO parameters
sourceRevisionId string required
The source revision from which the branch originated
baseBranch string required
The base branch to compare against
diffType DiffTypeEnum required
Type of change (see DiffTypeEnum)
ignoreWhitespace bool required
Whether to ignore whitespace changes
contextLines int32 optional
Number of context lines around the modified fragment

M FileMetaResponseDTO

FieldTypeLabelDescription
isUpToDate bool required
Whether the current revision is the latest
isDeleted bool required
Whether the file is deleted
isMerged bool required
Whether the file is merged into the default branch
lastModifiedRevision RevisionInfoDTO required
See RevisionInfoDTO parameters
isLastModifiedRevisionMerged bool required
Is last modified revision merged into the default branch
deletedInRevision RevisionInfoDTO optional
See RevisionInfoDTO parameters
deletedInBranch string optional
Holds the branch in which the current file is deleted
modifiedInParallelBranches RevisionInBranchDTO repeated
See RevisionInBranchDTO parameters
defaultBranch string optional
The default branch (null if not set)

M FileOwnershipSummaryDTO

FieldTypeLabelDescription
filePath string required
A full path to the file starting with a slash (e.g. /directory/file.txt)
state OwnershipSummaryEnum required
See OwnershipSummaryEnum parameters
userId string optional
Upsource user ID

M FindCommitsRequestDTO

FieldTypeLabelDescription
commits FindCommitsRequestPatternDTO repeated
See FindCommitsRequestPatternDTO parameters
requestChanges bool optional
Whether revision changes should be returned along with revision metadata (unused, left for compatibility with older clients)
limit int32 optional
Number of commits to return

M FindCommitsRequestPatternDTO

FieldTypeLabelDescription
revisionId string optional
VCS revision ID
projectId string optional
Project ID in Upsource
messageFragment string optional
A fragment of the commit message used as a search query
author string optional
Name of the commit author
commitTime int64 optional
Unix timestamp of the commit

M FindCommitsResponseCommitDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
projectName string required
Project name
revision RevisionInfoDTO required
See RevisionInfoDTO parameters
changes RevisionsDiffDTO optional
See RevisionsDiffDTO parameters

M FindCommitsResponseCommitsDTO

FieldTypeLabelDescription
commits FindCommitsResponseCommitDTO repeated
See FindCommitsResponseCommitDTO parameters

M FindCommitsResponseDTO

FieldTypeLabelDescription
commits FindCommitsResponseCommitsDTO repeated
See FindCommitsResponseCommitsDTO parameters

M FindProjectsRequestDTO

FieldTypeLabelDescription
pattern string required
Search query, e.g. part of the name
limit int32 required
Number of projects to return
isExact bool optional
Whether to search for the exact match

M FindPullRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
branch string required
Branch name

M HidePredefinedLabelsRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
doHide bool required
Whether to show or hide predefined labels

M InspectionsCountDTO

FieldTypeLabelDescription
errors int32 required
warnings int32 required
weakWarnings int32 required
infos int32 required

M InviteUserRequestDTO

FieldTypeLabelDescription
projectId string required
ID of the Upsource project
email string required
Email address of the Upsource user

M InviteUserResponseDTO

FieldTypeLabelDescription
user UserRolesDTO optional
See UserRolesDTO parameters
isInvited bool required
Whether the user is already invited

M LabelDTO

FieldTypeLabelDescription
id string optional
Discussion label ID
name string required
Discussion label name (e.g. bug, code style, enhancement, help wanted)
colorId string optional
Discussion label color

M LabelsListDTO

FieldTypeLabelDescription
hidePredefinedLabels bool required
Indicates if predefined labels are hidden
predefinedLabels LabelDTO repeated
Predefined discussion labels. See LabelDTO parameters
customLabels LabelDTO repeated
Custom discussion labels. See LabelDTO parameters

M LabelsRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID in Upsource

M MatchingRevisionsResponseDTO

FieldTypeLabelDescription
revision RevisionInfoDTO repeated
See RevisionInfoDTO parameters

M ParticipantInReviewDTO

FieldTypeLabelDescription
userId string required
Participant user ID
role RoleInReviewEnum required
Participant's role in the review. See RoleInReviewEnum parameters
state ParticipantStateEnum optional
State of the participant. See ParticipantStateEnum parameters

M ParticipantInReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
participant ParticipantInReviewDTO required
See ParticipantInReviewDTO parameters

M ParticipantProgressDTO

FieldTypeLabelDescription
userId string required
User ID of the review participant
readFilesCount int32 required
Number of files that were viewed by the participant
lastSeenTimestamp int64 required
Unix timestamp of the last viewing

M ParticipantStateChangedDTO

FieldTypeLabelDescription
participant string required
An Upsource user ID of the participant
oldState ParticipantStateEnum required
See ParticipantStateEnum parameters
newState ParticipantStateEnum required
See ParticipantStateEnum parameters

M ProjectConfigurationResponseDTO

FieldTypeLabelDescription
supportedVcs string repeated
VCS types supported by the Upsource instance

M ProjectFounderDTO

FieldTypeLabelDescription
userId string required
User ID of the person who created the project
date int64 required
Unix timestamp of project creation

M ProjectGroupDTO

FieldTypeLabelDescription
name string required
Name of the Hub group
description string required
Description of the Hub group

M ProjectInfoDTO

FieldTypeLabelDescription
projectName string required
Project name
projectId string required
Project ID in Upsource
headHash string required
Head revision ID
codeReviewIdPattern string required
Code review ID pattern
externalLinks ExternalLinkDTO repeated
External links. See ExternalLinkDTO parameters
issueTrackerConnections ExternalLinkDTO repeated
Configured issue tracker links
projectModelType string required
Build system type ("none" to disable code intelligence, "maven" for Maven, "gradle" for Gradle, "idea" for IntelliJ IDEA)
defaultEffectiveCharset string required
Default encoding (e.g. UTF-8)
defaultBranch string optional
Default branch
issueTrackerDetails IssueTrackerProjectDetailsDTO optional
See IssueTrackerProjectDetailsDTO parameters
isConnectedToGithub bool required
Whether the project is connected to GitHub
isConnectedToGitlab bool required
Whether the project is connected to GitLab
iconUrl string optional
URL of the project icon
group ProjectGroupDTO optional
See ProjectGroupDTO parameters
isArchived bool optional
issueTrackerProjectDetails IssueTrackerProjectDetailsDTO repeated
See IssueTrackerProjectDetailsDTO parameters

M ProjectItemsListDTO

FieldTypeLabelDescription
items ProjectTreeItemDTO repeated
See ProjectTreeItemDTO parameters

M ProjectModel

FieldTypeLabelDescription
type string required
Build system type ("none" to disable code intelligence, "maven" for Maven, "gradle" for Gradle, "idea" for IntelliJ IDEA)
pathToModel string optional
Path to project model
defaultJdkId string optional
Default project JDK

M ProjectReadmeResponseDTO

FieldTypeLabelDescription
text string required
Text of the README file
fileName string required
A full path to the README file starting with a slash (e.g. /directory/readme.txt)
revisionId string required
Revision ID

M ProjectSettingsDTO

FieldTypeLabelDescription
projectName string required
Project name
vcsSettings string optional
VCS configuration represented as a JSON-encoded string
checkIntervalSeconds int64 optional
How often to check for new commits (in seconds)
projectModel ProjectModel required
See ProjectModel parameters
codeReviewIdPattern string required
Code review ID pattern
runInspections bool optional
Whether to run code inspections
inspectionProfileName string optional
Name of the inspection profile in IntelliJ IDEA
mavenSettings string optional
The contents of maven-settings.xml
mavenProfiles string optional
Maven profiles. Space- or comma-separated list
mavenJdkName string optional
Maven project JDK
modelConversionSystemProperties string optional
Model conversion system properties
gradleProperties string optional
Gradle properties
gradleInitScript string optional
Gradle init script
externalLinks ExternalLinkDTO repeated
See ExternalLinkDTO parameters
issueTrackerProviderSettings IssueTrackerProviderSettingsDTO optional
See IssueTrackerProviderSettingsDTO parameters
userManagementUrl string optional
Hub user management page URL
defaultEncoding string optional
Default encoding (e.g. UTF-8)
defaultBranch string optional
Default branch
ignoredFilesInReview string repeated
A newline-separated list of wildcards. Files matching the patterns specified here will be excluded from reviews
skipFileContentsImport string repeated
A newline-separated list of wildcards. Files matching the patterns specified here — binaries, for example — won't be imported.
javascriptLanguageLevel string optional
JavaScript language level (one of the following: JS_1_5, ES5, JS_1_8_5, ES6, JSX, NASHORN, FLOW)
phpLanguageLevel string optional
PHP language level (one of the following: null, 5.3.0, 5.4.0, 5.5.0, 5.6.0, 7, 7.1)
phpExternalDependencies string repeated
List of paths to external dependencies for a PHP project
phpComposerScript string repeated
List of commands that will be run to set up PHP composer. Default command is "php composer.phar install"
pythonLanguageLevel string optional
Python language level (one of the following: null, 2, 3)
buildStatusReceiveToken string optional
"login:password" credentials used to receive build status from the build server
authorCanCloseReview bool optional
In addition to CLOSE_REVIEW permission, controls whether review authors can close reviews
authorCanDeleteReview bool optional
In addition to DELETE_REVIEW permission, controls whether review authors can delete reviews
limitResolveDiscussion bool optional
In addition to EDIT_REVIEW permission, controls whether only the person that started a discussion can resolve it
reviewDeadlineHours int32 optional
Default review deadline, in hours
addMergeCommitsToBranchReview bool optional
Sets whether merge commits should be added to branch reviews
isArchived bool optional
Whether the project is archived

M ProjectTreeItemDTO

FieldTypeLabelDescription
displayName string required
Display name of a project tree item
displayType string required
Display type – directory, module, file, etc.
isDirectory bool required
Whether an item is a directory
isModule bool required
Whether an item is a module
fileId string required
Path to file
hasChildren bool required
Whether an item has children and can be expanded

M RangeMappingDTO

FieldTypeLabelDescription
from RangeDTO required
Starting line number
to RangeDTO required
Ending line number

M ReactionDTO

FieldTypeLabelDescription
id string required
ID of the reaction
usersIds string repeated
List of Upsource user IDs

M ReactionTargetDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string optional
If the reaction corresponds to a comment, ID of the discussion containing that comment
commentId string optional
If the reaction corresponds to a comment, ID of that comment
revisionId string optional
If the reaction corresponds to a revision, ID of that revision
reviewId string optional
If the reaction corresponds to a review, ID of that review

M RemoveCommentRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
An ID of the discussion being removed
commentId string required
An ID of the comment being removed

M RemoveCommentResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M RenameReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
text string required
New review title

M RenameReviewResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M ResolveDiscussionRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
ID of the discussion
isResolved bool required
Whether the discussion is resolved
revision string optional
ID of the revision the discussion is linked to

M ResolveDiscussionResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M ReviewDeadlineRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
deadline int64 optional
Review due date (Unix timestamp)

M ReviewDescriptorDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
title string required
Review title
description string optional
Review description
participants ParticipantInReviewDTO repeated
See ParticipantInReviewDTO parameters
state ReviewStateEnum required
Review state: open(1), closed(2)
isUnread bool optional
Whether the review is unread by the requester
isReadyToClose bool optional
'true' if all reviewers have accepted the changes but the review is still open
branch string repeated
Names of tracked branches
issue IssueIdDTO repeated
List of issue IDs linked to the review
isRemoved bool optional
Whether the review has been removed
createdAt int64 required
Unix timestamp of review creation
createdBy string optional
ID of the user who created the review
updatedAt int64 required
Unix timestamp of the last update
completionRate CompletionRateDTO optional
Review completion rate (e.g. accepted by 1 out of 3 reviewers). See CompletionRateDTO parameters
discussionCounter SimpleDiscussionCounterDTO optional
A list of discussion counters. See SimpleDiscussionCounterDTO parameters
deadline int64 optional
Review due date (Unix timestamp)
isMuted bool optional
Whether the review is muted by the currently logged-in user
labels LabelDTO repeated
Review labels
mergeFromBranch string optional
Merge review: branch to merge from
mergeToBranch string optional
Merge review: branch to merge into

M ReviewInspectionsDiffRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
revisions RevisionsSetDTO optional
IDs of the requested revisions

M ReviewListDTO

FieldTypeLabelDescription
reviews ReviewDescriptorDTO repeated
See ReviewDescriptorDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request
totalCount int32 required
Total number of reviews

M ReviewOwnershipSummaryDTO

FieldTypeLabelDescription
files FileOwnershipSummaryDTO repeated
See FileOwnershipSummaryDTO parameters

M ReviewProgressDTO

FieldTypeLabelDescription
participants ParticipantProgressDTO repeated
Individual progress for each participant
totalFiles int32 required
Total number of files in review

M ReviewsRequestDTO

FieldTypeLabelDescription
limit int32 required
Number of reviews to return
query string optional
Search query (e.g. "state: open") and/or phrase appearing in review title or discussion
sortBy string optional
Sort by: last updated ("updated", default), review ID ("id,asc", "id,desc"), title ("title"), due date ("deadline,asc", "deadline,desc")
projectId string optional
Project ID in Upsource
skip int32 optional
Number of reviews to skip from the top (for pagination)

M ReviewStateChangedDTO

FieldTypeLabelDescription
oldState ReviewStateEnum required
See ReviewStateEnum parameters
newState ReviewStateEnum required
See ReviewStateEnum parameters

M ReviewSuggestDTO

FieldTypeLabelDescription
reviewInfo ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameter
score float optional
The confidence score

M ReviewSummaryChangesRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
revisions RevisionsSetDTO optional
IDs of the requested revisions

M ReviewSummaryChangesResponseDTO

FieldTypeLabelDescription
diff RevisionsDiffDTO optional
See RevisionsDiffDTO parameters
annotation string optional
Review annotation message, e.g. "Some revisions in review are not indexed yet", "Review has too many files"
ignoredFiles string repeated
The list of files that were omitted in a review according to project settings
fileDiffSummary FileDiffSummaryDTO repeated
See FileDiffSummaryDTO parameters

M ReviewSummaryDiscussionsRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
revisions RevisionsSetDTO optional
See RevisionsSetDTO parameters

M ReviewTargetBranchDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
targetBranch string required
Branch to merge into

M RevisionBranchesResponseDTO

FieldTypeLabelDescription
branchName string repeated
Branches containing the given revision

M RevisionBuildStatusDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string required
VCS revision ID
keys RevisionBuildStatusKeyDTO repeated
A unique build identifier (e.g. PROJECT-VERSION-1234)

M RevisionBuildStatusKeyDTO

FieldTypeLabelDescription
status BuildStatusEnum required
Build status: Success(1), Failed(2), InProgress(3)
name string optional
Build name (e.g. "#1.0.1000")
url string optional
Build URL (e.g. "http://teamcity-server/build-url")
description string optional
Build description (e.g. "120 of 1500 tests failed")

M RevisionBuildStatusListDTO

FieldTypeLabelDescription
buildStatus RevisionBuildStatusDTO repeated
Build status: Success(1), Failed(2), InProgress(3)

M RevisionChangesRequestDTO

FieldTypeLabelDescription
revision RevisionInProjectDTO required
See RevisionInProjectDTO parameters
compareToRevisionId string optional
ID of the revision to compare with
limit int32 required
How many files to return
skip int32 optional
Number of files to skip from the top (for pagination)

M RevisionDescriptorListDTO

FieldTypeLabelDescription
revision RevisionInfoDTO repeated
See RevisionInfoDTO parameters
graph RevisionListGraphDTO optional
See RevisionListGraphDTO parameters
headHash string optional
Head revision ID
query string optional
Search query

M RevisionDiffItemDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
diffType DiffTypeEnum required
See DiffTypeEnum parameters
newFile FileInRevisionDTO required
See FileInRevisionDTO parameters
oldFile FileInRevisionDTO optional
See FileInRevisionDTO parameters
fileIcon string optional
Indicates type of file (e.g. "file:xml")
isRead bool required
Whether the diff has been viewed by the user. When returned by the findCommits method, isRead is always set to 'true'.
conflictType ConflictTypeEnum optional
When the diff relates to the merge result, holds the conflict type (see ConflictTypeEnum)

M RevisionDiscussionCountersListDTO

FieldTypeLabelDescription
counter SimpleDiscussionCounterDTO repeated
A discussion counter for a revision (number of discussions)

M RevisionDiscussionCountersRequestDTO

FieldTypeLabelDescription
revisions RevisionListDTO required
See RevisionListDTO parameters
fileNameFilter string optional
Additional revisions filter

M RevisionExternalInspectionsDiffResponseDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string required
VCS revision ID
files FileExternalInspectionsDiffResponseDTO repeated
Files that contain differing inspections

M RevisionInBranchDTO

FieldTypeLabelDescription
revision RevisionInfoDTO required
See RevisionInfoDTO parameters
branch string optional
Branch name

M RevisionInfoDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string required
Upsource revision ID (may differ from VCS revision ID in case of a multi-root project)
revisionDate int64 required
Revision date (author date in case of Git which differentiates author and committer dates)
effectiveRevisionDate int64 required
Revision date that agrees with graph topology (this means that child revisions will always have a larger effective date). In case of Git, can be equal to either author or committer date.
revisionCommitMessage string required
Commit message of the revision
state RevisionStateEnum required
Revision state: none(1), found(2), imported(3)
vcsRevisionId string required
The VCS revision ID
shortRevisionId string required
Short revision ID
authorId string required
User ID of the commit's author
reachability RevisionReachabilityEnum required
See RevisionReachabilityEnum parameters
tags string repeated
Revision tags, if any
branchHeadLabel string repeated
Branch head labels, if any
parentRevisionIds string repeated
List of parent revisions IDs

M RevisionListDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
revisionId string repeated
IDs of the requested revisions

M RevisionListGraphDTO

FieldTypeLabelDescription
width int32 required
"Width" of a graph, i.e. how many branches running in parallel does it have
rows RevisionListGraphRowDTO repeated
See RevisionListGraphRowDTO parameters

M RevisionListGraphEdgeDTO

FieldTypeLabelDescription
position int32 required
Edge position index
toPosition int32 required
Connecting edge position index
isUp bool required
Whether a line is directed up or down
isSolid bool required
Whether a line is solid or dashed
hasArrow bool required
Whether a line ends with an arrow
color int32 required
Edge color

M RevisionListGraphNodeDTO

FieldTypeLabelDescription
position int32 required
Node position index
color int32 required
Node color

M RevisionListGraphRowDTO

FieldTypeLabelDescription
nodes RevisionListGraphNodeDTO repeated
See RevisionListGraphNodeDTO parameters
edges RevisionListGraphEdgeDTO repeated
See RevisionListGraphEdgeDTO parameters

M RevisionOwnershipSummaryDTO

FieldTypeLabelDescription
revisionId string required
VCS revision ID
userId string required
Upsource user ID

M RevisionReviewInfoDTO

FieldTypeLabelDescription
reviewInfo ShortReviewInfoDTO optional
See ShortReviewInfoDTO parameters

M RevisionReviewInfoListDTO

FieldTypeLabelDescription
reviewInfo RevisionReviewInfoDTO repeated
See RevisionReviewInfoDTO parameters

M RevisionsDiffDTO

FieldTypeLabelDescription
diff RevisionDiffItemDTO repeated
See RevisionDiffItemDTO parameters

M RevisionsDiffRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
baseRevision string required
ID of the base revision
secondRevision string required
ID of the revision that should be compared to the base revision

M RevisionsExternalInspectionsDiffResponseDTO

FieldTypeLabelDescription
diff RevisionExternalInspectionsDiffResponseDTO repeated
See RevisionExternalInspectionsDiffResponseDTO

M RevisionsInReviewDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
revisionId string repeated
IDs of the revisions attached to the review

M RevisionsInReviewResponseDTO

FieldTypeLabelDescription
allRevisions RevisionDescriptorListDTO required
See RevisionDescriptorListDTO parameters
newRevisions RevisionsSetDTO required
See RevisionsSetDTO parameters
hasMissingRevisions bool required
The review contains revisions that are no longer found in VCS (due to a rebase operation, for example)
canSquash bool required
Indicates that revisions could have been squashed, meaning that the review can be squashed as well
branchHint string optional
An optional field denoting that all revisions in a review are on a same branch
canTrackBranch bool optional
An optional field denoting that review can be converted to branch review
canCherryPickWithTeamCity bool optional
Internal

M RevisionsListFilteredRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
query string required
Search query (e.g. "branch: master") and/or part of the commit message
limit int32 required
Number of revisions to return
skip int32 optional
Number of revisions to skip from the top (for pagination)
requestGraph bool optional
Whether revision graph should be returned

M RevisionsListRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
limit int32 required
Number of revisions to return
skip int32 optional
Number of revisions to skip from the top (for pagination)
requestGraph bool optional
Whether revision graph should be returned

M RevisionsListUpdateRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
limit int32 required
Number of revisions to return
hash string optional
Current head revision ID
messageSubstring string repeated
Additional filter by message (applied as AND)

M RevisionsListUpdateResponseDTO

FieldTypeLabelDescription
revision RevisionInfoDTO repeated
See RevisionInfoDTO parameters
hash string required
Current head revision ID

M RevisionsOwnershipSummaryDTO

FieldTypeLabelDescription
revisionOwner RevisionOwnershipSummaryDTO repeated
See RevisionOwnershipSummaryDTO

M RevisionsSetDTO

FieldTypeLabelDescription
revisions string repeated
IDs of the requested revisions
selectAll bool optional
Set this to "true" to request all revisions without enumerating them

M RevisionSuggestDTO

FieldTypeLabelDescription
revisionId string required
Revision info
score float required
The confidence score

M RoleDetailsDTO

FieldTypeLabelDescription
id string required
Role ID
key string required
Role key (e.g. project-admin)
name string required
Role name (e.g. Project admin)
description string optional
Role description

M RoleDTO

FieldTypeLabelDescription
key string required
Role key (e.g. project-admin)
isGlobal bool required
Whether the role is a global one in Hub
isGroup bool required
Whether the role is assigned to a group

M SanitizeHTMLRequestDTO

FieldTypeLabelDescription
html string required
The HTML string to sanitize
isBasicMarkup bool required
"true" allows only basic HTML markup (text formatting, images, links), "false" additionally allows block-level HTML elements and tables

M SanitizeHTMLResponseDTO

FieldTypeLabelDescription
sanitizedHTML string required
Sanitized HTML string

M SetReviewTargetBranchResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M ShortProjectInfoDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
projectName string required
Project name
headHash string optional
Head revision ID
isReady bool required
Whether project initialization is completed
lastCommitDate int64 optional
Unix timestamp of the last commit
lastCommitAuthorName string optional
User ID of the last commit's author
iconUrl string optional
URL of the project icon
group ProjectGroupDTO optional
See ProjectGroupDTO parameters
founder ProjectFounderDTO optional
Who and when created the project
lastDayCommits int32 optional
Number of commits made in the last 24 hours
lastMonthCommits int32 optional
Number of commits made in the last 30 days
totalCommits int32 optional
Total number of commits in the project
isArchived bool optional
Whether the project is archived

M ShortProjectInfoListDTO

FieldTypeLabelDescription
project ShortProjectInfoDTO repeated
See ShortProjectInfoDTO parameters

M ShortReviewInfoDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
title string required
Review title
state ReviewStateEnum required
Review state: open(1), closed(2)
branch string repeated
Names of tracked branches
completionRate CompletionRateDTO optional
See CompletionRateDTO parameters
labels LabelDTO repeated
Review labels

M SimpleDiscussionCounterDTO

FieldTypeLabelDescription
count int32 required
Total number of discussions
hasUnresolved bool required
Contains unresolved discussions
unresolvedCount int32 required
Number of unresolved discussions
resolvedCount int32 required
Number of resolved discussions

M StacktraceDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
stacktrace string required
Stacktrace text to be analyzed
revisionId string optional
VCS revision ID

M StacktracePositionDTO

FieldTypeLabelDescription
lineNumber int32 required
Line number that corresponds to the given stacktrace
fullPath string required
A full path of the file
vcsCommitId string optional
Revision ID
interpolatedRange RangeDTO optional
See RangeDTO parameters

M StacktracePositionsDTO

FieldTypeLabelDescription
positions StacktracePositionDTO repeated
See StacktracePositionDTO parameters

M StartBranchTrackingRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
Review ID
branch string required
Branch name to track

M StopBranchTrackingRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
Review ID
branch string optional
Branch name to stop tracking. When none specified, tracking of all branches will stop.

M SuggestedReviewListDTO

FieldTypeLabelDescription
suggest ReviewSuggestDTO repeated

M SuggestedRevisionListDTO

FieldTypeLabelDescription
suggest RevisionSuggestDTO repeated

M TestConnectionRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID
vcsSettings string required
VCS configuration represented as a JSON-encoded string

M TestConnectionResponseDTO

FieldTypeLabelDescription
status TestConnectionStatusEnum required
See TestConnectionStatusEnum parameters
message string optional
Response message

M ToggleReactionRequestDTO

FieldTypeLabelDescription
target ReactionTargetDTO required
See ReactionTargetDTO parameters
reactionId string required
ID of the reaction
doAdd bool required
Whether to add or remove the reaction

M ToggleReviewMutedRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
doMute bool required
Whether to mute or to unmute

M UncommittedRevisionDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
parentRevisionId string required
Parent revision ID
files string repeated
List of modified files (added, deleted, updated)

M UpdateCommentRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
An ID of the discussion being updated
commentId string required
An ID of the comment being updated
text string required
New text of the comment being updated
markupType string optional
Currently not in use

M UpdateCommentResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M UpdateDiscussionFlagRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
Discussion ID
isFlagged bool required
Whether the discussion is flagged (starred)

M UpdateDiscussionLabelRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
ID of the discussion
label LabelDTO required
Discussion label being added or removed. See LabelDTO parameters

M UpdateParticipantInReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
state ParticipantStateEnum required
State of the participant. See ParticipantStateEnum parameters
userId string optional
User ID. When set, this user's participant state will be changed.

M UpdateParticipantInReviewResponseDTO

FieldTypeLabelDescription
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M UpdateReviewLabelRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
reviewId ReviewIdDTO optional
See ReviewIdDTO parameters
label LabelDTO required
Review label being added or removed. See LabelDTO parameters

M UpdateReviewLabelResponseDTO

FieldTypeLabelDescription
label LabelDTO required
The review label
syncResult SyncResultEnum optional
GitHub sync result. See SyncResultEnum parameters

M UpdateTaskListRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
discussionId string required
An ID of the discussion being updated
commentId string required
An ID of the comment being updated
itemIndex int32 required
Index of the task list item being updated
itemValue bool required
New value of the task list item being updated

M UserRevisionsListRequestDTO

FieldTypeLabelDescription
userId string required
ID of the specified Upsource user
limit int32 required
Number of revisions to return
query string optional
Search query (e.g. "branch: master") and/or part of the commit message

M UserRolesDTO

FieldTypeLabelDescription
userId string required
ID of the Upsource user
roles RoleDTO repeated
See RoleDTO parameters

M UsersRolesRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
offset int32 required
Paging offset
pageSize int32 required
Page size
query string optional
Search query

M UsersRolesResponseDTO

FieldTypeLabelDescription
userRoles UserRolesDTO repeated
See UserRolesDTO parameters
hasMore bool required
Whether all available items have been returned or more can be requested by passing the corresponding 'limit' value in the subsequent request

M VcsHostingRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID in Upsource

M VcsHostingResponseDTO

FieldTypeLabelDescription
service VcsHostingServiceDTO repeated
See VcsHostingServiceDTO parameters

M VcsHostingServiceDTO

FieldTypeLabelDescription
serviceId string required
VCS hosting service ID
serviceUrl string required
VCS hosting service URL
repoIds string repeated
IDs of the VCS repositories
canCreateRepository bool required
Whether the requester has permission to create repositories in the VCS service

M VcsRepoDTO

FieldTypeLabelDescription
id string required
Repository ID
url string repeated
Repository URL

M VcsRepoListDTO

FieldTypeLabelDescription
repo VcsRepoDTO repeated
See VcsRepoDTO parameters

Enums

View as JSON

E AnalyzerProblemSeverityEnum

Describes analyzer problem severity
NameNumberDescription
Info 1
Warning 2
Error 3

E AppConfigurationProblemEnum

Describes a GitHub / GitLab configuration problem
NameNumberDescription
IncompatibleHub 1
MissingAuthModule 2

E BuildStatusEnum

Describes build status
NameNumberDescription
Success 1
Failed 2
InProgress 3

E ConflictTypeEnum

Describes merge conflict type
NameNumberDescription
NO_CONFLICT 1
CAN_BE_RESOLVED 2
CAN_NOT_BE_RESOLVED 3

E DiffTypeEnum

Describes file-level diff type
NameNumberDescription
Added 1
Removed 2
Modified 3
Commented 4

E FeedTypeEnum

Describes feed type
NameNumberDescription
Feed 1
Review 2

E OwnershipSummaryEnum

Describes file ownership
NameNumberDescription
OK 1
ONE_MAJOR 2
ALL_MINOR 3

E ParticipantStateEnum

Describes participant status
NameNumberDescription
Unread 1
Read 2
Accepted 3
Rejected 4

E ProjectStateEnum

Describes project status
NameNumberDescription
NotStarted 1
Initializing 2
Success 3
Failure 4

E ReadEnum

Describes read status of a feed item
NameNumberDescription
Read 1
Unread 2
ManuallyUnread 3

E ReviewFeedSortEnum

Describes review feed sorting criteria
NameNumberDescription
Natural 1
LastUpdated 2

E ReviewStateEnum

Describes review state
NameNumberDescription
Open 1
Closed 2

E RevisionReachabilityEnum

NameNumberDescription
Reachable 1
Revision is reachable via heads
Unknown 2
Unknown revision
NotReachable 3
Revision used to be reachable and can become 'Unknown' shortly

E RevisionStateEnum

Describes revision status
NameNumberDescription
None 1
Found 2
Imported 3

E SyncResultEnum

Describes status of a GitHub/GitLab synchronisation
NameNumberDescription
Ok 1
ProjectNotSynchronized 2
CommentNotSynchronized 3
ReviewNotSynchronized 4
AccessTokenNotProvided 5
GithubMisconfiguration 6
UnsupportedMethod 7
NotFound 8
InternalError 9
RateLimitExceeded 10
IoError 11

E TestConnectionStatusEnum

Describes status of a remote connection
NameNumberDescription
Success 1
Failure 2
Timeout 3