API - Сервисные режимы
Внимание
Для выполнения запроса к API необходима дополнительная авторизация.
Используйте в запросе заголовок Authorization: Bearer <персональный токен>
.
Получение списка всех сервисных режимов
Поисковая фраза ?search=
работает для:
- Идентификатора сервисного режима.
- Идентификатора КЕ, которая входит в область действия сервисного режима.
- Наименования сервисного режима.
- Ключа / значения набора меток.
Сортировка работает для всех полей кроме:
- Списка КЕ, которые попадают под область действия сервисного режима.
- Словаря меток.
Сервисный режим доступен пользователю, если хоть одна КЕ из запрошенного режима доступна.
GET /api/public/sm/v1/rsm-maintenance
Параметры запроса
Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию | Описание параметра |
---|---|---|---|---|
page | integer | нет | null | Номер страницы |
perPage | integer | нет | null | Количество записей на одну страницу. Если -1 - будут возвращены все КЕ |
search | string | нет | null | Строка поиска |
sortCol | string | нет | null | Название поля, по которому выполняется сортировка |
sortDir | string | нет | null | Направление сортировки (asc/desc) |
skip | integer | нет | null | Количество записей, которое требуется пропустить |
Пример в ыходной модели
[
{
"id": 16,
"dateStart": "2021-07-08T10:56:17+03:00",
"dateEnd": "2021-07-11T11:56:17+03:00",
"title": "Test Servicemode",
"configItems": [
{
"id": 135382,
"scope": "Ci",
"depth": 0,
"state": "Pending",
"dateStart": "2021-07-08T10:56:17+03:00",
"dateEnd": "2021-07-11T11:56:17+03:00"
}
],
"labels": {}
},
{
"id": 17,
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00",
"title": "Test Servicemode",
"configItems": [
{
"id": 135380,
"scope": "CiAndChildren",
"depth": 3,
"state": "Pending",
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00"
}
],
"labels": {
"z1": "w1",
"z2": "w2"
}
},
{
"id": 18,
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00",
"title": "Test Servicemode",
"configItems": [
{
"id": 135379,
"scope": "Ci",
"depth": 0,
"state": "Pending",
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00"
},
{
"id": 135381,
"scope": "CiAndChildren",
"depth": 3,
"state": "Pending",
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00"
}
],
"labels": {
"z1": "w1",
"z2": "w2"
}
}
]
Коды ответа
Код | Описание |
---|---|
200 | Запрос успешно исполнен |
401 | Пользователь не авторизован |
403 | Недостаточно прав для п росмотра сервисных режимов |
500 | Непредвиденная ошибка при обработке запроса |
Получение сервисного режима по идентификатору
Сервисный режим доступен пользователю, если хоть одна КЕ из запрошенного режима доступна.
GET /api/public/sm/v1/rsm-maintenance/{id}
Параметры запроса
Параметр | Тип | Обязательный параметр | Значение по умолчанию | Описание |
---|---|---|---|---|
id | integer | да | нет | ID запроса на обслуживание |
Пример выходной модели
{
"id": 18,
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00",
"title": "Test Servicemode",
"configItems": [
{
"id": 135379,
"scope": "Ci",
"depth": 0,
"state": "Pending",
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00"
},
{
"id": 135381,
"scope": "CiAndChildren",
"depth": 3,
"state": "Pending",
"dateStart": "2021-07-09T10:56:17+03:00",
"dateEnd": "2021-07-12T11:56:17+03:00"
}
],
"labels": {
"z1": "w1",
"z2": "w2"
}
}
Коды ответа
Код | Описание |
---|---|
200 | Запрос успешно исполнен |
403 | Недостаточно прав для просмотра данного сервисного режима |
404 | Сервисный режим с ID {id} не найден |
500 | Непредвиденная ошибка при обработке запроса |
Получение списка сервисных режимов по фильтру
Поисковая фраза ?search=
работает для:
- Идентификатора сервисного режима.
- Идентификатора КЕ, входящей в область действия сервисного режима.
- Наименования сервисного режима.
- Набора меток (ключ / значение).
Сортировка работает для всех полей кроме:
- Списка КЕ, которые попадают под область действия сервисного режима.
- Словаря меток.
Сервисный режим доступен пользователю, если хоть одна КЕ из запрошенного режима доступна.
POST /api/public/sm/v1/rsm-maintenance/filter
Параметры запроса
Название параметра | Тип параметра | Обязательный параметр | Значение по умолчанию |
---|