Перейти к основному содержимому

Справочники API 1.6.0

Справочники и пользовательские справочные данные.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.6.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела​

МетодПуть
GET/directories
GET/directories/{name}
POST/directories
PUT/directories/{name}
DELETE/directories/{name}

GET /directories​

Раздел: Справочники.

Возвращает список всех справочников со значениями.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/directories" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/directories" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/directories"
  }
}

GET /directories/{name}​

Раздел: Справочники.

Возвращает список значений конкретного справочника.

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

curl -k -X GET "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "data": [],
  "meta": {
    "api_version": "1.6.0",
    "path": "/directories/{name}"
  }
}

POST /directories​

Раздел: Справочники.

Добавляет новый справочник.

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

curl -k -X POST "https://{IP_контроллера}/api/v1/directories" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Служба безопасности"
    }
  ]
}'

Пример тела запроса​

{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Служба безопасности"
    }
  ]
}

Пример получения ответа​

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/directories" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

PUT /directories/{name}​

Раздел: Справочники.

Редактирует существующий справочник.

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

curl -k -X PUT "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Служба безопасности"
    }
  ]
}'

Пример тела запроса​

{
  "name": "departments",
  "items": [
    {
      "value": "security",
      "label": "Служба безопасности"
    }
  ]
}

Пример получения ответа​

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

DELETE /directories/{name}​

Раздел: Справочники.

Удаляет существующий справочник.

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

curl -k -X DELETE "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа​

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/directories/{name}" \
  -H "Authorization: Bearer <token>" | jq .

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

{
  "status": "success",
  "deleted": true
}