Upsource API Documentation Index

Messages

View as JSON

M BindVcsUsernameRequestDTO

FieldTypeLabelDescription
userId string required
User ID to register as an alias of the currently logged-in user

M CurrentUserResponseDTO

FieldTypeLabelDescription
userId string required
Upsource user ID
login string required
Upsource login
name string required
Visible name
isServerAdmin bool required
The user is a server admin
isGuestUser bool required
The user is a guest user
isTestUser bool required
The user is a test user
canCreateProjects bool required
The user has the right to create projects
emailStatus EmailStatusEnum required
See EmailStatusEnum parameters
adminPermissionsInProjects string repeated
The list of projects where the user has admin permissions
reviewEditPermissionsInProjects string repeated
The list of projects where the user has permission to edit reviews
reviewViewPermissionsInProjects string repeated
The list of projects where the user has permission to view reviews
codeContributePermissionsInProjects string repeated
The list of projects where the user has permission to create/merge pull requests
isEULAAccepted bool optional
Checks if EULA is accepted by the current user. Returns 'null' if EULA is not set up in Hub

M FindUsersRequestDTO

FieldTypeLabelDescription
projectId string optional
Project ID in Upsource
pattern string required
Search query, e.g. part of the name
limit int32 required
Number of results to return

M FullUserInfoDTO

FieldTypeLabelDescription
userId string required
Upsource user ID
name string required
Upsource user name
isResolved bool required
Whether the user has an account in Hub
isMe bool required
Flags the currently logged-in user
isOnline bool optional
Whether the user is online
avatarUrl string optional
URL of the userpic
profileUrl string optional
URL of the Hub user profile
email string optional
Email address
login string optional
Login
absentUntil int64 optional
Absence end date, if the user is currently on leave

M ProjectUserGroupsRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
query string optional
Search query, i.e. starting part of the name
limit int32 required
Maximum number of results to return

M UserAbsenceRequestDTO

FieldTypeLabelDescription
absentUntil int64 optional
Absence end date
userId string optional
User ID in Upsource ("null" denotes current user)

M UserGroupDTO

FieldTypeLabelDescription
id string required
Group ID
name string required
Group name
usersCount int32 required
Number of users participating in this group

M UserGroupsIdsListDTO

FieldTypeLabelDescription
ids string repeated
IDs of user groups

M UserGroupsListDTO

FieldTypeLabelDescription
groups UserGroupDTO repeated
List of user groups
hasMore bool required
Whether there are more groups by the request beyond the limit specified

M UserInfoRequestDTO

FieldTypeLabelDescription
ids string repeated
A list of user IDs to request the full user info for

M UserInfoResponseDTO

FieldTypeLabelDescription
infos FullUserInfoDTO repeated
See FullUserInfoDTO parameters

M UserPresenceInfoDTO

FieldTypeLabelDescription
userId string required
Upsource user ID
isOnline bool required
Whether the user is online
absentUntil int64 optional
Absence end date, if the user is currently on leave

M UserProjectInfoDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
lastCommitTime int64 required
Unix timestamp of the last commit

M UserProjectsRequestDTO

FieldTypeLabelDescription
userId string required
Upsource user ID
commitTimestampFilter int64 required
Project update timestamp to limit the returned projects by

M UserProjectsResponseDTO

FieldTypeLabelDescription
projects UserProjectInfoDTO repeated
See UserProjectInfoDTO parameters

M UsersForMentionRequestDTO

FieldTypeLabelDescription
projectId string required
Project ID in Upsource
reviewId string optional
ID of the Upsource review
revisionId string optional
ID of the revision
fileName string optional
A full path to the file starting with a slash (e.g. /directory/file.txt)
query string optional
Search query, e.g. part of the name
limit int32 required
Number of results to return

M UsersForReviewDTO

FieldTypeLabelDescription
result UsersListDTO required
Suggested reviewers for a given review
relevantUser string repeated
All relevant users
userRelevance int32 repeated
Users' relevance [0..100]

M UsersForReviewRequestDTO

FieldTypeLabelDescription
reviewId ReviewIdDTO required
See ReviewIdDTO parameters
role RoleInReviewEnum required
See RoleInReviewEnum parameters
query string optional
Search query, e.g. part of the name
limit int32 required
Number of results to return
timeout int64 optional
Timeout(ms) to calculate smart users suggestion, by default - 1 minute

M UsersListDTO

FieldTypeLabelDescription
me string optional
User ID of the logged-in user
suggestedUsers string repeated
User IDs of suggested users
suggestedUserRelevance int32 repeated
Users' relevance [0..100] as a reviewer
suggestedUserOpenedReviews int32 repeated
The number of open reviews the user has
committers string repeated
User IDs of suggested committers
others string repeated
User IDs of other suggested participants
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 UsersPresenceInfoResponseDTO

FieldTypeLabelDescription
presences UserPresenceInfoDTO repeated
See UserPresenceInfoDTO parameters

Enums

View as JSON

E EmailStatusEnum

Describes status of an email address
NameNumberDescription
OK 1
NotVerified 2
NotSpecified 3
HardBounce 4

E RoleInReviewEnum

Describes roles in a review
NameNumberDescription
Author 1
Reviewer 2
Watcher 3