Epic Links API · Gitlab 中文文檔

# Epic Links API > 原文：[https://docs.gitlab.com/ee/api/epic_links.html](https://docs.gitlab.com/ee/api/epic_links.html) * [List epics related to a given epic](#list-epics-related-to-a-given-epic) * [Assign a child epic](#assign-a-child-epic) * [Create and assign a child epic](#create-and-assign-a-child-epic) * [Re-order a child epic](#re-order-a-child-epic) * [Unassign a child epic](#unassign-a-child-epic) # Epic Links API[](#epic-links-api-ultimate "Permalink") **注意：**該端點是在 GitLab 11.8 中[引入的](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/9188) . 管理親子[史詩般的關系](../user/group/epics/index.html#multi-level-child-epics-ultimate) . 每個對`epic_links` API 調用`epic_links`必須經過身份驗證. 如果用戶不是組的成員，并且該組是私有的，則對該組的`GET`請求將導致`404`狀態代碼. 多級史詩僅在 GitLab [Ultimate / Gold](https://about.gitlab.com/pricing/)中可用. 如果"多級史詩"功能不可用，將返回`403`狀態代碼. ## List epics related to a given epic[](#list-epics-related-to-a-given-epic "Permalink") 獲取史詩的所有子史詩. ``` GET /groups/:id/epics/:epic_iid/epics ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 認證用戶擁有[的組](README.html#namespaced-path-encoding)的 ID 或[URL 編碼路徑](README.html#namespaced-path-encoding) | | `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": [] } ] ``` ## Assign a child epic[](#assign-a-child-epic "Permalink") 在兩個史詩之間創建關聯，將一個史詩指定為父史詩，將另一個史詩指定為子史詩. 父史詩可以有多個子史詩. 如果新的子史詩已經屬于另一個史詩，則該子史詩不會從先前的父史詩中分配. ``` POST /groups/:id/epics/:epic_iid/epics ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | The ID or [URL-encoded path of the group](README.html#namespaced-path-encoding) owned by the authenticated user | | `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": [] } ``` ## Create and assign a child epic[](#create-and-assign-a-child-epic "Permalink") 創建一個新的史詩并將其與提供的父史詩相關聯. 響應是 LinkedEpic 對象. ``` POST /groups/:id/epics/:epic_iid/epics ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 認證用戶擁有[的組](README.html#namespaced-path-encoding)的 ID 或[URL 編碼路徑](README.html#namespaced-path-encoding) | | `epic_iid` | integer | yes | （未來父級）史詩的內部 ID. | | `title` | string | yes | 新創建的史詩的標題. | ``` 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" } ``` ## Re-order a child epic[](#re-order-a-child-epic "Permalink") ``` PUT /groups/:id/epics/:epic_iid/epics/:child_epic_id ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 認證用戶擁有[的組](README.html#namespaced-path-encoding)的 ID 或[URL 編碼路徑](README.html#namespaced-path-encoding) . | | `epic_iid` | integer | yes | 史詩的內部 ID. | | `child_epic_id` | integer | yes | 子史詩的全局 ID. 內部 ID 無法使用，因為它們可能與其他組的史詩沖突. | | `move_before_id` | integer | no | 同胞史詩的全局 ID，應放在子史詩之前. | | `move_after_id` | integer | no | 同胞史詩的全局 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": [] } ] ``` ## Unassign a child epic[](#unassign-a-child-epic "Permalink") 從父級史詩中取消分配子級史詩. ``` DELETE /groups/:id/epics/:epic_iid/epics/:child_epic_id ``` | Attribute | Type | Required | Description | | --- | --- | --- | --- | | `id` | integer/string | yes | 認證用戶擁有[的組](README.html#namespaced-path-encoding)的 ID 或[URL 編碼路徑](README.html#namespaced-path-encoding) . | | `epic_iid` | integer | yes | 史詩的內部 ID. | | `child_epic_id` | integer | yes | 子史詩的全局 ID. 內部 ID 無法使用，因為它們可能與其他組的史詩沖突. | ``` 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": [] } ```