Epic Links API

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

경고: GitLab 17.0에서 Epics REST API가 폐기되었으며 API 버전 5에서 제거될 예정입니다. GitLab 17.4 이상에서, 귀하의 관리자가 에픽의 새로운 디자인을 활성화했으면 대신 Work Items API를 사용하십시오. 이 변경 사항은 파괴적인 변경입니다.

부모-자식 에픽 관계를 관리합니다.

epic_links에 대한 모든 API 호출은 인증되어야 합니다.

비공개 그룹의 구성원이 아닌 경우 해당 그룹에 대한 GET 요청은 404 상태 코드를 반환합니다.

다중 수준 에픽은 GitLab Ultimate에서만 사용할 수 있습니다. 다중 수준 에픽 기능을 사용할 수 없는 경우 403 상태 코드가 반환됩니다.

주어진 에픽에 관련된 에픽 목록

지정된 에픽의 모든 하위 에픽을 가져옵니다.

GET /groups/:id/epics/:epic_iid/epics
속성 유형 필수 설명
id integer/string yes 그룹의 ID 또는 URL로 인코딩된 경로를 의미합니다.
epic_iid integer yes 에픽의 내부 ID를 의미합니다.
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/epics/"

예시 응답:

[
  {
    "id": 29,
    "iid": 6,
    "group_id": 1,
    "parent_id": 5,
    "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
    "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
    "author": {
      "id": 10,
      "name": "Lu Mayer",
      "username": "kam",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
      "web_url": "http://localhost:3001/kam"
    },
    "start_date": null,
    "start_date_is_fixed": false,
    "start_date_fixed": null,
    "start_date_from_milestones": null,       //deprecated in favor of start_date_from_inherited_source
    "start_date_from_inherited_source": null,
    "end_date": "2018-07-31",                 //deprecated in favor of due_date
    "due_date": "2018-07-31",
    "due_date_is_fixed": false,
    "due_date_fixed": null,
    "due_date_from_milestones": "2018-07-31", //deprecated in favor of start_date_from_inherited_source
    "due_date_from_inherited_source": "2018-07-31",
    "created_at": "2018-07-17T13:36:22.770Z",
    "updated_at": "2018-07-18T12:22:05.239Z",
    "labels": []
  }
]

하위 에픽 지정

두 개의 에픽 간의 관계를 생성하여 하나를 부모 에픽으로, 다른 하나를 자식 에픽으로 지정합니다. 부모 에픽은 여러 자식 에픽을 가질 수 있습니다. 새로운 자식 에픽이 이미 다른 에픽에 속했을 경우, 그 전의 부모로부터 해제됩니다.

POST /groups/:id/epics/:epic_iid/epics/:child_epic_id
속성 유형 필수 설명
id integer/string yes 그룹의 ID 또는 URL로 인코딩된 경로를 의미합니다.
epic_iid integer yes 에픽의 내부 ID를 의미합니다.
child_epic_id integer yes 자식 에픽의 글로벌 ID를 의미합니다. 내부 ID는 다른 그룹의 에픽과 충돌할 수 있기 때문에 사용할 수 없습니다.
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/epics/6"

예시 응답:

{
  "id": 6,
  "iid": 38,
  "group_id": 1,
  "parent_id": 5,
  "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
  "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
  "author": {
    "id": 10,
    "name": "Lu Mayer",
    "username": "kam",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
    "web_url": "http://localhost:3001/kam"
  },
  "start_date": null,
  "start_date_is_fixed": false,
  "start_date_fixed": null,
  "start_date_from_milestones": null,       //deprecated in favor of start_date_from_inherited_source
  "start_date_from_inherited_source": null,
  "end_date": "2018-07-31",                 //deprecated in favor of due_date
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31", //deprecated in favor of start_date_from_inherited_source
  "due_date_from_inherited_source": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": []
}

자식 epic 생성 및 할당

