Правила субординации (subordinations)

Запросы

HTTP verb Endpoint Описание

POST

/rest/v1/domain/subordinations

Создание нового правила субординации

GET

/rest/v1/domain/subordinations

Получение списка правил субординации

GET

/rest/v1/domain/subordinations/<id>

Получение данных правила субординации

PATCH

/rest/v1/domain/subordinations/<id>

Изменение данных правила субординации

DELETE

/rest/v1/domain/subordinations/<id>

Удаление правила субординации

LOOKUP

/rest/v1/domain/subordinations

Поиск идентификатора правила субординации

Создание нового правила субординации

Запрос

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

Пример запроса
POST /rest/v1/domain/subordinations HTTP/1.1
Content-Type: application/json; charset=utf-8

subordination entity

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "user",
  "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Получение списка правил субординации

Запрос

Table 1. Параметры запроса
Имя Тип Описание

filter

object

Фильтр по значениям полей.

mask

str

Список полей для вывода. Доступные поля для выдачи: id, top_type, top_key, sub_type, sub_keys, opts.title, opts.comment, ext.lwt, ext.ct.

offset

int

Смещение в списке ресурсов, подлежащих выдаче.

limit

int

Максимальное количество ресурсов в списке.

order

array<object|str>

Порядок сортировки ресурсов в списке.

flat

bool

Преобразование в плоский вид составных полей.

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

Пример запроса
GET /rest/v1/domain/subordinations?offset=0&limit=2 HTTP/1.1

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

[
  {
    "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
    "top_type": "user",
    "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
    "sub_type": "user",
    "sub_keys": [
      "00000002-abcd-abcd-abcd-abcdabcdabcd",
      "00000003-abcd-abcd-abcd-abcdabcdabcd"
    ],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2022-10-20T13:37:03.82Z",
      "lwt": "2022-10-20T13:41:42.25Z"
    }
  },
  {
    "id": "abcdef00-05b7-8163-948c-3392a9660db9",
    "top_type": "role",
    "top_key": "callcenter_supervisor",
    "sub_type": "group",
    "sub_keys": [
      "315f0002-1234-abcd-abcd-abcdabcdabcd",
      "6e003b59-2345-abcd-abcd-abcdabcdabcd"
    ],
    "opts": {
      "comment": "",
      "title": ""
    },
    "ext": {
      "ct": "2022-10-20T12:22:25.26Z",
      "lwt": "2022-10-20T12:22:25.26Z"
    }
  }
]

Получение данных правила субординации

Запрос

Table 2. Параметры запроса
Имя Тип Описание

mask

str

Список полей для вывода.

flat

bool

Преобразование в плоский вид составных полей.
Пример запроса
GET /rest/v1/domain/groups/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "user",
  "top_key": "00000001-abcd-abcd-abcd-abcdabcdabcd",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Изменение данных правила субординации

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

Запрос

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

Пример запроса
PATCH /rest/v1/domain/groups/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1
Content-Type: application/json; charset=utf-8

subordination entity

Ответ

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

Пример ответа
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "afafafaf-0178-3fc1-67fc-7cd30a921f58",
  "top_type": "role",
  "top_key": "admin",
  "sub_type": "user",
  "sub_keys": [
    "00000002-abcd-abcd-abcd-abcdabcdabcd",
    "00000003-abcd-abcd-abcd-abcdabcdabcd"
  ],
  "opts": {
    "comment": "",
    "title": ""
  },
  "ext": {
    "ct": "2022-10-20T13:37:03.82Z",
    "lwt": "2022-10-20T13:41:42.25Z"
  }
}

Удаление правила субординации

Запрос

Пример запроса
DELETE /rest/v1/domain/subordinations/afafafaf-0178-3fc1-67fc-7cd30a921f58 HTTP/1.1

Ответ

Пример ответа
HTTP/1.1 204 No Content

Поиск идентификатора правила субординации

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

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

Запрос

Пример запроса
LOOKUP /rest/v1/domain/subordinations HTTP/1.1
Content-Type: application/json; charset=utf-8

"afafafaf-0178-3fc1-67fc-7cd30a921f58"

Ответ

Пример успешного ответа
HTTP/1.1 200 OK
content-type: application/json; charset=utf-8

[
  "afafafaf-0178-3fc1-67fc-7cd30a921f58"
]
Пример неуспешного ответа
HTTP/1.1 404 Not Found
Content-Type: application/json; charset=utf-8

{
  "error_code": 1404,
  "error_message": "Lookup failed"
}
  • Персонализация
  • Увеличить шрифт
  • Уменьшить шрифт