Для AI-агентов: markdown этой страницы — /docs-content/scrum/dod/settings.md индекс документации — /llms.txt
Получить настройки DoD
GET /v1/scrum/groups/:groupId/dod/settings
Возвращает типы Definition of Done скрам-проекта: название, порядок, обязательность чек-листа и участников каждого типа.
Параметры
| Параметр | Тип | Обяз. | По умолч. | Описание |
|---|---|---|---|---|
ПараметрgroupId (path) |
Типnumber | Обяз.да | По умолч.— | ОписаниеID скрам-проекта. Список: GET /v1/workgroups |
ПараметрsaveRequest (query) |
Типstring | Обяз.нет | По умолч.Y |
ОписаниеПринимает Y или N. На проверенных проектах ответ при обоих значениях одинаков |
Примеры
curl — личный ключ
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/dod/settings" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth-приложение
curl "https://vibecode.bitrix24.tech/v1/scrum/groups/45/dod/settings" \
-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/dod/settings', {
headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
for (const type of data.types) {
console.log(type.id, type.name, type.dodRequired)
}
JavaScript — OAuth-приложение
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/45/dod/settings', {
headers: {
'X-Api-Key': 'YOUR_APP_KEY',
'Authorization': 'Bearer USER_SESSION_TOKEN',
},
})
const { data } = await res.json()
for (const type of data.types) {
console.log(type.id, type.name, type.dodRequired)
}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
Полеsuccess |
Типboolean | ОписаниеВсегда true при успехе |
Полеdata.types |
Типarray | ОписаниеТипы DoD проекта. Рабочая группа без скрама, в которой состоит пользователь, отвечает успехом с пустым массивом |
Полеdata.types[].id |
Типnumber | ОписаниеID типа. Его принимают сохранение настроек типа и сохранение списка DoD задачи |
Полеdata.types[].entityId |
Типnumber | ОписаниеID бэклога скрам-проекта, к которому относится тип |
Полеdata.types[].name |
Типstring | ОписаниеНазвание типа |
Полеdata.types[].sort |
Типnumber | ОписаниеПорядок типа в списке |
Полеdata.types[].dodRequired |
Типstring | ОписаниеY — чек-лист DoD обязателен для задач этого типа, N — нет |
Полеdata.types[].participants |
Типarray | ОписаниеУчастники типа в формате { "id": 1, "entityId": "user" } |
Полеdata.activeTypeId |
Типnumber | ОписаниеПри чтении настроек проекта — 0 |
Пример ответа
{
"success": true,
"data": {
"types": [
{
"id": 1,
"entityId": 1,
"name": "Продуктовая задача",
"sort": 1,
"dodRequired": "Y",
"participants": []
},
{
"id": 3,
"entityId": 1,
"name": "Техническая задача",
"sort": 2,
"dodRequired": "N",
"participants": []
}
],
"activeTypeId": 0
}
}
Пример ответа при ошибке
422 — проект не существует или у пользователя нет к нему доступа:
{
"success": false,
"error": {
"code": "BITRIX_ERROR",
"message": "У вас нет доступа.",
"b24Code": "TASKS_SDC_02"
}
}
Ошибки
| HTTP | Код | Описание |
|---|---|---|
| HTTP400 | КодINVALID_PARAMS |
ОписаниеgroupId не является положительным целым числом |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеsaveRequest не равен Y или N |
| HTTP400 | КодINVALID_PARAMS |
ОписаниеВ query передан параметр кроме saveRequest, например taskId |
| HTTP401 | КодMISSING_API_KEY |
ОписаниеНе передан X-Api-Key |
| HTTP401 | КодTOKEN_MISSING |
ОписаниеУ ключа нет настроенных токенов |
| HTTP403 | КодSCOPE_DENIED |
ОписаниеКлючу не хватает скоупа task |
| HTTP422 | КодBITRIX_ERROR |
ОписаниеПроект не существует или у пользователя нет к нему доступа. В error.b24Code — TASKS_SDC_02 |
Полный список общих ошибок API — Ошибки.