새로운 Epic을 생성하고 제공된 부모 Epic과 연결합니다. 응답은 LinkedEpic 객체입니다.

POST /groups/:id/epics/:epic_iid/epics
속성 유형 필요 여부 설명
id integer/string yes 그룹의 ID 또는 URL-인코딩된 경로
epic_iid integer yes (향후 부모가 될) Epic의 내부 ID
title string yes 새로 생성된 Epic의 제목
confidential boolean no Epic이 비밀인지 여부. confidential_epics 기능 플래그가 비활성화된 경우 해당 매개변수는 무시됩니다. 기본값은 부모 Epic의 비밀 유무에 따릅니다.
curl --request POST --header  "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/5/epics?title=Newpic"

예시 응답:

{
  "id": 24,
  "iid": 2,
  "title": "child epic",
  "group_id": 49,
  "parent_id": 23,
  "has_children": false,
  "has_issues": false,
  "reference":  "&2",
  "url": "http://localhost/groups/group16/-/epics/2",
  "relation_url": "http://localhost/groups/group16/-/epics/1/links/24"
}

자식 epic 재정렬

PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id
속성 유형 필요 여부 설명
id integer/string yes 그룹의 ID 또는 URL-인코딩된 경로
epic_iid integer yes Epic의 내부 ID
child_epic_id integer yes 자식 Epic의 전역 ID. 내부 ID는 다른 그룹의 Epic과 충돌할 수 있기 때문에 사용할 수 없습니다.
move_before_id integer no 자식 Epic 앞에 배치해야 하는 형제 Epic의 전역 ID
move_after_id integer no 자식 Epic 뒤에 배치해야 하는 형제 Epic의 전역 ID
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5"

예시 응답:

[
  {
    "id": 29,
    "iid": 6,
    "group_id": 1,
    "parent_id": 5,
    "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
    "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
    "author": {
      "id": 10,
      "name": "Lu Mayer",
      "username": "kam",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
      "web_url": "http://localhost:3001/kam"
    },
    "start_date": null,
    "start_date_is_fixed": false,
    "start_date_fixed": null,
    "start_date_from_milestones": null,       //deprecated in favor of start_date_from_inherited_source
    "start_date_from_inherited_source": null,
    "end_date": "2018-07-31",                 //deprecated in favor of due_date
    "due_date": "2018-07-31",
    "due_date_is_fixed": false,
    "due_date_fixed": null,
    "due_date_from_milestones": "2018-07-31", //deprecated in favor of start_date_from_inherited_source
    "due_date_from_inherited_source": "2018-07-31",
    "created_at": "2018-07-17T13:36:22.770Z",
    "updated_at": "2018-07-18T12:22:05.239Z",
    "labels": []
  }
]

자식 epic 할당 해제

부모 Epic에서 자식 Epic의 할당을 해제합니다.

DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id
속성 유형 필요 여부 설명
id integer/string yes 그룹의 ID 또는 URL-인코딩된 경로.
epic_iid integer yes Epic의 내부 ID
child_epic_id integer yes 자식 Epic의 전역 ID. 내부 ID는 다른 그룹의 Epic과 충돌할 수 있기 때문에 사용할 수 없습니다.
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/groups/1/epics/4/epics/5"

예시 응답:

{
  "id": 5,
  "iid": 38,
  "group_id": 1,
  "parent_id": null,
  "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
  "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
  "author": {
    "id": 10,
    "name": "Lu Mayer",
    "username": "kam",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon",
    "web_url": "http://localhost:3001/kam"
  },
  "start_date": null,
  "start_date_is_fixed": false,
  "start_date_fixed": null,
  "start_date_from_milestones": null,       //deprecated in favor of start_date_from_inherited_source
  "start_date_from_inherited_source": null,
  "end_date": "2018-07-31",                 //deprecated in favor of due_date
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31", //deprecated in favor of start_date_from_inherited_source
  "due_date_from_inherited_source": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": []
}