Pirate Praveen 1f125c8e22 New upstream version 12.3.8

2019-12-04 20:38:33 +05:30

15 KiB

Raw Blame History

Epics API (ULTIMATE)

Every API call to epic must be authenticated.

If a user is not a member of a group and the group is private, a GET request on that group will result to a 404 status code.

If epics feature is not available a 403 status code will be returned.

Epic issues API

The epic issues API allows you to interact with issues associated with an epic.

Milestone dates integration

Introduced in GitLab 11.3.

Since start date and due date can be dynamically sourced from related issue milestones, when user has edit permission, additional fields will be shown. These include two boolean fields start_date_is_fixed and due_date_is_fixed, and four date fields start_date_fixed, start_date_from_milestones, due_date_fixed and due_date_from_milestones.

end_date has been deprecated in favor of due_date.

Epics pagination

By default, GET requests return 20 results at a time because the API results are paginated.

List epics for a group

Gets all epics of the requested group and its subgroups.

GET /groups/:id/epics
GET /groups/:id/epics?author_id=5
GET /groups/:id/epics?labels=bug,reproduced
GET /groups/:id/epics?state=opened

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`author_id`	integer	no	Return epics created by the given user `id`
`labels`	string	no	Return epics matching a comma separated list of labels names. Label names from the epic group or a parent group can be used
`order_by`	string	no	Return epics ordered by `created_at` or `updated_at` fields. Default is `created_at`
`sort`	string	no	Return epics sorted in `asc` or `desc` order. Default is `desc`
`search`	string	no	Search epics against their `title` and `description`
`state`	string	no	Search epics against their `state`, possible filters: `opened`, `closed` and `all`, default: `all`
`created_after`	datetime	no	Return epics created on or after the given time
`created_before`	datetime	no	Return epics created on or before the given time
`updated_after`	datetime	no	Return epics updated on or after the given time
`updated_before`	datetime	no	Return epics updated on or before the given time
`include_ancestor_groups`	boolean	no	Include epics from the requested group's ancestors. Default is `false`
`include_descendant_groups`	boolean	no	Include epics from the requested group's descendants. Default is `true`

curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics

Example response:

[
  {
  "id": 29,
  "iid": 4,
  "group_id": 7,
  "title": "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est.",
  "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
  "state": "opened",
  "web_edit_url": "http://localhost:3001/groups/test/-/epics/4",
  "reference": "&4",
  "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,
  "end_date": "2018-07-31",
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": [],
  "upvotes": 4,
  "downvotes": 0
  }
]

Single epic

Gets a single epic

GET /groups/:id/epics/:epic_iid

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`epic_iid`	integer/string	yes	The internal ID of the epic.

curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5

Example response:

{
  "id": 30,
  "iid": 5,
  "group_id": 7,
  "title": "Ea cupiditate dolores ut vero consequatur quasi veniam voluptatem et non.",
  "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
  "state": "opened",
  "web_edit_url": "http://localhost:3001/groups/test/-/epics/5",
  "reference": "&5",
  "author":{
    "id": 7,
    "name": "Pamella Huel",
    "username": "arnita",
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/a2f5c6fcef64c9c69cb8779cb292be1b?s=80&d=identicon",
    "web_url": "http://localhost:3001/arnita"
  },
  "start_date": null,
  "start_date_is_fixed": false,
  "start_date_fixed": null,
  "start_date_from_milestones": null,
  "end_date": "2018-07-31",
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": [],
  "upvotes": 4,
  "downvotes": 0
}

New epic

Creates a new epic.

NOTE: Note: Starting with GitLab 11.3, start_date and end_date should no longer be assigned directly, as they now represent composite values. You can configure it via the *_is_fixed and *_fixed fields instead.

POST /groups/:id/epics

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`title`	string	yes	The title of the epic
`labels`	string	no	The comma separated list of labels
`description`	string	no	The description of the epic. Limited to 1 000 000 characters.
`start_date_is_fixed`	boolean	no	Whether start date should be sourced from `start_date_fixed` or from milestones (since 11.3)
`start_date_fixed`	string	no	The fixed start date of an epic (since 11.3)
`due_date_is_fixed`	boolean	no	Whether due date should be sourced from `due_date_fixed` or from milestones (since 11.3)
`due_date_fixed`	string	no	The fixed due date of an epic (since 11.3)
`parent_id`	integer/string	no	The id of a parent epic (since 11.11)

curl --header POST "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics?title=Epic&description=Epic%20description

Example response:

