duty_ie_journal.php¶

В этой статье

Методы API

duty_ie_journal/add

duty_ie_journal/update

duty_ie_journal/list

API endpoint for managing the Duty IE journal entries, including adding new records, updating existing ones, and listing journal entries.

Методы API¶

Метод	Действие	Описание
`add`	добавление записи в журнал	Создает новую запись в журнале Duty IE с привязкой к серверу и тикету.
`list`	получение списка записей	Возвращает список записей журнала с возможностью фильтрации.
`update`	обновление записи в журнале	Обновляет существующую запись в журнале Duty IE.

duty_ie_journal/add¶

Создает новую запись в журнале Duty IE с привязкой к серверу и тикету.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
eq_id	❌	integer	ID оборудования (сервера)
ticket	✅	string	ID тикета Kayako. Максимальная длина 16 символов.
task_list	❌	string	Список задач по работе
rhr_comment	❌	string	Комментарий к работе (RHR)
status	❌	string	Статус задачи. Допустимые значения: NEW и другие из DutyIEJournalStatusMap.
set_admin_lock	❌	integer	Установить административную блокировку (1 - да, 0 - нет). При значении > 0 запускается процедура обслуживания.

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

curl -s "https://invapi.hostkey.ru/duty_ie_journal.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "ticket=TK-999" \
--data "eq_id=45"

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

{
"result": "OK",
"module": "duty_ie_journal",
"action": "add",
"list": {
"id": 123,
"eq_id": 45,
"ticket": "TK-999",
"assignee": "admin@hostkey.com",
"status": "active"
}
}

Примеры ошибок

{
"errors": [
{
"code": -1,
"message": "Invalid ticket ID"
},
{
"code": 400,
"message": "No action specified"
},
{
"code": 403,
"message": "Unauthorized access"
},
{
"code": 404,
"message": "Resource not found"
}
]
}

duty_ie_journal/update¶

Обновляет существующую запись в журнале Duty IE.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
id	✅	integer	ID записи журнала для обновления
ticket	✅	string	ID тикета Kayako. Максимальная длина 16 символов.
status	❌	string	Новый статус задачи

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

curl -s "https://invapi.hostkey.ru/duty_ie_journal.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123" \
--data "ticket=TICKET-123" \
--data "status=DONE"

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

{
"result": "OK",
"module": "duty_ie_journal",
"action": "update",
"list": [
{
"id": 1,
"eq_id": 10,
"assignee": "admin",
"status": "DONE",
"task_list": "...",
"rhr_comment": "...",
"ticket": "TICKET-123",
"date_created": "2023-01-01 10:00:00",
"date_finished": "2023-01-01 12:00:00",
"hwconfig": null,
"ipmi_changer": null,
"speedtest_ticket": null,
"rhr": "1,2,3"
}
]
}

Примеры ошибок

{
"400": {
"message": "No action specified"
},
"403": {
"message": "Authorization required"
},
"404": {
"message": "Action is not recognized"
},
"die_json": {
"result": -1,
"error": "Invalid ticket ID"
}
}

duty_ie_journal/list¶

Возвращает список записей журнала с возможностью фильтрации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
id	❌	integer	ID записи журнала для фильтрации
eq_id	❌	integer	ID оборудования (сервера) для фильтрации
assignee	❌	string	Исполнитель задачи
date_from	❌	string	Начальная дата (records after this date)
date_to	❌	string	Конечная дата (records before this date)
status	❌	string	Статус задачи для фильтрации: active, closed, pending

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

curl -s "https://invapi.hostkey.ru/duty_ie_journal.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "status=active"

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

{
"result": "OK",
"module": "duty_ie_journal",
"action": "list",
"list": [
{
"id": 10,
"eq_id": 5,
"assignee": "user@example.com",
"status": "active",
"ticket": "T-123",
"hwconfig": null,
"ipmi_changer": null,
"speedtest_ticket": null,
"rhr": "1,2,3"
}
]
}

Примеры ошибок

{
"PlatformException": [
{
"code": 400,
"message": "No action specified"
},
{
"code": 403,
"message": "Authorization required"
},
{
"code": 404,
"message": "Action is not recognized"
}
]
}