# Сегмент

/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`** целое число больше нуля.

---

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