# Лента (timeline)

/api/timeline методы.

## `DELETE /api/timeline/:id`

Удалить [[Timeline]]. Каскадом удалит также все ее события.

### Параметры:

* **`id`** целое число больше нуля.

## `GET /api/timeline/`

Получить список всех [[Timelines]]. Может включать `archived=true` для возврата архивов.

### Параметры:

* **`include`** null или один из `events`.

* **`archived`** допустимая логическая строка (`true` или `false`) или null.

## `GET /api/timeline/:id`

Получить ленту [[Timeline]] с `id`. Включить `include=events` для неархивных событий, включенных в ленту. Добавить `archived=true` для возврата всех событий ленты, архивных и неархивных.

### Параметры:

* **`id`** целое число больше нуля.

* **`include`** null или один из `events`.

* **`archived`** допустимая логическая строка (`true` или `false`) или null.

* **`start`** корректная дата в строковом формате или null.

* **`end`** корректная дата в строковом формате или null.

## `POST /api/timeline/`

Создать новую ленту [[Timeline]].

### Параметры:

* **`name`** непустая строка.

* **`default`** логическое значение или null.

* **`description`** строка или null.

* **`icon`** null или один из `star`, `cake`, `mail`, `warning`, `bell`, `cloud`.

* **`collection_id`** целое число больше нуля или null.

* **`archived`** логическое значение или null.

## `PUT /api/timeline/:id`

Обновить ленту [[Timeline]] с `id`. Возвращает ленту без событий. Архивируя ленту, заархивирует также все события из ленты.

### Параметры:

* **`id`** целое число больше нуля.

* **`name`** непустая строка или null.

* **`default`** логическое значение или null.

* **`description`** строка или null.

* **`icon`** null или один из `star`, `cake`, `mail`, `warning`, `bell`, `cloud`.

* **`collection_id`** целое число больше нуля или null.

* **`archived`** логическое значение или null.

* **`timeline-updates`**

---

[<< Назад к разделу API](./api-documentation.md)