Правила хранения (storagerules)

Содержание

Запросы

Запросы

HTTP verb Endpoint Описание

HTTP verb	Endpoint	Описание
`POST`	`/rest/v1/domain/storagerules`	Создание нового правила хранения
`GET`	`/rest/v1/domain/storagerules`	Получение списка правил хранения
`GET`	`/rest/v1/domain/storagerules/<id>`	Получение данных правила хранения
`PATCH`	`/rest/v1/domain/storagerules/<id>`	Изменение данных правила хранения
`DELETE`	`/rest/v1/domain/storagerules/<id>`	Удаление правила хранения
`LOOKUP`	`/rest/v1/domain/storagerules`	Поиск идентификатора правила хранения

POST

/rest/v1/domain/storagerules

Создание нового правила хранения

GET

/rest/v1/domain/storagerules

Получение списка правил хранения

GET

/rest/v1/domain/storagerules/<id>

Получение данных правила хранения

PATCH

/rest/v1/domain/storagerules/<id>

Изменение данных правила хранения

DELETE

/rest/v1/domain/storagerules/<id>

Удаление правила хранения

LOOKUP

/rest/v1/domain/storagerules

Поиск идентификатора правила хранения

Создание нового правила хранения

Запрос

Описание полей: storagerule entity

Пример запроса

POST /rest/v1/domain/storagerules HTTP/1.1
Content-Type: application/json; charset=utf-8

storagerule entity

Ответ

Описание полей: storagerule entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "name": "Полгода",
  "expires": 180,
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T10:50:51.80Z",
    "lwt": "2019-08-26T10:50:51.80Z"
  }
}

Получение списка правил хранения

Запрос

Table 1. Параметры запроса
Имя	Тип	Описание
`filter`	`object`	Фильтр по значениям полей.
`mask`	`str`	Список полей для вывода. Доступные поля для выдачи: id, name, expires, opts.title, ext.lwt, ext.ct.
`offset`	`int`	Смещение в списке ресурсов, подлежащих выдаче.
`limit`	`int`	Максимальное количество ресурсов в списке.
`order`	`array<object\|str>`	Порядок сортировки ресурсов в списке.
`flat`	`bool`	Преобразование в плоский вид составных полей.

Подробно про формат параметров GET-запроса

Пример запроса

GET /rest/v1/domain/storagerules?offset=0&limit=2 HTTP/1.1

Ответ

Описание полей: storagerule entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
    "name": "Месяц",
    "expires": 30,
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-26T10:51:21.16Z",
      "lwt": "2019-08-26T10:51:21.16Z"
    }
  },
  {
    "id": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
    "name": "Полгода",
    "expires": 180,
    "opts": {
      "title": ""
    },
    "ext": {
      "ct": "2019-08-26T10:50:51.80Z",
      "lwt": "2019-08-26T10:50:51.80Z"
    }
  }
]

Получение данных правила хранения

Запрос

Table 2. Параметры запроса
Имя	Тип	Описание
`mask`	`str`	Список полей для вывода.
`flat`	`bool`	Преобразование в плоский вид составных полей.

Пример запроса

GET /rest/v1/domain/storagerules/f8d1d8d6-016c-cd8c-ca1d-50e54938780c HTTP/1.1

Ответ

Описание полей: storagerule entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "name": "Полгода",
  "expires": 180,
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T10:50:51.80Z",
    "lwt": "2019-08-26T10:50:51.80Z"
  }
}

Изменение данных правила хранения

Поля запрещенные для изменения: id

Запрос

Описание полей: storagerule entity

Пример запроса

PATCH /rest/v1/domain/storagerules/f8d1d8d6-016c-cd8c-ca1d-50e54938780c HTTP/1.1
Content-Type: application/json; charset=utf-8

storagerule entity

Ответ

Описание полей: storagerule entity

Пример ответа

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "f8d1d8d6-016c-cd8c-ca1d-50e54938780c",
  "name": "Полгода",
  "expires": 182,
  "opts": {
    "title": "",
    "comment": ""
  },
  "ext": {
    "ct": "2019-08-26T10:50:51.80Z",
    "lwt": "2019-09-11T10:31:09.55Z"
  }
}

Удаление правила хранения

Запрос

Пример запроса

DELETE /rest/v1/domain/storagerules/f8d1d8d6-016c-cd8c-ca1d-50e54938780c HTTP/1.1

Ответ

Пример ответа

HTTP/1.1 204 No Content

Поиск идентификатора правила хранения

Производит поиск ресурса по указанному ключу, возвращает идентификатор(ы) для построения endpoint.

Ключевые поля для поиска: id

Запрос

Пример запроса

LOOKUP /rest/v1/domain/storagerules HTTP/1.1
Content-Type: application/json; charset=utf-8

"f8d1d8d6-016c-cd8c-ca1d-50e54938780c"

Ответ

Пример успешного ответа

HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "f8d1d8d6-016c-cd8c-ca1d-50e54938780c"
]

Пример неуспешного ответа

HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}