コンテンツにスキップ
backlog-cli

Get list of comments on a pull request

GET
/projects/{projectIdOrKey}/git/repositories/{repoIdOrName}/pullRequests/{number}/comments

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
projectIdOrKey
required
string
repoIdOrName
required
string
number
required
integer format: int64

Query Parameters

Section titled “Query Parameters ”
count
integer format: int32
default: 20 >= 1 <= 100

Number of records to return (1–100, default: 20).

offset
integer format: int32

Number of records to skip.

order

Sort order direction.

string
Allowed values: asc desc

Sort order.

minId
integer format: int64
maxId
integer format: int64

Responses

Section titled “ Responses ”

200

Section titled “200 ”

The request has succeeded.

Array<object>

Pull request comment.

object
id
required
integer format: int64
content
required
string
changeLog
required
Array<object>

Change log entry in a comment.

object
field
required
string
newValue
required
string
nullable
originalValue
required
string
nullable
attachmentInfo
required
object
id
required
integer format: int64
name
required
string
attributeInfo
required
object
id
required
integer format: int64
typeId
required
string
notificationInfo
required
object
type
required
string
createdUser
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
created
required
string format: date-time
updated
required
string format: date-time
stars
required
Array<object>

Star object.

object
id
required
integer format: int64
comment
required
string
nullable
url
required
string
title
required
string
presenter
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
created
required
string format: date-time
notifications
required
Array<object>

Notification attached to a comment.

object
id
required
integer format: int64
alreadyRead
required
boolean
reason
required
integer format: int32
user
required

Backlog user.

object
id
required
integer format: int64
userId
required
string
name
required
string
roleType
required

User role type.

  • 1: Administrator
  • 2: Normal User
  • 3: Reporter
  • 4: Viewer
  • 5: Guest Reporter
  • 6: Guest Viewer
number
Allowed values: 1 2 3 4 5 6
lang
required
string
nullable
mailAddress
required
string
lastLoginTime
required
string format: date-time
nullable
nulabAccount
required
object
nulabId
required
string
name
required
string
uniqueId
required
string
resourceAlreadyRead
required
boolean

default

Section titled “default ”

An unexpected error response.

Error response wrapper returned by all Backlog API error responses.

object
errors
required
Array<object>

Individual error detail returned by the Backlog API.

object
message
required

Error message.

string
code
required

Error code.

  • 1: InternalError
  • 2: LicenceError
  • 3: LicenceExpiredError
  • 4: AccessDeniedError
  • 5: UnauthorizedOperationError
  • 6: NoResourceError
  • 7: InvalidRequestError
  • 8: SpaceOverCapacityError
  • 9: ResourceOverflowError
  • 10: TooLargeFileError
  • 11: AuthenticationError
  • 12: RequiredMFAError
  • 13: TooManyRequestsError
integer format: int32
moreInfo
required

Additional information about the error.

string