debian-mirror-gitlab/doc/api/boards.md

506 lines
14 KiB
Markdown
Raw Normal View History

2020-06-23 00:09:42 +05:30
---
stage: Plan
group: Project Management
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-06-23 00:09:42 +05:30
---
2021-01-29 00:20:46 +05:30
# Project Issue Boards API
2016-11-03 12:29:30 +05:30
Every API call to boards must be authenticated.
If a user is not a member of a project and the project is private, a `GET`
request on that project will result to a `404` status code.
2021-01-29 00:20:46 +05:30
## List project issue boards
2016-11-03 12:29:30 +05:30
2021-01-29 00:20:46 +05:30
Lists project issue boards in the given project.
2016-11-03 12:29:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
GET /projects/:id/boards
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards"
2016-11-03 12:29:30 +05:30
```
Example response:
```json
[
{
"id" : 1,
2021-01-29 00:20:46 +05:30
"name": "board1",
2018-03-17 18:26:18 +05:30
"project": {
"id": 5,
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
"web_url": "http://example.com/diaspora/diaspora-project-site"
},
"milestone": {
2019-07-07 11:18:12 +05:30
"id": 12,
2018-03-17 18:26:18 +05:30
"title": "10.0"
},
2016-11-03 12:29:30 +05:30
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 2,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 3,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
}
]
}
]
```
2021-01-29 00:20:46 +05:30
Another example response when no board has been activated or exist in the project:
2018-03-17 18:26:18 +05:30
2021-01-29 00:20:46 +05:30
```json
[]
```
## Show a single issue board
Get a single project issue board.
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2018-03-17 18:26:18 +05:30
GET /projects/:id/boards/:board_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1"
2018-03-17 18:26:18 +05:30
```
Example response:
```json
{
"id": 1,
2019-07-07 11:18:12 +05:30
"name": "project issue board",
2018-03-17 18:26:18 +05:30
"project": {
"id": 5,
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
"web_url": "http://example.com/diaspora/diaspora-project-site"
},
"milestone": {
2019-07-07 11:18:12 +05:30
"id": 12,
2018-03-17 18:26:18 +05:30
"title": "10.0"
},
"lists" : [
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2018-03-17 18:26:18 +05:30
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 2,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2018-03-17 18:26:18 +05:30
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 3,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2018-03-17 18:26:18 +05:30
}
]
}
```
2021-01-29 00:20:46 +05:30
## Create an issue board
2019-09-04 21:01:54 +05:30
2021-01-29 00:20:46 +05:30
Creates a project issue board.
2019-09-04 21:01:54 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-09-04 21:01:54 +05:30
POST /projects/:id/boards
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `name` | string | yes | The name of the new board |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards?name=newboard"
2019-09-04 21:01:54 +05:30
```
Example response:
```json
{
"id": 1,
"project": {
"id": 5,
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
"web_url": "http://example.com/diaspora/diaspora-project-site"
},
"name": "newboard",
2021-01-29 00:20:46 +05:30
"lists" : [],
"group": null,
"milestone": null,
"assignee" : null,
"labels" : [],
"weight" : null
2019-09-04 21:01:54 +05:30
}
```
2021-01-29 00:20:46 +05:30
## Update an issue board
2019-09-04 21:01:54 +05:30
2020-05-24 23:13:21 +05:30
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/5954) in [GitLab Starter](https://about.gitlab.com/pricing/) 11.1.
2019-09-04 21:01:54 +05:30
2021-01-29 00:20:46 +05:30
Updates a project issue board.
2019-09-04 21:01:54 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-09-04 21:01:54 +05:30
PUT /projects/:id/boards/:board_id
```
2021-01-29 00:20:46 +05:30
| Attribute | Type | Required | Description |
| ---------------------------- | -------------- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
| `name` | string | no | The new name of the board |
| `assignee_id` **(STARTER)** | integer | no | The assignee the board should be scoped to |
| `milestone_id` **(STARTER)** | integer | no | The milestone the board should be scoped to |
| `labels` **(STARTER)** | string | no | Comma-separated list of label names which the board should be scoped to |
| `weight` **(STARTER)** | integer | no | The weight range from 0 to 9, to which the board should be scoped to |
2019-09-04 21:01:54 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
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"
2019-09-04 21:01:54 +05:30
```
Example response:
```json
{
"id": 1,
"project": {
"id": 5,
"name": "Diaspora Project Site",
"name_with_namespace": "Diaspora / Diaspora Project Site",
"path": "diaspora-project-site",
"path_with_namespace": "diaspora/diaspora-project-site",
"created_at": "2018-07-03T05:48:49.982Z",
"default_branch": null,
"tag_list": [],
"ssh_url_to_repo": "ssh://user@example.com/diaspora/diaspora-project-site.git",
"http_url_to_repo": "http://example.com/diaspora/diaspora-project-site.git",
"web_url": "http://example.com/diaspora/diaspora-project-site",
"readme_url": null,
"avatar_url": null,
"star_count": 0,
"forks_count": 0,
"last_activity_at": "2018-07-03T05:48:49.982Z"
},
"lists": [],
"name": "new_name",
"group": null,
"milestone": {
"id": 43,
"iid": 1,
"project_id": 15,
"title": "Milestone 1",
"description": "Milestone 1 desc",
"state": "active",
"created_at": "2018-07-03T06:36:42.618Z",
"updated_at": "2018-07-03T06:36:42.618Z",
"due_date": null,
"start_date": null,
"web_url": "http://example.com/root/board1/milestones/1"
},
"assignee": {
"id": 1,
"name": "Administrator",
"username": "root",
"state": "active",
"avatar_url": "https://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
"web_url": "http://example.com/root"
},
"labels": [{
"id": 10,
"name": "Doing",
"color": "#5CB85C",
"description": null
}],
"weight": 4
}
```
2021-01-29 00:20:46 +05:30
## Delete an issue board
2019-09-04 21:01:54 +05:30
2021-01-29 00:20:46 +05:30
Deletes a project issue board.
2019-09-04 21:01:54 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2019-09-04 21:01:54 +05:30
DELETE /projects/:id/boards/:board_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1"
2019-09-04 21:01:54 +05:30
```
2021-01-29 00:20:46 +05:30
## List board lists in a project issue board
2016-11-03 12:29:30 +05:30
Get a list of the board's lists.
2021-01-29 00:20:46 +05:30
Does not include `open` and `closed` lists.
2016-11-03 12:29:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
GET /projects/:id/boards/:board_id/lists
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists"
2016-11-03 12:29:30 +05:30
```
Example response:
```json
[
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 2,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 3,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
}
]
```
2021-01-29 00:20:46 +05:30
## Show a single board list
2016-11-03 12:29:30 +05:30
Get a single board list.
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
GET /projects/:id/boards/:board_id/lists/:list_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
| `list_id`| integer | yes | The ID of a board's list |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1"
2016-11-03 12:29:30 +05:30
```
Example response:
```json
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
}
```
2021-01-29 00:20:46 +05:30
## Create a board list
2016-11-03 12:29:30 +05:30
2021-01-29 00:20:46 +05:30
Creates a new issue board list.
2016-11-03 12:29:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
POST /projects/:id/boards/:board_id/lists
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
2019-09-04 21:01:54 +05:30
| `label_id` | integer | no | The ID of a label |
2019-09-30 21:07:59 +05:30
| `assignee_id` **(PREMIUM)** | integer | no | The ID of a user |
| `milestone_id` **(PREMIUM)** | integer | no | The ID of a milestone |
2019-09-04 21:01:54 +05:30
2021-02-22 17:27:13 +05:30
NOTE:
2019-09-04 21:01:54 +05:30
Label, assignee and milestone arguments are mutually exclusive,
that is, only one of them are accepted in a request.
2020-11-24 15:15:51 +05:30
Check the [Issue Board docs](../user/project/issue_board.md)
2019-09-04 21:01:54 +05:30
for more information regarding the required license for each list type.
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists?label_id=5"
2016-11-03 12:29:30 +05:30
```
Example response:
```json
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
}
```
2021-01-29 00:20:46 +05:30
## Reorder a list in a board
2016-11-03 12:29:30 +05:30
2021-01-29 00:20:46 +05:30
Updates an existing issue board list. This call is used to change list position.
2016-11-03 12:29:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
PUT /projects/:id/boards/:board_id/lists/:list_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
| `list_id` | integer | yes | The ID of a board's list |
| `position` | integer | yes | The position of the list |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1?position=2"
2016-11-03 12:29:30 +05:30
```
Example response:
```json
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
2019-12-21 20:55:43 +05:30
"position" : 1,
2020-01-01 13:55:28 +05:30
"max_issue_count": 0,
2020-06-23 00:09:42 +05:30
"max_issue_weight": 0,
"limit_metric": null
2016-11-03 12:29:30 +05:30
}
```
2021-01-29 00:20:46 +05:30
## Delete a board list from a board
2016-11-03 12:29:30 +05:30
2019-12-04 20:38:33 +05:30
Only for admins and project owners. Deletes the board list in question.
2016-11-03 12:29:30 +05:30
2020-04-08 14:13:33 +05:30
```plaintext
2016-11-03 12:29:30 +05:30
DELETE /projects/:id/boards/:board_id/lists/:list_id
```
| Attribute | Type | Required | Description |
| --------- | ---- | -------- | ----------- |
2018-03-17 18:26:18 +05:30
| `id` | integer/string | yes | The ID or [URL-encoded path of the project](README.md#namespaced-path-encoding) owned by the authenticated user |
| `board_id` | integer | yes | The ID of a board |
| `list_id` | integer | yes | The ID of a board's list |
2016-11-03 12:29:30 +05:30
2020-03-13 15:44:24 +05:30
```shell
2020-06-23 00:09:42 +05:30
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/5/boards/1/lists/1"
2016-11-03 12:29:30 +05:30
```