Resources Code Comment Query Basic Info
🤬
Query Basic Info
Http Method
GET
End Point
/api/code-comments
Query Parameters
Parameter Description Required Example
projectId Project id No 1
pullRequestId Pull request id No 1
query Syntax of this query is the same as query box in project code comments page No created by me
offset Offset Yes 0
count Count Yes 100
Response
Operation Successful
Status Code
200
Response Body
Content Type
application/json
Example
[ {
"id" : 1 ,
"projectId" : 1 ,
"userId" : 1 ,
"content" : "string" ,
"createDate" : "2022-08-12T09:58:07.630+00:00" ,
"lastUpdate" : {
"userId" : 1 ,
"date" : "2022-08-12T09:58:07.631+00:00" ,
"activity" : "string"
}
,
"replyCount" : 1 ,
"mark" : {
"commitHash" : "string" ,
"path" : "string" ,
"range" : {
"fromRow" : 1 ,
"fromColumn" : 1 ,
"toRow" : 1 ,
"toColumn" : 1 ,
"tabWidth" : 1
}
}
,
"compareContext" : {
"pullRequestId" : 1 ,
"oldCommitHash" : "string" ,
"newCommitHash" : "string" ,
"pathFilter" : "string" ,
"currentFile" : "string" ,
"whitespaceOption" : "DEFAULT"
}
,
"resolved" : true ,
"uuid" : "string"
}
]
Operation Failed
Status code
Status code other than 200 indicating the error type
Response Body
Error detail of content type "text/plain"
cURL Example
$ curl -u <login name>:<password or access token> -G https://crash.software/api/code-comments --data-urlencode projectId=1 --data-urlencode pullRequestId=1 --data-urlencode 'query=created by me' --data-urlencode offset=0 --data-urlencode count=100
Please wait...
Page is in error, reload to recover