Сегмент¶
/api/segment методы.
DELETE /api/segment/:id¶
Архивировать сегмент. (УСТАРЕЛО -- Вместо этого просто передайте обновленное значение :archived в метод PUT.)
Параметры:¶
-
idцелое число больше нуля. -
revision_messageнепустая строка.
GET /api/segment/¶
Получить все сегменты Segments.
GET /api/segment/:id¶
Получить Segment по ID.
Параметры:¶
idцелое число больше нуля.
GET /api/segment/:id/related¶
Вернуть связанные сущности.
Параметры:¶
id
GET /api/segment/:id/revisions¶
Получить Revisions для Segment по ID.
Параметры:¶
idцелое число больше нуля.
POST /api/segment/¶
Создать новый Segment.
Параметры:¶
-
nameнепустая строка. -
descriptionстрока или null. -
table_idцелое число больше нуля. -
definitionкарта.
POST /api/segment/:id/revert¶
Вернуть Segment к предыдущей Revision.
Параметры:¶
-
idцелое число больше нуля. -
revision_idцелое число больше нуля.
PUT /api/segment/:id¶
Обновить Segment по ID.
Параметры:¶
-
points_of_interestстрока или null. -
descriptionстрока или null. -
archivedлогическое значение или null. -
definitionкарта или null. -
revision_messageнепустая строка. -
show_in_getting_startedлогическое значение или null. -
nameнепустая строка или null. -
caveatsстрока или null. -
idцелое число больше нуля.