MDM REST API
31 октября 2024 г.Около 3 минMDMREST API
MDM REST API предоставляет следующие интерфейсы:
- методы для авторизации в MDM. Предплагается, что с помощью web-интерфейса, логины доступа предварительно будут заведены.
- методы доступа к Каталогу справочника.
- методы доступа к справочникам Объекты;
- методы доступа к справочникам Устройства;
- методы доступа к справочникам Типы Устройств.
1. Авторизация
Метод login
curl
curl -X 'POST' \
'http://<dns имя>:<port>/auth/login?username=<username>&password=<password>' \
-H 'accept: */*' \
-d ''Request URL
http://<dns имя>:<port>/auth/login?username=<username>&password=<password>Метод userstatus
curl
curl -X 'GET' \
'http://<dns имя>:<port>/auth/userstatus' \
-H 'accept: */*'Request URL
http://<dns имя>:<port>/auth/userstatusМетод возвращает список привелегий пользователя.
Метод logout
curl
curl -X 'POST' \
'http://<dns имя>:<port>/auth/logout' \
-H 'accept: */*' \
-d ''Request URL
http://<dns имя>:<port>/auth/logoutВыполняет выход пользователя из MDM.
2. Каталог справочников
2.1. Метод возвращает все зарегистрированные справочники
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_directory' \
-H 'accept: */*'Request URL
http://<dns имя>:<port>/ext_directoryResponse body
[
{
"id": 0,
"name": "string"
}
]2.2. Метод создания внешнего справочника
Request body
{
"id": 0,
"name": "string"
}curl
curl -X 'POST' \
'http://<dns имя>:<port>/ext_directory' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"name": "string"
}'2.3. Метод изменения записи внешнего справочника
Request body
{
"id": 0,
"name": "string"
}curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_directory/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": <Id>,
"name": "<Название>"
}'2.4. Метод удаления записей из внешнего справочника
curl
curl -X 'DELETE' \
'http://<dns имя>:<port>/ext_directory?id=1' \
-H 'accept: */*'3. Справочники Объектов
3.1. Получение всех записей об объектах внешнего справочника
Фильтры:
- extDirectoryId int - идентификатор внешнего справочника
- code string - код внешней системы
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_object_ref?extDirectoryId=<Id>&code="Код внешней системы"' \
-H 'accept: */*'Response body
[
{
"id": 0,
"code": "string",
"objectId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}
]3.2. Создание записи в справочнике объектов
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_object_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"objectId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'3.3 Изменение записи в справочнике объектов
Входной параметр : Id записи справочника
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_object_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"objectId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'3.4 Удаление записи в справочнике объектов
Входной параметр : Id записи справочника
curl
curl -X 'DELETE' \
'http://<dns имя>:<port>/ext_object_ref?id=<Id>' \
-H 'accept: */*'3.5 Получение записи о справочнике объекта
Входной параметр : Id записи справочника
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_object_ref/<Id>' \
-H 'accept: */*'```Responses
{
"id": 0,
"code": "string",
"objectId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}4. Справочники Типов Устройств
4.1. Получение всех записей о Типах Устройств внешнего справочника
Фильтры:
- extDirectoryId int - идентификатор внешнего справочника
- code string - код внешней системы для типа устройства
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_device_ref?extDirectoryId=<Id>&code="Код внешней системы"' \
-H 'accept: */*'Response body
[
{
"id": 0,
"code": "string",
"deviceClassifierId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}
]4.2. Создание записи в справочнике Типов Устройств
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_device_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"deviceClassifierId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'4.3 Изменение записи в справочнике Типов Устройств
Входной параметр : Id записи справочника
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_device_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"deviceClassifierId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'4.4 Удаление записи в справочнике Типов Устройств
Входной параметр : Id записи справочника
curl
curl -X 'DELETE' \
'http://<dns имя>:<port>/ext_device_ref?id=<Id>' \
-H 'accept: */*'4.5 Получение записи о справочнике Типа Устройства
Входной параметр : Id записи справочника
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_device_ref/<Id>' \
-H 'accept: */*'```Responses
{
"id": 0,
"code": "string",
"deviceClassifierId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}5. Справочники Устройств
5.1. Получение всех записей об Устройствах из внешнего справочника
Фильтры:
- extDirectoryId int - идентификатор внешнего справочника
- code string - код внешней системы для устройства
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_unit_ref?extDirectoryId=<Id>&code="Код внешней системы"' \
-H 'accept: */*'Response body
[
{
"id": 0,
"code": "string",
"unitId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}
]5.2. Создание в справочнике записи об Устройстве
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_unit_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"unitId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'5.3 Изменение в справочнике записи об Устройстве
Входной параметр : Id записи справочника
curl
curl -X 'PUT' \
'http://<dns имя>:<port>/ext_unit_ref/<Id>' \
-H 'accept: */*' \
-H 'Content-Type: application/json' \
-d '{
"id": 0,
"code": "string",
"unitId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}'5.4 Удаление в справочнике записи об Устройстве
Входной параметр : Id записи справочника
curl
curl -X 'DELETE' \
'http://<dns имя>:<port>/ext_unit_ref?id=<Id>' \
-H 'accept: */*'5.5 Получение из справочника записи об Устройстве
Входной параметр : Id записи справочника
curl
curl -X 'GET' \
'http://<dns имя>:<port>/ext_unit_ref/<Id>' \
-H 'accept: */*'```Responses
{
"id": 0,
"code": "string",
"unitId": 0,
"extDirectory": {
"id": 0,
"name": "string"
}
}