그룹 에픽 보드 API
Tier: Premium, Ultimate
Offering: GitLab.com, Self-Managed, GitLab Dedicated
- GitLab 15.9에서 소개되었습니다.
그룹 에픽 보드로의 모든 API 호출은 인증되어야 합니다.
만약 사용자가 그룹의 구성원이 아니고 그룹이 비공개인 경우 GET
요청은 404
상태 코드를 반환합니다.
그룹 내 모든 에픽 보드 나열
주어진 그룹의 에픽 보드를 나열합니다.
GET /groups/:id/epic_boards
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 접근할 수 있는 그룹의 ID 또는 URL-encoded path |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards"
응답 예시:
[
{
"id": 1,
"name": "group epic board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"hide_backlog_list": false,
"hide_closed_list": false,
"labels": [
{
"id": 1,
"title": "Board Label",
"color": "#c21e56",
"description": "label applied to the epic board",
"group_id": 5,
"project_id": null,
"template": false,
"text_color": "#FFFFFF",
"created_at": "2023-01-27T10:40:59.738Z",
"updated_at": "2023-01-27T10:40:59.738Z"
}
],
"lists": [
{
"id": 1,
"label": {
"id": 69,
"name": "Testing",
"color": "#F0AD4E",
"description": null
},
"position": 1,
"list_type": "label"
},
{
"id": 2,
"label": {
"id": 70,
"name": "Ready",
"color": "#FF0000",
"description": null
},
"position": 2,
"list_type": "label"
},
{
"id": 3,
"label": {
"id": 71,
"name": "Production",
"color": "#FF5F00",
"description": null
},
"position": 3,
"list_type": "label"
}
]
}
]
단일 그룹 에픽 보드
단일 그룹 에픽 보드를 가져옵니다.
GET /groups/:id/epic_boards/:board_id
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 접근할 수 있는 그룹의 ID 또는 URL-encoded path |
board_id
| 정수 | 예 | 에픽 보드의 ID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1"
응답 예시:
{
"id": 1,
"name": "group epic board",
"group": {
"id": 5,
"name": "Documentcloud",
"web_url": "http://example.com/groups/documentcloud"
},
"labels": [
{
"id": 1,
"title": "Board Label",
"color": "#c21e56",
"description": "label applied to the epic board",
"group_id": 5,
"project_id": null,
"template": false,
"text_color": "#FFFFFF",
"created_at": "2023-01-27T10:40:59.738Z",
"updated_at": "2023-01-27T10:40:59.738Z"
}
],
"lists" : [
{
"id" : 1,
"label" : {
"id": 69,
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type": "label"
},
{
"id" : 2,
"label" : {
"id": 70,
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2,
"list_type": "label"
},
{
"id" : 3,
"label" : {
"id": 71,
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3,
"list_type": "label"
}
]
}
그룹 에픽 보드 리스트 나열
- GitLab 15.9에서 소개되었습니다.
에픽 보드의 리스트를 가져옵니다.
open
및 closed
리스트는 포함되지 않습니다.
GET /groups/:id/epic_boards/:board_id/lists
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 접근할 수 있는 그룹의 ID 또는 URL-encoded path |
board_id
| 정수 | 예 | 에픽 보드의 ID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists"
응답 예시:
[
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type" : "label",
"collapsed" : false
},
{
"id" : 2,
"label" : {
"name" : "Ready",
"color" : "#FF0000",
"description" : null
},
"position" : 2,
"list_type" : "label",
"collapsed" : false
},
{
"id" : 3,
"label" : {
"name" : "Production",
"color" : "#FF5F00",
"description" : null
},
"position" : 3,
"list_type" : "label",
"collapsed" : false
}
]
단일 그룹 에픽 보드 리스트
- GitLab 15.9에서 소개되었습니다.
단일 보드 리스트를 가져옵니다.
GET /groups/:id/epic_boards/:board_id/lists/:list_id
속성 | 유형 | 필수 | 설명 |
---|---|---|---|
id
| 정수/문자열 | 예 | 인증된 사용자가 접근할 수 있는 그룹의 ID 또는 URL-encoded path |
board_id
| 정수 | 예 | 에픽 보드의 ID |
list_id
| 정수 | 예 | 에픽 보드의 리스트의 ID |
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/epic_boards/1/lists/1"
응답 예시:
{
"id" : 1,
"label" : {
"name" : "Testing",
"color" : "#F0AD4E",
"description" : null
},
"position" : 1,
"list_type" : "label",
"collapsed" : false
}