Сегмент¶
/api/segment методы.
DELETE /api/segment/:id
¶
Архивировать сегмент. (УСТАРЕЛО -- Просто передайте обновленное значение :archived
в PUT
метод вместо этого.).
ПАРАМЕТРЫ:¶
-
id
value must be an integer greater than zero. -
revision_message
value must be a non-blank string.
GET /api/segment/
¶
Получить все Segments
.
GET /api/segment/:id
¶
Получить Segment
по ID.
ПАРАМЕТРЫ:¶
id
value must be an integer greater than zero.
GET /api/segment/:id/related
¶
Вернуть связанные сущности.
ПАРАМЕТРЫ:¶
id
value must be an integer greater than zero.
GET /api/segment/:id/revisions
¶
Получить Revisions
для Segment
по ID.
ПАРАМЕТРЫ:¶
id
value must be an integer greater than zero.
POST /api/segment/
¶
Создать новый Segment
.
ПАРАМЕТРЫ:¶
-
name
value must be a non-blank string. -
description
nullable string. -
table_id
value must be an integer greater than zero. -
definition
Value must be a map.
POST /api/segment/:id/revert
¶
Откатить Segement
к предыдущей Revision
.
ПАРАМЕТРЫ:¶
-
id
value must be an integer greater than zero. -
revision_id
value must be an integer greater than zero.
PUT /api/segment/:id
¶
Обновить Segment
по ID.
ПАРАМЕТРЫ:¶
-
points_of_interest
nullable string. -
description
nullable string. -
archived
nullable boolean. -
definition
nullable map. -
revision_message
value must be a non-blank string. -
show_in_getting_started
nullable boolean. -
name
nullable value must be a non-blank string. -
caveats
nullable string. -
id
value must be an integer greater than zero.