Create a default reviewer pull request condition for the given project.
string
RequiredThe details needed to create a default reviewer pull request condition.
integer
array<RestApplicationUser>
object
object
The default reviewer pull request condition that was created.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
curl --request POST \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/condition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"requiredApprovals": 1,
"reviewers": [
{
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
],
"sourceMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
},
"targetMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}Update the default reviewer pull request condition for the given ID.
string
Requiredstring
RequiredThe new details for the default reviewer pull request condition.
integer
array<RestApplicationUser>
object
object
The updated default reviewer pull request condition.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
curl --request PUT \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/condition/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"requiredApprovals": 1,
"reviewers": [
{
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
],
"sourceMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
},
"targetMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}Delete the default reviewer pull request condition associated with the given ID.
string
Requiredstring
RequiredAn empty response indicating that the pull request condition was deleted.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/condition/{id}'Return a page of default reviewer pull request conditions that have been configured for this project.
string
RequiredThe default reviewer pull request conditions associated with the given project.
array<RestPullRequestCondition>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/conditions' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}
]Create a default reviewer pull request condition for the given repository.
string
Requiredstring
RequiredThe details needed to create a default reviewer pull request condition.
integer
array<RestApplicationUser>
object
object
The default reviewer pull request condition that was created.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
curl --request POST \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"requiredApprovals": 1,
"reviewers": [
{
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
],
"sourceMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
},
"targetMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}Update the default reviewer pull request condition for the given ID.
string
Requiredstring
Requiredstring
Requiredinteger
array<RestApplicationUser>
object
object
The updated default reviewer pull request condition.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
curl --request PUT \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"requiredApprovals": 1,
"reviewers": [
{
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
],
"sourceMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
},
"targetMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"id": "ANY_REF",
"name": "Branch"
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}Delete the default reviewer pull request condition associated with the given ID.
string
Requiredinteger
Requiredstring
RequiredAn empty response indicating that the pull request condition was deleted
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/condition/{id}'Return a page of default reviewer pull request conditions that have been configured for this repository.
string
Requiredstring
RequiredThe default reviewer pull request conditions associated with the given repository.
array<RestPullRequestCondition>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/conditions' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}
]Return a set of users who are required reviewers for pull requests created from the given source repository and ref to the given target ref in this repository.
string
Requiredstring
Requiredstring
string
string
string
The default reviewer pull request conditions associated with the given repository.
array<RestPullRequestCondition>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/default-reviewers/latest/projects/{projectKey}/repos/{repositorySlug}/reviewers' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
[
{
"reviewers": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"requiredApprovals": 1,
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"sourceRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"targetRefMatcher": {
"displayId": "main",
"id": "refs/heads/main",
"type": {
"name": "Branch",
"id": "ANY_REF"
}
},
"id": 1
}
]Checks preconditions to determine whether the pull request can be rebased.
Some of the preconditions are:
refs/heads/git rebase records the current user as the committer for the rebased commits, which requires a name and e-mail addressThis list is not exhaustive, and the exact set of preconditions applied can be extended by third-party add-ons.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe rebaseability status of the pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
{
"vetoes": [
{
"detailedMessage": "You have insufficient permissions to rebase 'refs/heads/feature-branch'.",
"summaryMessage": "Insufficient branch permissions"
}
]
}Rebases the specified pull request, rewriting the incoming commits to start from the tip commit of the pull request's target branch. This operation alters the pull request's source branch and cannot be undone.
The authenticated user must have REPO_READ permission for the repository that this pull request targets and REPO_WRITE permission for the pull request's source repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe pull request rebase request.
integer
The merged pull request.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/git/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/rebase' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"version": 1
}'1
2
3
4
5
6
7
8
9
10
11
12
13
{
"refChange": {
"fromHash": "6053a1eaa1c009dd11092d09a72f3c41af1b59ad",
"refId": "refs/heads/master",
"toHash": "d6edcbf924697ab811a867421dab60d954ccad99",
"type": "ADD",
"ref": {
"displayId": "master",
"id": "refs/heads/master",
"type": "BRANCH"
}
}
}Add an emoticon reaction to a pull request comment
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
RequiredThe added reaction
1
2
3
curl --request PUT \
--url 'http://{baseurl}/rest/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
{
"emoticon": {
"shortcut": "<string>",
"url": "<string>",
"value": "<string>"
},
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comment": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
}Remove an emoticon reaction from a pull request comment
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
RequiredThe added reaction
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/comment-likes/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/reactions/{emoticon}'Retrieve the merge strategies available for this instance. The user must be authenticated to call this resource.
string
RequiredThe merge configuration of this instance.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/admin/pull-requests/{scmId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"strategies": [
{
"enabled": true,
"flag": "--no-ff",
"description": "Always create a merge commit",
"name": "Merge commit",
"id": "no-ff"
}
],
"commitSummaries": 2154,
"defaultStrategy": {
"enabled": true,
"flag": "--no-ff",
"description": "Always create a merge commit",
"name": "Merge commit",
"id": "no-ff"
},
"type": "repository"
}Update the pull request merge strategies for the context repository.
The authenticated user must have ADMIN permission to call this resource.
Only the strategies provided will be enabled, only one may be set to default
An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:```{ "mergeConfig": { } }
1 2Upon completion of this request, the effective configuration will be the default configuration.
string
Requiredthe settings
object
The repository pull request merge strategies for the context repository.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/admin/pull-requests/{scmId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"mergeConfig": {
"strategies": [
{
"id": "no-ff",
"links": {}
}
],
"commitSummaries": 2154,
"defaultStrategy": {
"id": "no-ff",
"links": {}
}
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"strategies": [
{
"enabled": true,
"flag": "--no-ff",
"description": "Always create a merge commit",
"name": "Merge commit",
"id": "no-ff"
}
],
"commitSummaries": 2154,
"defaultStrategy": {
"enabled": true,
"flag": "--no-ff",
"description": "Always create a merge commit",
"name": "Merge commit",
"id": "no-ff"
},
"type": "repository"
}Retrieve a page of pull requests in the current repository that contain the given commit. The user must be authenticated and have access to the specified repository to call this resource.
string
Requiredstring
Requiredstring
Requirednumber
number
Return a page of pull requests in the current repository containing the given commit.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/pull-requests' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
{
"values": [
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Retrieve a page of participant users for all the pull requests to or from the specified repository. Optionally clients can specify following filters.
string
Requiredstring
Requiredstring
string
string
number
number
A page of users that match the search criteria.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/participants' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"values": [
{
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Retrieve a page of pull requests to or from the specified repository.
The authenticated user must have REPO_READ permission for the specified repository to call this resource. Optionally clients can specify PR participant filters. Each filter has a mandatory username.N parameter, and the optional role.N and approved.N parameters.
string
Requiredstring
Requiredstring
string
string
string
string
string
string
number
number
A page of pull requests that match the search criteria.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
{
"values": [
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Create a new pull request from a source branch or tag to a target branch. The source and target may be in the same repository, or different ones. (Note that different repositories must belong to the same Repository#getHierarchyId() hierarchy.)
The fromRef may be a branch or a tag. The toRef is required to be a branch. Tags are not allowed as targets because tags are intended to be immutable and should not be changed after they are created.
The authenticated user must have REPO_READ permission for the fromRef and toRef repositories to call this resource.
string
Requiredstring
RequiredThe pull request data
integer
string
array<RestPullRequestParticipant>
integer
array<RestPullRequestParticipant>
integer
string
object
object
string
The newly created pull request.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"createdDate": 13590759200,
"htmlDescription": "<string>",
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"project": {
"avatarUrl": "<string>",
"avatar": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo",
"name": "My repo",
"links": {}
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"project": {
"avatarUrl": "<string>",
"avatar": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo",
"name": "My repo",
"links": {}
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true,
"links": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}Retrieve a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe specified pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}Update the title, description, reviewers or destination branch of an existing pull request.
Note: the reviewers list may be updated using this resource. However the author and participants list may not.
The authenticated user must either:
to call this resource.
string
Requiredstring
Requiredstring
RequiredThe updated pull request
integer
string
array<RestPullRequestParticipant>
integer
array<RestPullRequestParticipant>
integer
string
object
object
string
The updated pull request.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"createdDate": 13590759200,
"htmlDescription": "<string>",
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"links": {},
"slug": "jcitizen",
"name": "jcitizen",
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen",
"avatarUrl": "<string>"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"project": {
"avatarUrl": "<string>",
"avatar": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo",
"name": "My repo",
"links": {}
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"project": {
"avatarUrl": "<string>",
"avatar": "<string>",
"key": "PRJ",
"links": {}
},
"scmId": "git",
"slug": "my-repo",
"name": "My repo",
"links": {}
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true,
"links": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}Deletes a pull request.
To call this resource, users must be authenticated and have permission to view the pull request. Additionally, they must:
A body containing the version of the pull request must be provided with this request.
{ "version": 1 }
string
Requiredstring
Requiredstring
RequiredA body containing the version of the pull request
integer
The pull request was deleted.
1
2
3
4
5
6
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}' \
--header 'Content-Type: application/json' \
--data '{
"version": 2154
}'Streams the raw diff for a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
string
A raw diff for the specified pull request.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.diff' \
--header 'Accept: application/json'Streams a patch representing a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredA patch representing the specified pull request.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}.patch' \
--header 'Accept: application/json'Retrieve a page of activity associated with a pull request.
Activity items include comments, approvals, rescopes (i.e. adding and removing of commits), merges and more.
Different types of activity items may be introduced in newer versions of Stash or by user installed plugins, so clients should be flexible enough to handle unexpected entity shapes in the returned page.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
string
number
number
A page of activity relating to the specified pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"values": [
{
"action": "APPROVED",
"createdDate": 19990759200,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"id": 1
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Gets comments matching the given set of field values for the specified pull request. (Note this does not perform any kind of searching for comments by their text).
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
array<string>
string
number
number
A page of Comments from the supplied pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
{
"values": [
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Add a new blocker comment.
Comments can be added in a few places by setting different attributes:
General pull request blocker comment:
1 2 3 4{ "text": "A task on a pull request." }
Blocker reply to a comment:
1 2 3 4 5 6 7{ "text": "This reply is a task.", "parent": { "id": 1 } }
General blocker file comment:
1 2 3 4 5 6 7 8 9 10 11{ "text": "A blocker comment on a file.", "anchor": { "diffType": "RANGE", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } }
Blocker file line comment:
1 2 3 4 5 6 7 8 9 10 11 12 13 14{ "text": "A task on a particular line within a file.", "anchor": { "diffType": "COMMIT", "line": 1, "lineType": "CONTEXT", "fileType": "FROM", "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd", "path": "path/to/file", "srcPath": "path/to/file", "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b" } }
For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED.
For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:
'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:
If the current user is not a participant the user is added as a watcher of the pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe comment to add.
string
integer
string
integer
string
object
The newly created comment.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"text": "An insightful comment.",
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Retrieves a pull request comment.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe requested comment.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Update a comment, with the following restrictions:
Convert a comment to a task or vice versa.
Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER':
1 2 3 4 5{ "severity": "BLOCKER" }
Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL': ```
{ "severity": "NORMAL" }
1 2 3 4 5 6 7 8Resolve a blocker comment. Blocker comments can be resolved by setting the 'state' attribute to 'RESOLVED': ``` { "state": "RESOLVED" }
Note: the supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe comment to add.
string
integer
string
integer
string
object
The newly updated comment.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"text": "An insightful comment.",
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
The operation was successful.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/blocker-comments/{commentId}'Gets changes for the specified PullRequest.
If the changeScope query parameter is set to 'UNREVIEWED', the application will attempt to stream unreviewed changes based on the lastReviewedCommit of the current user, which are the changes between the lastReviewedCommit and the latest commit of the source branch. The current user is considered to not have any unreviewed changes for the pull request when the lastReviewedCommit is either null (everything is unreviewed, so all changes are streamed), equal to the latest commit of the source branch (everything is reviewed), or no longer on the source branch (the source branch has been rebased). In these cases, the application will fall back to streaming all changes (the default), which is the effective diff for the pull request. The type of changes streamed can be determined by the changeScope parameter included in the properties map of the response.
Note: This resource is currently not paged. The server will return at most one page. The server will truncate the number of changes to either the request's page limit or an internal maximum, whichever is smaller. The start parameter of the page request is also ignored.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
string
string
string
number
number
A page of unreviewed Changes for the current user from the supplied pull request, including the unreviewedCommits in the properties map.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
{
"conflict": {
"theirChange": {
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"type": "ADD",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"ourChange": {
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"type": "ADD",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
}
},
"contentId": "abcdef0123abcdef4567abcdef8987abcdef6543",
"fromContentId": "bcdef0123abcdef4567abcdef8987abcdef6543a",
"percentUnchanged": 98,
"srcExecutable": true,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"nodeType": "DIRECTORY",
"executable": true,
"type": "ADD",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
}Gets comments for the specified pull request and path.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
string
array<string>
string
array<string>
string
string
number
number
A page of Comments from the supplied pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments?path={path}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
{
"values": [
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Add a new comment.
Comments can be added in a few places by setting different attributes:
General pull request comment: {
"text": "An insightful general comment on a pull request."
}
Reply to a comment: {
"text": "A measured reply.",
"parent": {
"id": 1
}
}
General file comment: {
"text": "An insightful general comment on a file.",
"anchor": {
"diffType": "RANGE",
"fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
"path": "path/to/file",
"srcPath": "path/to/file",
"toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
}
}
File line comment: {
"text": "A pithy comment on a particular line within a file.",
"anchor": {
"diffType": "COMMIT",
"line": 1,
"lineType": "CONTEXT",
"fileType": "FROM",
"fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",
"path": "path/to/file",
"srcPath": "path/to/file",
"toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"
}
}
Add a new task.
Tasks are just comments with the attribute 'severity' set to 'BLOCKER':
General pull request task:
{
"text": "A task on a pull request.",
"severity": "BLOCKER"
}
Add a pending comment.
Pending comments are just comments with the attribute 'state' set to 'PENDING':
Pending comment:
{
"text": "This is a pending comment",
"state": "PENDING"
}
For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED.
For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe comment to add
string
integer
string
integer
string
object
The newly created comment.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"text": "An insightful comment.",
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Retrieves a pull request comment.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe requested comment.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Update a comment, with the following restrictions:
Convert a comment to a task or vice versa.
Comments can be converted to tasks by setting the 'severity' attribute to 'BLOCKER':
{
"severity": "BLOCKER"
}
Tasks can be converted to comments by setting the 'severity' attribute to 'NORMAL':
{
"severity": "NORMAL"
}
Resolve a task.
Tasks can be resolved by setting the 'state' attribute to 'RESOLVED':
{
"state": "RESOLVED"
}
Note: the supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe updated comment
string
integer
string
integer
string
object
The newly updated comment.
1
2
3
4
5
6
7
8
9
10
11
12
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"text": "An insightful comment.",
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
The operation was successful.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}'Apply a suggestion contained within a comment.
string
Requiredstring
Requiredstring
Requiredstring
RequiredA request containing other parameters required to apply a suggestion - The given versions/hashes must match the server's version/hashes or the suggestion application will fail (in order to avoid applying the suggestion to the wrong place
object
string
object
object
An empty response indicating the suggestion has been applied.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}/apply-suggestion' \
--header 'Content-Type: application/json' \
--data '{
"commentVersion": {
"asInt": 2154,
"present": true
},
"commitMessage": "A commit message",
"pullRequestVersion": {
"asInt": 2154,
"present": true
},
"suggestionIndex": {
"asInt": 2154,
"present": true
}
}'Retrieve commits for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
string
string
number
number
A page of commits from the supplied pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
{
"values": [
{
"authorTimestamp": 1359075920,
"committer": {
"emailAddress": "charlie@example.com",
"name": "Charlie"
},
"committerTimestamp": 1449075830,
"parents": [
{
"displayId": "abcdef0",
"id": "abcdef0123abcdef4567abcdef8987abcdef6543"
}
],
"author": {
"emailAddress": "charlie@example.com",
"name": "Charlie"
},
"message": "More work on feature 1",
"displayId": "abcdef0",
"id": "abcdef0123abcdef4567abcdef8987abcdef6543"
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Decline a pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
The body holder
string
integer
The pull request was declined.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"comment": "An optional comment explaining why the pull request is being declined",
"version": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}string
Requiredstring
Requiredstring
Requiredinteger
string
string
string
string
string
boolean
A raw diff for the specified pull request.
any
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff' \
--header 'Accept: application/json'Streams a diff within a pull request.
If the specified file has been copied, moved or renamed, the srcPath must also be specified to produce the correct diff.
Note: This RESTful endpoint is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
Requiredstring
string
string
string
string
string
string
string
string
number
A page of differences from a pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
{
"values": [
{
"truncated": true,
"lineComments": [
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{}
],
"closedDate": 19990759200,
"participants": [
{}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{}
],
"closedDate": 19990759200,
"participants": [
{}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
],
"source": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"binary": true,
"hunks": [
{
"truncated": true,
"sourceLine": 2154,
"sourceSpan": 2154,
"destinationLine": 2154,
"destinationSpan": 2154,
"segments": [
{}
],
"context": "<string>"
}
],
"destination": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"properties": {}
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Test whether a pull request can be merged.
A pull request may not be merged if:
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe mergeability status of the pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
{
"conflicted": true,
"outcome": "CLEAN",
"vetoes": [
{
"detailedMessage": "You have insufficient permissions to rebase 'refs/heads/feature-branch'.",
"summaryMessage": "Insufficient branch permissions"
}
]
}Merge the specified pull request.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
The body holder
string
object
string
string
integer
The merged pull request.
1
2
3
4
5
6
7
8
9
10
11
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"autoSubject": "(Optional, 5.7+) true to prepend an auto-generated subject to the message (default), or false to use the message as-is",
"context": {},
"message": "(Optional) A descriptive message for the merge commit",
"strategyId": "(Optional) squash",
"version": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}Retrieves a page of the participants for a given pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requirednumber
number
Details of the participants in this pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"values": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Assigns a participant to an explicit role in pull request. Currently only the REVIEWER role may be assigned.
If the user is not yet a participant in the pull request, they are made one and assigned the supplied role.
If the user is already a participant in the pull request, their previous role is replaced with the supplied role unless they are already assigned the AUTHOR role which cannot be changed and will result in a Bad Request (400) response code.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe participant to be added to the pull request, includes the user and their role
string
object
Details of the participants in this pull request.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"role": "AUTHOR",
"user": {
"active": true,
"avatarUrl": "<string>",
"displayName": "Jane Citizen",
"emailAddress": "jane@example.com",
"links": {},
"name": "jcitizen",
"slug": "jcitizen",
"type": "NORMAL"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}Change the current user's status for a pull request. Implicitly adds the user as a participant if they are not already. If the current user is the author, this method will fail.
The possible values for {@code status} are UNAPPROVED, NEEDS_WORK, or APPROVED.
If the new {@code status} is NEEDS_WORK or APPROVED then the {@code lastReviewedCommit} for the participant will be updated to the latest commit of the source branch of the pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe participant representing the status to set, includes the status of the participant
string
Details of the new participant.
1
2
3
4
5
6
7
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"status": "UNAPPROVED"
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}Unassigns a participant from the REVIEWER role they may have been given in a pull request.
If the participant has no explicit role this method has no effect.
Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.
The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
RequiredThe update completed.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}'Re-open a declined pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
Requiredstring
The body holder
integer
The merged pull request.
1
2
3
4
5
6
7
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"version": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
{
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
}Get the CommentThread threads which have Comment comments that have a CommentState#PENDING pending state and are part of the pull request review for the authenticated user.
string
Requiredstring
Requiredstring
Requirednumber
number
A page of Comments from the supplied pull request.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
{
"values": [
{
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"comments": [],
"version": 1,
"severity": "NORMAL",
"parent": {
"createdDate": 1359075920,
"updatedDate": 1449075920,
"text": "An insightful comment.",
"html": "<string>",
"anchored": true,
"pending": true,
"reply": true,
"anchor": {
"diffType": "COMMIT",
"fileType": "FROM",
"fromHash": "62a0505e8204115b8b9c8a95bfa264a8c0896a93",
"lineType": "ADDED",
"pullRequest": {
"createdDate": 13590759200,
"reviewers": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"closedDate": 19990759200,
"participants": [
{
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"role": "AUTHOR",
"status": "UNAPPROVED",
"approved": true,
"user": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
}
}
],
"updatedDate": 14490759200,
"title": "Talking Nerdy",
"fromRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"toRef": {
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe",
"repository": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"origin": {
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"defaultBranch": "main",
"relatedLinks": {},
"partition": 2154,
"scope": "REPOSITORY",
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"project": {
"scope": "PROJECT",
"avatar": "<string>",
"namespace": "<string>",
"description": "The description for my cool project",
"name": "My Cool Project",
"key": "PRJ",
"public": true,
"id": 2154,
"type": "NORMAL"
},
"scmId": "git",
"slug": "my-repo",
"archived": true,
"forkable": true,
"description": "My repo description",
"name": "My repo",
"public": true,
"id": 2154,
"state": "AVAILABLE"
},
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH"
},
"description": "It is a kludge, but put the tuple from the database in the cache.",
"version": 2154,
"open": true,
"id": 1,
"state": "DECLINED",
"locked": true,
"closed": true
},
"lineComment": true,
"line": 98,
"srcPath": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
},
"toHash": "3cdd5d19178a54d2e51b5098d43b57571241d0ab",
"path": {
"components": [
"path",
"to",
"file.txt"
],
"extension": "txt",
"name": "file.txt",
"parent": "path/to"
}
},
"author": {
"emailAddress": "jane@example.com",
"slug": "jcitizen",
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"active": true,
"displayName": "Jane Citizen"
},
"version": 1,
"severity": "NORMAL",
"id": 1,
"state": "OPEN",
"properties": {}
},
"id": 1,
"state": "OPEN",
"properties": {}
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Complete a review on a pull request.
string
Requiredstring
Requiredstring
RequiredThe REST request which contains comment text and participant status
string
string
Getting back the number of published comments and completing the review on a pull request.
any
1
2
3
4
5
6
7
8
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"commentText": "General comment text",
"participantStatus": "approved"
}'Discard a pull request review for the authenticated user.
The authenticated user must have REPO_READ permission for the repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe pull request review has been discarded.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/review'Add the authenticated user as a watcher for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe user is now watching the pull request.
1
2
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch'Remove the authenticated user as a watcher for the specified pull request.
The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.
string
Requiredstring
Requiredstring
RequiredThe user is no longer watching the pull request.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch'Retrieve a page of reviewer groups of a given scope.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
string
Requiredstring
Requirednumber
number
A page of reviewer group(s) of the provided scope and its inherited scope.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"values": [
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Create a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
string
Requiredstring
RequiredThe request containing the details of the reviewer group.
string
object
array<ApplicationUser>
string
string
integer
The newly created reviewer group.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"avatarUrl": "<string>",
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Retrieve a reviewer group.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe reviewer group.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Update the attributes of a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe request containing the attributes of the reviewer group to be updated. Only the attributes to be updated need to be present in this object.
string
object
array<ApplicationUser>
string
string
integer
The updated reviewer group.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"avatarUrl": "<string>",
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Deletes a reviewer group.
The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe operation was successful
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}'Retrieve a list of the users of a reviewer group.
This does not return all the users of the group, only the users who have REPO_READ permission for the specified repository.
The authenticated user must have REPO_READ permission for the specified repository to call this resource.
string
Requiredstring
Requiredstring
RequiredThe list of users of a reviewer group.
array<RestApplicationUser>
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/repos/{repositorySlug}/settings/reviewer-groups/{id}/users' \
--header 'Accept: application/json;charset=UTF-8'Retrieve a page of reviewer groups of a given scope.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
string
Requirednumber
number
A page of reviewer group(s) of the provided scope.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/settings/reviewer-groups' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
{
"values": [
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}
],
"size": 1,
"nextPageStart": 2154,
"isLastPage": true,
"start": 2154,
"limit": 25
}Create a reviewer group.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
string
RequiredThe reviewer group to be create
string
object
array<ApplicationUser>
string
string
integer
The newly created reviewer group.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request POST \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/settings/reviewer-groups' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"avatarUrl": "<string>",
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Retrieve a reviewer group.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
string
Requiredstring
RequiredThe reviewer group.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Update the attributes of a reviewer group.
The authenticated user must have PROJECT_READ permission for the specified project to call this resource.
string
Requiredstring
RequiredThe request containing the attributes of the reviewer group to be updated. Only the attributes to be updated need to be present in this object.
string
object
array<ApplicationUser>
string
string
integer
A page of changes.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
curl --request PUT \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"avatarUrl": "<string>",
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"scope": {
"resourceId": 2,
"type": "GLOBAL"
},
"users": [
{
"slug": "<string>",
"id": 2154,
"type": "NORMAL",
"active": true,
"displayName": "<string>",
"emailAddress": "<string>",
"name": "<string>"
}
],
"description": "null",
"name": "name",
"id": 2154
}Deletes a reviewer group.
The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.
string
Requiredstring
RequiredThe operation was successful.
1
2
curl --request DELETE \
--url 'http://{baseurl}/rest/api/latest/projects/{projectKey}/settings/reviewer-groups/{id}'Rate this page: