Retrieves a page of suggestions for pull requests that the currently authenticated user may wish to raise. Such suggestions are based on ref changes occurring and so contain the ref change that prompted the suggestion plus the time the change event occurred. Changes will be returned in descending order based on the time the change that prompted the suggestion occurred. Note that although the response is a page object, the interface does not support paging, however a limit can be applied to the size of the returned page.
string
string
A page of pull requests that match the search criteria.
1
2
3
curl --request GET \
--url 'http://{baseurl}/rest/api/latest/dashboard/pull-request-suggestions' \
--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
{
"values": [
{
"changeTme": 1359075920,
"refChange": {
"type": "ADD",
"ref": {
"id": "refs/heads/master",
"type": "BRANCH",
"displayId": "master"
},
"refId": "refs/heads/master",
"fromHash": "6053a1eaa1c009dd11092d09a72f3c41af1b59ad",
"toHash": "d6edcbf924697ab811a867421dab60d954ccad99"
},
"toRef": {
"id": "refs/heads/master",
"type": "BRANCH",
"displayId": "master"
},
"repository": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main",
"origin": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main"
}
},
"fromRef": {
"id": "refs/heads/master",
"type": "BRANCH",
"displayId": "master"
}
}
],
"size": 1,
"limit": 25,
"start": 2154,
"isLastPage": true,
"nextPageStart": 2154
}Retrieve a page of pull requests where the current authenticated user is involved as either a reviewer, author or a participant. The request may be filtered by pull request state, role or participant status.
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/dashboard/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": [
{
"locked": true,
"version": 2154,
"id": 1,
"state": "DECLINED",
"open": true,
"updatedDate": 14490759200,
"createdDate": 13590759200,
"toRef": {
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH",
"repository": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main",
"origin": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main"
}
},
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe"
},
"title": "Talking Nerdy",
"closed": true,
"description": "It is a kludge, but put the tuple from the database in the cache.",
"closedDate": 19990759200,
"fromRef": {
"id": "refs/heads/feature-ABC-123",
"type": "BRANCH",
"repository": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main",
"origin": {
"name": "My repo",
"id": 2154,
"state": "AVAILABLE",
"public": true,
"scmId": "git",
"slug": "my-repo",
"scope": "REPOSITORY",
"description": "My repo description",
"project": {
"name": "My Cool Project",
"key": "PRJ",
"id": 2154,
"type": "NORMAL",
"public": true,
"scope": "PROJECT",
"description": "The description for my cool project",
"namespace": "<string>",
"avatar": "<string>"
},
"relatedLinks": {},
"partition": 2154,
"hierarchyId": "e3c939f9ef4a7fae272e",
"statusMessage": "Available",
"archived": true,
"forkable": true,
"defaultBranch": "main"
}
},
"displayId": "feature-ABC-1233",
"latestCommit": "babecafebabecafebabecafebabecafebabecafe"
},
"participants": [
{
"user": {
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"displayName": "Jane Citizen",
"slug": "jcitizen",
"active": true,
"emailAddress": "jane@example.com"
},
"role": "AUTHOR",
"status": "UNAPPROVED",
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"approved": true
}
],
"reviewers": [
{
"user": {
"name": "jcitizen",
"id": 101,
"type": "NORMAL",
"displayName": "Jane Citizen",
"slug": "jcitizen",
"active": true,
"emailAddress": "jane@example.com"
},
"role": "AUTHOR",
"status": "UNAPPROVED",
"lastReviewedCommit": "7549846524f8aed2bd1c0249993ae1bf9d3c9998",
"approved": true
}
]
}
],
"size": 1,
"limit": 25,
"start": 2154,
"isLastPage": true,
"nextPageStart": 2154
}Rate this page: