jenkins_journal¶

В этой статье

Методы API

jenkins_journal/get_task_types

jenkins_journal/list

(описание будет добавлено при генерации)

Методы API¶

| Метод | Действие | Описание | |-------|----------|----------|| get_task_types | получение типов задач | Возвращает список доступных в системе типов задач Jenkins. || list | получение списка задач | Возвращает список задач Jenkins с возможностью фильтрации по ID или типу задачи. |

jenkins_journal/get_task_types¶

Возвращает список доступных в системе типов задач Jenkins.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `get_task_types`
token	✅	string	Токен авторизации

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

curl -s "https://invapi.hostkey.ru/jenkins_journal.php" -X POST \
--data "action=get_task_types" \
--data "token=HOSTKEY_TOKEN"

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

{
"result": "OK",
"module": "jenkins_journal",
"action": "get_task_types",
"list": [
"string"
]
}

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

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

jenkins_journal/list¶

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

HTTP-метод: POST

Параметры:

action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
id	❌	`array<integer>`	Массив идентификаторов задач. Принимает несколько значений: id[]=1&id[]=2
task	❌	string	Название типа задачи для фильтрации.

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

curl -s "https://invapi.hostkey.ru/jenkins_journal.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "id[]=1" \
--data "id[]=2"

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

{
"result": "OK",
"module": "jenkins_journal",
"action": "list",
"list": [
{
"id": 1,
"task": "string",
"status": "string",
"created": "string"
}
]
}

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

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