Для AI-агентов: markdown этой страницы — /docs-content/scrum/dod/necessary.md индекс документации — /llms.txt
Проверить, нужен ли DoD задаче
GET /v1/scrum/groups/:groupId/tasks/:taskId/dod/necessary
Проверяет по ID проекта и задачи, нужен ли задаче скрам-проекта чек-лист Definition of Done (DoD).
Параметры
| Параметр | Тип | Обяз. | Описание |
|---|---|---|---|
ПараметрgroupId (path) |
Типnumber | Обяз.да | ОписаниеID скрам-проекта. Список: GET /v1/workgroups |
ПараметрtaskId (path) |
Типnumber | Обяз.да | ОписаниеID задачи. Список задач проекта: GET /v1/tasks?filter[groupId]=45 |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/tasks/2143/dod/necessary" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/tasks/2143/dod/necessary" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — личный ключ
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/45/tasks/2143/dod/necessary', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data: needsDod } = await res.json()
console.log(needsDod ? 'Нужен чек-лист DoD' : 'Чек-лист DoD не нужен')
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/45/tasks/2143/dod/necessary', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data: needsDod } = await res.json()
console.log(needsDod ? 'Нужен чек-лист DoD' : 'Чек-лист DoD не нужен')
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata |
Типboolean | Описаниеtrue — для задачи нужен чек-лист DoD, false — не нужен |
Пример ответа
{
"success": true,
"data": true
}
Пример ответа при ошибке
400 — taskId не является положительным целым числом:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "groupId and taskId must be positive integers"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеgroupId или taskId не является положительным целым числом |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан X-Api-Key |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа нет настроенных токенов |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа task |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеБитрикс24 отказал в проверке |
Полный список общих ошибок API — Ошибки.
Известные особенности
- Ответ
falseне подтверждает, что задача и проект существуют. Несуществующая задача, несуществующий проект и проект, к которому у пользователя нет доступа, отвечаютdata: false, а не ошибкой. Задачу проверяйте заранее черезGET /v1/scrum/tasks/:taskId.