@@ -141,6 +141,173 @@ Example response:
141
141
}
142
142
```
143
143
144
+ ## Create a board ** [ STARTER] **
145
+
146
+ Creates a board.
147
+
148
+ ```
149
+ POST /projects/:id/boards
150
+ ```
151
+
152
+ | Attribute | Type | Required | Description |
153
+ | --------- | ---- | -------- | ----------- |
154
+ | ` id ` | integer/string | yes | The ID or [ URL-encoded path of the project] ( README.md#namespaced-path-encoding ) owned by the authenticated user |
155
+ | ` name ` | string | yes | The name of the new board |
156
+
157
+ ``` bash
158
+ curl --request POST --header " PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards? name=newboard
159
+ ```
160
+
161
+ Example response:
162
+
163
+ ``` json
164
+ {
165
+ "id" : 1 ,
166
+ "project" : {
167
+ "id" : 5 ,
168
+ "name" : " Diaspora Project Site" ,
169
+ "name_with_namespace" : " Diaspora / Diaspora Project Site" ,
170
+ "path" : " diaspora-project-site" ,
171
+ "path_with_namespace" : " diaspora/diaspora-project-site" ,
172
+ "http_url_to_repo" : " http://example.com/diaspora/diaspora-project-site.git" ,
173
+ "web_url" : " http://example.com/diaspora/diaspora-project-site"
174
+ },
175
+ "name" : " newboard" ,
176
+ "milestone" : {
177
+ "id" : 12
178
+ "title" : " 10.0"
179
+ },
180
+ "lists" : [
181
+ {
182
+ "id" : 1 ,
183
+ "label" : {
184
+ "name" : " Testing" ,
185
+ "color" : " #F0AD4E" ,
186
+ "description" : null
187
+ },
188
+ "position" : 1
189
+ },
190
+ {
191
+ "id" : 2 ,
192
+ "label" : {
193
+ "name" : " Ready" ,
194
+ "color" : " #FF0000" ,
195
+ "description" : null
196
+ },
197
+ "position" : 2
198
+ },
199
+ {
200
+ "id" : 3 ,
201
+ "label" : {
202
+ "name" : " Production" ,
203
+ "color" : " #FF5F00" ,
204
+ "description" : null
205
+ },
206
+ "position" : 3
207
+ }
208
+ ]
209
+ }
210
+ ```
211
+
212
+ ## Update a board ** [ STARTER] **
213
+
214
+ > [ Introduced] [ ee-5954 ] in [ GitLab Starter] ( https://about.gitlab.com/pricing/ ) 11.1.
215
+
216
+ Updates a board.
217
+
218
+ ```
219
+ PUT /projects/:id/boards/:board_id
220
+ ```
221
+
222
+ | Attribute | Type | Required | Description |
223
+ | ------------------- | -------------- | -------- | ----------- |
224
+ | ` id ` | integer/string | yes | The ID or [ URL-encoded path of the project] ( README.md#namespaced-path-encoding ) owned by the authenticated user |
225
+ | ` board_id ` | integer | yes | The ID of a board |
226
+ | ` name ` | string | no | The new name of the board |
227
+ | ` assignee_id ` | integer | no | The assignee the board should be scoped to |
228
+ | ` milestone_id ` | integer | no | The milestone the board should be scoped to |
229
+ | ` labels ` | string | no | Comma-separated list of label names which the board should be scoped to |
230
+ | ` weight ` | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
231
+
232
+
233
+ ``` bash
234
+ curl --request PUT --header " PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1? name=new_name& milestone_id=43& assignee_id=1& labels=Doing& weight=4
235
+ ```
236
+
237
+ Example response:
238
+
239
+ ``` json
240
+ {
241
+ "id" : 1 ,
242
+ "project" : {
243
+ "id" : 5 ,
244
+ "name" : " Diaspora Project Site" ,
245
+ "name_with_namespace" : " Diaspora / Diaspora Project Site" ,
246
+ "path" : " diaspora-project-site" ,
247
+ "path_with_namespace" : " diaspora/diaspora-project-site" ,
248
+ "created_at" : " 2018-07-03T05:48:49.982Z" ,
249
+ "default_branch" : null ,
250
+ "tag_list" : [],
251
+ "ssh_url_to_repo" :
" ssh://[email protected] /diaspora/diaspora-project-site.git" ,
252
+ "http_url_to_repo" : " http://example.com/diaspora/diaspora-project-site.git" ,
253
+ "web_url" : " http://example.com/diaspora/diaspora-project-site" ,
254
+ "readme_url" : null ,
255
+ "avatar_url" : null ,
256
+ "star_count" : 0 ,
257
+ "forks_count" : 0 ,
258
+ "last_activity_at" : " 2018-07-03T05:48:49.982Z"
259
+ },
260
+ "lists" : [],
261
+ "name" : " new_name" ,
262
+ "group" : null ,
263
+ "milestone" : {
264
+ "id" : 43 ,
265
+ "iid" : 1 ,
266
+ "project_id" : 15 ,
267
+ "title" : " Milestone 1" ,
268
+ "description" : " Milestone 1 desc" ,
269
+ "state" : " active" ,
270
+ "created_at" : " 2018-07-03T06:36:42.618Z" ,
271
+ "updated_at" : " 2018-07-03T06:36:42.618Z" ,
272
+ "due_date" : null ,
273
+ "start_date" : null ,
274
+ "web_url" : " http://example.com/root/board1/milestones/1"
275
+ },
276
+ "assignee" : {
277
+ "id" : 1 ,
278
+ "name" : " Administrator" ,
279
+ "username" : " root" ,
280
+ "state" : " active" ,
281
+ "avatar_url" : " https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon" ,
282
+ "web_url" : " http://example.com/root"
283
+ },
284
+ "labels" : [{
285
+ "id" : 10 ,
286
+ "name" : " Doing" ,
287
+ "color" : " #5CB85C" ,
288
+ "description" : null
289
+ }],
290
+ "weight" : 4
291
+ }
292
+ ```
293
+
294
+ ## Delete a board ** [ STARTER] **
295
+
296
+ Deletes a board.
297
+
298
+ ```
299
+ DELETE /projects/:id/boards/:board_id
300
+ ```
301
+
302
+ | Attribute | Type | Required | Description |
303
+ | --------- | ---- | -------- | ----------- |
304
+ | ` id ` | integer/string | yes | The ID or [ URL-encoded path of the project] ( README.md#namespaced-path-encoding ) owned by the authenticated user |
305
+ | ` board_id ` | integer | yes | The ID of a board |
306
+
307
+ ``` bash
308
+ curl --request DELETE --header " PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1
309
+ ```
310
+
144
311
## List board lists
145
312
146
313
Get a list of the board's lists.
@@ -237,7 +404,15 @@ POST /projects/:id/boards/:board_id/lists
237
404
| --------- | ---- | -------- | ----------- |
238
405
| ` id ` | integer/string | yes | The ID or [ URL-encoded path of the project] ( README.md#namespaced-path-encoding ) owned by the authenticated user |
239
406
| ` board_id ` | integer | yes | The ID of a board |
240
- | ` label_id ` | integer | yes | The ID of a label |
407
+ | ` label_id ` | integer | no | The ID of a label |
408
+ | ` assignee_id ` ** [ PREMIUM] ** | integer | no | The ID of a user |
409
+ | ` milestone_id ` ** [ PREMIUM] ** | integer | no | The ID of a milestone |
410
+
411
+ NOTE: ** Note** :
412
+ Label, assignee and milestone arguments are mutually exclusive,
413
+ that is, only one of them are accepted in a request.
414
+ Check the [ Issue Board docs] ( ../user/project/issue_board.md#summary-of-features-per-tier )
415
+ for more information regarding the required license for each list type.
241
416
242
417
``` bash
243
418
curl --request POST --header " PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists? label_id=5
@@ -307,3 +482,5 @@ DELETE /projects/:id/boards/:board_id/lists/:list_id
307
482
``` bash
308
483
curl --request DELETE --header " PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1
309
484
```
485
+
486
+ [ ee-5954 ] : https://gitlab.com/gitlab-org/gitlab-ee/merge_requests/5954
0 commit comments