Лента (timeline)

/api/timeline методы.

DELETE /api/timeline/:id

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

Параметры:

  • id

GET /api/timeline/

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

Параметры:

  • include значение может быть null, а если не null, значение должно быть одним из событий: events.

  • archived значение может быть null, а если не null, значение должно быть допустимой логической строкой (”true” или “false”).

GET /api/timeline/:id

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

Параметры:

  • id

  • include значение может быть пустым, а если не пустое, значение должно быть один из событий: events.

  • archived значение может быть пустым, а если не пустое, значение должно быть допустимой логической строкой (”true” или “false”).

  • start значение может быть пустым, а если не пустое, значение должно быть допустимой строкой даты

  • end значение может быть пустым, а если не пустое, значение должно быть допустимой строкой даты

POST /api/timeline/

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

Параметры:

  • name значение должно быть не пустой строкой.

  • default значение может быть пустым, а если не пустое, значение должно быть логическим.

  • description значение может быть пустым, а если не пустое, то значение должно быть строкой.

  • icon значение может быть пустым, а если не пустое, значение должно быть одним из: balloons, bell, cloud, mail, star, warning.

  • collection_id значение может быть пустым, а если не пустое, значение должно быть целым, больше 0.

  • archived значение может быть пустым, а если не пустое, значение должно быть логическим.

PUT /api/timeline/:id

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

Параметры:

  • id

  • name значение может быть null, а если не null, значение должно быть не пустой строкой.

  • default значение может быть пустымnull а если не null, значение должно быть логическим.

  • description значение может быть null, а если не null, значение должно быть строкой.

  • icon значение может быть null, а если не null, значение должно быть одним из: balloons, bell, cloud, mail, star, warning.

  • collection_id значение может быть null, а если не null, значение должно быть целым числом больше 0.

  • archived значение может быть пустымnull а если не null, значение должно быть логическим.

  • timeline-updates

<< Назад к разделу API