{
  "id": 33,
  "iid": 6,
  "group_id": 7,
  "title": "Epic",
  "description": "Epic description",
  "state": "opened",
  "web_edit_url": "http://localhost:3001/groups/test/-/epics/6",
  "reference": "&6",
  "author": {
    "name" : "Alexandra Bashirian",
    "avatar_url" : null,
    "state" : "active",
    "web_url" : "https://gitlab.example.com/eileen.lowe",
    "id" : 18,
    "username" : "eileen.lowe"
  },
  "start_date": null,
  "start_date_is_fixed": false,
  "start_date_fixed": null,
  "start_date_from_milestones": null,
  "end_date": "2018-07-31",
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": [],
  "upvotes": 4,
  "downvotes": 0
}

Update epic

Updates an epic.

PUT /groups/:id/epics/:epic_iid

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`epic_iid`	integer/string	yes	The internal ID of the epic
`title`	string	no	The title of an epic
`description`	string	no	The description of an epic. Limited to 1 000 000 characters.
`labels`	string	no	The comma separated list of labels
`start_date_is_fixed`	boolean	no	Whether start date should be sourced from `start_date_fixed` or from milestones (since 11.3)
`start_date_fixed`	string	no	The fixed start date of an epic (since 11.3)
`due_date_is_fixed`	boolean	no	Whether due date should be sourced from `due_date_fixed` or from milestones (since 11.3)
`due_date_fixed`	string	no	The fixed due date of an epic (since 11.3)
`state_event`	string	no	State event for an epic. Set `close` to close the epic and `reopen` to reopen it (since 11.4)

curl --header PUT "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5?title=New%20Title

Example response:

{
  "id": 33,
  "iid": 6,
  "group_id": 7,
  "title": "New Title",
  "description": "Epic description",
  "state": "opened",
  "web_edit_url": "http://localhost:3001/groups/test/-/epics/6",
  "reference": "&6",
  "author": {
    "name" : "Alexandra Bashirian",
    "avatar_url" : null,
    "state" : "active",
    "web_url" : "https://gitlab.example.com/eileen.lowe",
    "id" : 18,
    "username" : "eileen.lowe"
  },
  "start_date": null,
  "start_date_is_fixed": false,
  "start_date_fixed": null,
  "start_date_from_milestones": null,
  "end_date": "2018-07-31",
  "due_date": "2018-07-31",
  "due_date_is_fixed": false,
  "due_date_fixed": null,
  "due_date_from_milestones": "2018-07-31",
  "created_at": "2018-07-17T13:36:22.770Z",
  "updated_at": "2018-07-18T12:22:05.239Z",
  "labels": [],
  "upvotes": 4,
  "downvotes": 0
}

Delete epic

Deletes an epic

DELETE /groups/:id/epics/:epic_iid

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`epic_iid`	integer/string	yes	The internal ID of the epic.

curl --header DELETE "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5

Create a todo

Manually creates a todo for the current user on an epic. If there already exists a todo for the user on that epic, status code 304 is returned.

POST /groups/:id/epics/:epic_iid/todo

Attribute	Type	Required	Description
`id`	integer/string	yes	The ID or URL-encoded path of the group owned by the authenticated user
`epic_iid`	integer	yes	The internal ID of a group's epic

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/1/epics/5/todo

Example response:

{
  "id": 112,
  "group": {
    "id": 1,
    "name": "Gitlab",
    "path": "gitlab",
    "kind": "group",
    "full_path": "base/gitlab",
    "parent_id": null
  },
  "author": {
    "name": "Administrator",
    "username": "root",
    "id": 1,
    "state": "active",
    "avatar_url": "http://www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?s=80&d=identicon",
    "web_url": "https://gitlab.example.com/root"
  },
  "action_name": "marked",
  "target_type": "epic",
  "target": {
    "id": 30,
    "iid": 5,
    "group_id": 1,
    "title": "Ea cupiditate dolores ut vero consequatur quasi veniam voluptatem et non.",
    "description": "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum.",
    "author":{
      "id": 7,
      "name": "Pamella Huel",
      "username": "arnita",
      "state": "active",
      "avatar_url": "http://www.gravatar.com/avatar/a2f5c6fcef64c9c69cb8779cb292be1b?s=80&d=identicon",
      "web_url": "http://localhost:3001/arnita"
    },
    "start_date": null,
    "end_date": null,
    "created_at": "2018-01-21T06:21:13.165Z",
    "updated_at": "2018-01-22T12:41:41.166Z"
  },
  "target_url": "https://gitlab.example.com/groups/epics/5",
  "body": "Vel voluptas atque dicta mollitia adipisci qui at.",
  "state": "pending",
  "created_at": "2016-07-01T11:09:13.992Z"
}

15 KiB Raw Blame History

Epics API (ULTIMATE)

Epic issues API

Milestone dates integration

Epics pagination

List epics for a group

Single epic

New epic

Update epic

Delete epic

Create a todo

15 KiB

Raw Blame History