Перейти к содержанию

title: "Временная шкала" summary: | /api/timeline методы. redirect_from: - /ru/docs/latest/api/timeline

Временная шкала

/api/timeline методы.

DELETE /api/timeline/:id

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

GET /api/timeline/

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

ПАРАМЕТРЫ:

  • include nullable enum of events.

  • archived nullable value must be a valid boolean string ('true' or 'false').

GET /api/timeline/:id

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

  • include nullable enum of events.

  • archived nullable value must be a valid boolean string ('true' or 'false').

  • start nullable value must be a valid date string.

  • end nullable value must be a valid date string.

POST /api/timeline/

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

ПАРАМЕТРЫ:

  • name value must be a non-blank string.

  • default nullable boolean.

  • description nullable string.

  • icon nullable enum of star, cake, mail, warning, bell, cloud.

  • collection_id nullable value must be an integer greater than zero.

  • archived nullable boolean.

PUT /api/timeline/:id

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

ПАРАМЕТРЫ:

  • id value must be an integer greater than zero.

  • name nullable value must be a non-blank string.

  • default nullable boolean.

  • description nullable string.

  • icon nullable enum of star, cake, mail, warning, bell, cloud.

  • collection_id nullable value must be an integer greater than zero.

  • archived nullable boolean.

  • timeline-updates

<< Назад к индексу API