그룹 이슈 보드 API

Tier: Free, Premium, Ultimate
Offering: GitLab.com, Self-managed, GitLab Dedicated

그룹 이슈 보드로의 모든 API 호출은 인증되어야 합니다.

만약 사용자가 그룹의 구성원이 아니고 그룹이 비공개인 경우 GET 요청은 404 상태 코드를 반환합니다.

그룹 내 모든 이슈 보드 디렉터리

주어진 그룹의 이슈 보드를 나열합니다. 

GET /groups/:id/boards
속성 유형 필수 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards"

예시 응답: 

[
  {
    "id": 1,
    "name": "group issue board",
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3
      }
    ]
  }
]

GitLab Premium 또는 Ultimate 사용자는 여러 그룹 보드를 가질 수 있는 기능으로 인해 다른 매개변수를 볼 수 있습니다.

예시 응답: 

[
  {
    "id": 1,
    "name": "group issue board",
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3
      }
    ]
  }
]

개별 그룹 이슈 보드

단일 그룹 이슈 보드를 가져옵니다. 

GET /groups/:id/boards/:board_id
속성 유형 필수 여부 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로입니다.
board_id 정수 예 보드의 ID입니다. 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"

예시 응답: 

  {
    "id": 1,
    "name": "group issue board",
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3
      }
    ]
  }

GitLab Premium 또는 Ultimate 사용자는 여러 그룹 이슈 보드를 가질 수 있는 기능으로 인해 다른 매개변수를 볼 수 있습니다.

예시 응답: 

  {
    "id": 1,
    "name": "group issue board",
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone":   {
      "id": 12,
      "title": "10.0"
    },
    "lists" : [
      {
        "id" : 1,
        "label" : {
          "name" : "Testing",
          "color" : "#F0AD4E",
          "description" : null
        },
        "position" : 1
      },
      {
        "id" : 2,
        "label" : {
          "name" : "Ready",
          "color" : "#FF0000",
          "description" : null
        },
        "position" : 2
      },
      {
        "id" : 3,
        "label" : {
          "name" : "Production",
          "color" : "#FF5F00",
          "description" : null
        },
        "position" : 3
      }
    ]
  }

그룹 이슈 보드 생성

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

그룹 이슈 보드를 생성합니다. 

POST /groups/:id/boards
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
name 문자열 예 새 보드의 이름 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards?name=newboard"

예시 응답: 

  {
    "id": 1,
    "name": "newboard",
    "project": null,
    "lists" : [],
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone": null,
    "assignee" : null,
    "labels" : [],
    "weight" : null
  }

그룹 이슈 보드 업데이트

그룹 이슈 보드를 업데이트합니다. 

PUT /groups/:id/boards/:board_id
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID
name 문자열 아니요 보드의 새 이름
hide_backlog_list 부울 아니요 Open 디렉터리을 숨김
hide_closed_list 부울 아니요 Closed 디렉터리을 숨김
assignee_id 정수 아니요 보드에 할당된 담당자. Premium 및 Ultimate 전용
milestone_id 정수 아니요 보드에 적용될 마일스톤. Premium 및 Ultimate 전용
labels 문자열 아니요 보드에 적용될 라벨 이름의 쉼표로 구분된 디렉터리. Premium 및 Ultimate 전용
weight 정수 아니요 보드에 적용될 0에서 9 사이의 가중치 범위. Premium 및 Ultimate 전용 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1?name=new_name&milestone_id=44&assignee_id=1&labels=GroupLabel&weight=4"

예시 응답: 

  {
    "id": 1,
    "project": null,
    "lists": [],
    "name": "new_name",
    "group": {
      "id": 5,
      "name": "Documentcloud",
      "web_url": "http://example.com/groups/documentcloud"
    },
    "milestone": {
      "id": 44,
      "iid": 1,
      "group_id": 5,
      "title": "Group Milestone",
      "description": "Group Milestone Desc",
      "state": "active",
      "created_at": "2018-07-03T07:15:19.271Z",
      "updated_at": "2018-07-03T07:15:19.271Z",
      "due_date": null,
      "start_date": null,
      "web_url": "http://example.com/groups/documentcloud/-/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": 11,
      "name": "GroupLabel",
      "color": "#428BCA",
      "description": ""
    }],
    "weight": 4
  }

그룹 이슈 보드 삭제

Tier: Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

그룹 이슈 보드를 삭제합니다. 

DELETE /groups/:id/boards/:board_id
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1"

그룹 이슈 보드 디렉터리 표시

보드의 디렉터리을 가져옵니다. open 및 closed 디렉터리은 포함되지 않습니다. 

GET /groups/:id/boards/:board_id/lists
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists"

예시 응답: 

[
  {
    "id" : 1,
    "label" : {
      "name" : "Testing",
      "color" : "#F0AD4E",
      "description" : null
    },
    "position" : 1
  },
  {
    "id" : 2,
    "label" : {
      "name" : "Ready",
      "color" : "#FF0000",
      "description" : null
    },
    "position" : 2
  },
  {
    "id" : 3,
    "label" : {
      "name" : "Production",
      "color" : "#FF5F00",
      "description" : null
    },
    "position" : 3
  }
]

단일 그룹 이슈 보드 디렉터리

단일 보드 디렉터리을 가져옵니다. 

GET /groups/:id/boards/:board_id/lists/:list_id
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID
list_id 정수 예 보드의 디렉터리 ID 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"

예시 응답: 

{
  "id" : 1,
  "label" : {
    "name" : "Testing",
    "color" : "#F0AD4E",
    "description" : null
  },
  "position" : 1
}

새로운 그룹 이슈 보드 디렉터리

이슈 보드 디렉터리을 생성합니다. 

POST /groups/:id/boards/:board_id/lists
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID
label_id 정수 예 라벨의 ID 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/4/boards/12/lists?milestone_id=7"

예시 응답: 

{
  "id": 9,
  "label": null,
  "position": 0,
  "milestone": {
    "id": 7,
    "iid": 3,
    "group_id": 12,
    "title": "Milestone with due date",
    "description": "",
    "state": "active",
    "created_at": "2017-09-03T07:16:28.596Z",
    "updated_at": "2017-09-03T07:16:49.521Z",
    "due_date": null,
    "start_date": null,
    "web_url": "https://gitlab.example.com/groups/issue-reproduce/-/milestones/3"
  }
}

그룹 이슈 보드 디렉터리 수정

기존의 이슈 보드 디렉터리을 업데이트합니다. 이 호출은 디렉터리 위치를 변경하는 데 사용됩니다. 

PUT /groups/:id/boards/:board_id/lists/:list_id
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID
list_id 정수 예 보드의 디렉터리 ID
position 정수 예 디렉터리의 위치 
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/group/5/boards/1/lists/1?position=2"

예시 응답: 

{
  "id" : 1,
  "label" : {
    "name" : "Testing",
    "color" : "#F0AD4E",
    "description" : null
  },
  "position" : 1
}

그룹 이슈 보드 디렉터리 삭제

관리자 및 그룹 소유자 전용입니다. 해당 보드 디렉터리을 삭제합니다. 

DELETE /groups/:id/boards/:board_id/lists/:list_id
속성 유형 필수 설명
id 정수/문자열 예 인증된 사용자가 소유한 그룹의 ID 또는 URL 인코딩된 경로
board_id 정수 예 보드의 ID
list_id 정수 예 보드의 디렉터리 ID 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/5/boards/1/lists/1"