Skip to content
forgit api docs

Create a related epic link

POST
/api/v4/groups/{id}/epics/{epic_iid}/related_epics

Creates a two-way relation between two epics. The user must have the Guest, Planner, Reporter, Developer, Maintainer, or Owner role for both groups.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
id
required
string

ID or URL-encoded path of the group

Example 
1
epic_iid
required
integer

The internal ID of a group epic

Example 
1

Request Body required

Section titled “ Request Body required ”
Media type application/json
object
target_group_id
required

ID or URL-encoded path of the target group

string
nullable
Example 
1
target_epic_iid
required

Internal ID of a target group’s epic

integer
nullable
Example 
1
link_type

The type of the relation

string
nullable
Allowed values: relates_to blocks is_blocked_by

Responses

Section titled “ Responses ”

201

Section titled “ 201 ”

Created

Media type application/json
object
id
integer format: int64
source_epic
object
id
integer format: int64
work_item_id
integer
iid
integer
color
string
text_color
string
group_id
integer format: int64
parent_id
integer format: int64
parent_iid
integer
imported
boolean
imported_from
string
title
string
description
string
confidential
boolean
author
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
start_date
string format: date-time
start_date_is_fixed
boolean
start_date_fixed
string format: date-time
start_date_from_inherited_source
string format: date-time
start_date_from_milestones
string format: date-time
end_date
string format: date-time
due_date
string format: date-time
due_date_is_fixed
boolean
due_date_fixed
string format: date-time
due_date_from_inherited_source
string format: date-time
due_date_from_milestones
string format: date-time
state
string
web_edit_url
string
web_url
string
references
Array<object>
object
reference
string
created_at
string format: date-time
updated_at
string format: date-time
closed_at
string format: date-time
labels
Array<string>
upvotes
integer
downvotes
integer
subscribed
boolean
_links
object
target_epic
object
id
integer format: int64
work_item_id
integer
iid
integer
color
string
text_color
string
group_id
integer format: int64
parent_id
integer format: int64
parent_iid
integer
imported
boolean
imported_from
string
title
string
description
string
confidential
boolean
author
object
id
integer format: int64
username
string
public_email
string
name
string
state
string
locked
boolean
avatar_url
string
avatar_path
string
custom_attributes
Array<object>
object
key
string
value
string
web_url
string
start_date
string format: date-time
start_date_is_fixed
boolean
start_date_fixed
string format: date-time
start_date_from_inherited_source
string format: date-time
start_date_from_milestones
string format: date-time
end_date
string format: date-time
due_date
string format: date-time
due_date_is_fixed
boolean
due_date_fixed
string format: date-time
due_date_from_inherited_source
string format: date-time
due_date_from_milestones
string format: date-time
state
string
web_edit_url
string
web_url
string
references
Array<object>
object
reference
string
created_at
string format: date-time
updated_at
string format: date-time
closed_at
string format: date-time
labels
Array<string>
upvotes
integer
downvotes
integer
subscribed
boolean
_links
object
link_type
string
created_at
string format: date-time
updated_at
string format: date-time
Example 
{
  "id": 123,
  "source_epic": {
    "id": 123,
    "work_item_id": 123,
    "iid": 123,
    "color": "#1068bf",
    "text_color": "#1068bf",
    "group_id": 17,
    "parent_id": 12,
    "parent_iid": 19,
    "imported": false,
    "imported_from": "github",
    "title": "My Epic",
    "description": "Epic description",
    "confidential": false,
    "author": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "start_date": "2022-01-31T15:10:45.080Z",
    "start_date_is_fixed": true,
    "start_date_fixed": "2022-01-31T15:10:45.080Z",
    "start_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
    "start_date_from_milestones": "2022-01-31T15:10:45.080Z",
    "end_date": "2022-01-31T15:10:45.080Z",
    "due_date": "2022-01-31T15:10:45.080Z",
    "due_date_is_fixed": true,
    "due_date_fixed": "2022-01-31T15:10:45.080Z",
    "due_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
    "due_date_from_milestones": "2022-01-31T15:10:45.080Z",
    "state": "opened",
    "web_edit_url": "http://gitlab.example.com/groups/test/-/epics/4/edit",
    "web_url": "http://gitlab.example.com/groups/test/-/epics/4",
    "reference": "&1",
    "created_at": "2022-01-31T15:10:45.080Z",
    "updated_at": "2022-01-31T15:10:45.080Z",
    "closed_at": "2022-01-31T15:10:45.080Z",
    "upvotes": 4,
    "downvotes": 3,
    "subscribed": true
  },
  "target_epic": {
    "id": 123,
    "work_item_id": 123,
    "iid": 123,
    "color": "#1068bf",
    "text_color": "#1068bf",
    "group_id": 17,
    "parent_id": 12,
    "parent_iid": 19,
    "imported": false,
    "imported_from": "github",
    "title": "My Epic",
    "description": "Epic description",
    "confidential": false,
    "author": {
      "id": 1,
      "username": "admin",
      "public_email": "john@example.com",
      "name": "Administrator",
      "state": "active",
      "avatar_url": "https://gravatar.com/avatar/1",
      "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
      "custom_attributes": [
        {
          "key": "foo",
          "value": "bar"
        }
      ],
      "web_url": "https://gitlab.example.com/root"
    },
    "start_date": "2022-01-31T15:10:45.080Z",
    "start_date_is_fixed": true,
    "start_date_fixed": "2022-01-31T15:10:45.080Z",
    "start_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
    "start_date_from_milestones": "2022-01-31T15:10:45.080Z",
    "end_date": "2022-01-31T15:10:45.080Z",
    "due_date": "2022-01-31T15:10:45.080Z",
    "due_date_is_fixed": true,
    "due_date_fixed": "2022-01-31T15:10:45.080Z",
    "due_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
    "due_date_from_milestones": "2022-01-31T15:10:45.080Z",
    "state": "opened",
    "web_edit_url": "http://gitlab.example.com/groups/test/-/epics/4/edit",
    "web_url": "http://gitlab.example.com/groups/test/-/epics/4",
    "reference": "&1",
    "created_at": "2022-01-31T15:10:45.080Z",
    "updated_at": "2022-01-31T15:10:45.080Z",
    "closed_at": "2022-01-31T15:10:45.080Z",
    "upvotes": 4,
    "downvotes": 3,
    "subscribed": true
  },
  "link_type": "relates_to",
  "created_at": "2022-01-31T15:10:45.080Z",
  "updated_at": "2022-01-31T15:10:45.080Z"
}

400

Section titled “ 400 ”

Bad Request

401

Section titled “ 401 ”

Unauthorized

404

Section titled “ 404 ”

Not found

409

Section titled “ 409 ”

Conflict

422

Section titled “ 422 ”

Unprocessable entity