Upsource API Documentation Index

Messages

View as JSON

M DeleteBranchEventBean

Removed branch in project
FieldTypeLabelDescription
name string required
Branch name

M DiscussionFeedEventBean

Discussion event
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
notificationReason NotificationReason required
Notification reason
discussionId string required
Discussion ID
commentId string optional
Comment ID
isEdit bool optional
Whether the event corresponds to comment editing
resolveAction bool optional
Indicates a change of the discussion's resolved status: true for resolve, false for un-resolve
commentText string optional
Comment text
isDeletion bool optional
Whether the event corresponds to comment deletion
projectId string optional
Anchor data for event
revisionId string optional
Anchor data for event
fileName string optional
Anchor data for event

M FeedEventBean

Base event details included in all other events
FieldTypeLabelDescription
userId UserIdBean optional
User that initiated the event
userIds UserIdBean repeated
List of users that will receive the event in their feeds
reviewNumber int32 optional
Associated review number
reviewId string optional
Associated review ID
date int64 required
Event date
actor UserIdBean required
User that initiated the event
feedEventId string optional
Event ID

M MergedToDefaultBranchEventBean

Merged changes to default branch
FieldTypeLabelDescription
commitsCount int32 required
Number of commits merged
branches string repeated
List of merged branches

M NewBranchEventBean

New branch in project
FieldTypeLabelDescription
name string required
Branch name

M NewParticipantInReviewFeedEventBean

Participant added to review
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
participant UserIdBean required
Participant user info
role ParticipantRole required
Participant role

M NewRevisionEventBean

New revision in project
FieldTypeLabelDescription
revisionId string required
Revision ID
branches string repeated
List of branches
author string optional
Author ID
message string optional
Commit message
date int64 optional
Commit date

M ParticipantStateChangedFeedEventBean

Review participant state changed
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
participant UserIdBean required
Participant user info
oldState ParticipantState required
Old state
newState ParticipantState required
New state

M PullRequestMergedFeedEventBean

Pull request merged
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
pullRequest string required
Branch name

M ReactionToggledEventBean

Reaction added or removed
FieldTypeLabelDescription
discussionId string required
Discussion ID
commentId string required
Comment ID
reactionId string required
Reaction ID
wasAdded bool required
Whether the reaction was added or removed
actor UserIdBean required
User who toggled reaction

M RemovedParticipantFromReviewFeedEventBean

Participant removed from review
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
participant UserIdBean required
Participant user info
formerRole ParticipantRole required
The role participant had before being removed from review

M ReviewCreatedFeedEventBean

Review created
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
revisions string repeated
List of revisions that were added to review at time of creation
branch string optional
Name of the branch being tracked by the review

M ReviewDeadlineUpdatedFeedEventBean

FieldTypeLabelDescription
base FeedEventBean required
Base feed event
deadline int64 optional
Review due date (Unix timestamp)

M ReviewLabelChangedEventBean

Review label added or removed
FieldTypeLabelDescription
reviewId string required
Review ID
labelId string required
Label ID
labelName string required
Label name
wasAdded bool required
Whether the label was added or removed
actor UserIdBean required
User who changed label

M ReviewRemovedFeedEventBean

Review removed
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
reviewId string required
Review ID

M ReviewSquashedFeedEventBean

Review squashed to revision
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
revisionId string required
Target Revision ID

M ReviewStateChangedFeedEventBean

Review state changed
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
oldState ReviewState required
Old state
newState ReviewState required
New state

M ReviewStoppedBranchTrackingFeedEventBean

Branch tracking stopped for review
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
branch string required
Branch name

M RevisionAddedToReviewFeedEventBean

Revision added to review
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
revisionId string optional
Revision ID (deprecated)
revisionIds string repeated
List of revision IDs

M RevisionRemovedFromReviewFeedEventBean

Revision removed from review
FieldTypeLabelDescription
base FeedEventBean required
Base feed event
revisionIds string repeated
List of revision IDs

M UserIdBean

User info
FieldTypeLabelDescription
userId string optional
userName string optional
userEmail string optional

Enums

View as JSON

E NotificationReason

Reason feed event appears in someone's feed
NameNumberDescription
Unknown 0
CommentInAuthorFeed 1
NotifyCommitAuthor 2
Mention 3
HashTagSubscription 4
DiscussionIsStarred 5
ParticipatedInDiscussion 6
ParticipatedInReview 7
Reply 8

E ParticipantRole

Review participant role
NameNumberDescription
Author 1
Reviewer 2
Watcher 3

E ParticipantState

Review participant state
NameNumberDescription
Unread 0
Read 1
Accepted 2
Rejected 3

E ReviewState

Review state
NameNumberDescription
Open 0
Closed 1