Для AI-агентов: markdown этой страницы — /docs-content/scrum/dod/save-settings.md индекс документации — /llms.txt

Сохранить настройки DoD

POST /v1/scrum/groups/:groupId/dod/types/:typeId/settings

Задаёт для типа Definition of Done скрам-проекта обязательность чек-листа, его пункты и участников типа. Пункты и участники заменяются целиком значениями из запроса.

Параметры

Параметр Тип Обяз. Описание
ПараметрgroupId (path) Типnumber Обяз.да ОписаниеID скрам-проекта. Список: GET /v1/workgroups
ПараметрtypeId (path) Типnumber Обяз.да ОписаниеID типа DoD. Список: GET /v1/scrum/groups/:groupId/dod/settings, поле data.types[].id

Поля запроса (body)

Поле Тип Обяз. Описание
ПолеrequiredOption Типstring Обяз.да ОписаниеY — чек-лист DoD обязателен для задач типа, N — нет
Полеitems Типarray Обяз.да ОписаниеПункты чек-листа типа. Пустой массив удаляет все пункты
Полеitems[].TITLE Типstring Обяз.да ОписаниеТекст пункта. Имя поля — в верхнем регистре
Полеparticipants Типarray Обяз.да ОписаниеУчастники типа. Пустой массив удаляет всех участников
Полеparticipants[].entityId Типstring Обяз.да Описаниеuser
Полеparticipants[].id Типnumber Обяз.да ОписаниеID сотрудника. Список: GET /v1/users

Примеры

curl — личный ключ

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "requiredOption": "Y",
    "items": [{ "TITLE": "Код прошёл ревью" }, { "TITLE": "Тесты пройдены" }],
    "participants": [{ "entityId": "user", "id": 1 }]
  }'

curl — OAuth-приложение

Terminal
curl -X POST "https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "requiredOption": "Y",
    "items": [{ "TITLE": "Код прошёл ревью" }, { "TITLE": "Тесты пройдены" }],
    "participants": [{ "entityId": "user", "id": 1 }]
  }'

JavaScript — личный ключ

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    requiredOption: 'Y',
    items: [{ TITLE: 'Код прошёл ревью' }, { TITLE: 'Тесты пройдены' }],
    participants: [{ entityId: 'user', id: 1 }],
  }),
})

const { data } = await res.json()
console.log(data.type.dodRequired)

JavaScript — OAuth-приложение

javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/scrum/groups/53/dod/types/7/settings', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    requiredOption: 'Y',
    items: [{ TITLE: 'Код прошёл ревью' }, { TITLE: 'Тесты пройдены' }],
    participants: [{ entityId: 'user', id: 1 }],
  }),
})

const { data } = await res.json()
console.log(data.type.dodRequired)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean ОписаниеВсегда true при успехе
Полеdata.type.id Типnumber ОписаниеID типа DoD
Полеdata.type.entityId Типnumber ОписаниеID бэклога скрам-проекта, к которому относится тип
Полеdata.type.name Типstring ОписаниеНазвание типа
Полеdata.type.sort Типnumber ОписаниеПорядок типа в списке
Полеdata.type.dodRequired Типstring ОписаниеСохранённое значение requiredOption
Полеdata.type.participants Типarray ОписаниеСохранённые участники в формате { "id": 1, "entityId": "user" }

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

JSON
{
  "success": true,
  "data": {
    "type": {
      "id": 7,
      "entityId": 5,
      "name": "Техническая задача",
      "sort": 2,
      "dodRequired": "Y",
      "participants": [
        {
          "id": 1,
          "entityId": "user"
        }
      ]
    }
  }
}

Пример ответа при ошибке

422 — типа с таким typeId нет:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "Не удалось найти тип.",
    "b24Code": "TASKS_SDC_03"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодINVALID_PARAMS ОписаниеgroupId или typeId не является положительным целым числом
HTTP400 КодINVALID_PARAMS ОписаниеrequiredOption не передан или не равен Y или N
HTTP400 КодINVALID_PARAMS Описаниеitems или participants не передан или не является массивом
HTTP400 КодINVALID_PARAMS ОписаниеТело не является JSON-объектом, например передан массив
HTTP400 КодINVALID_PARAMS ОписаниеВ теле есть поле кроме requiredOption, items и participants
HTTP400 КодFST_ERR_CTP_EMPTY_JSON_BODY ОписаниеЗапрос с Content-Type: application/json и пустым телом
HTTP401 КодMISSING_API_KEY ОписаниеНе передан X-Api-Key
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов
HTTP403 КодSCOPE_DENIED ОписаниеКлючу не хватает скоупа task
HTTP403 КодWRITE_BLOCKED_READONLY_KEY ОписаниеКлюч работает в режиме только чтения
HTTP422 КодBITRIX_ERROR ОписаниеТипа с таким typeId нет. В error.b24Code — TASKS_SDC_03, сообщение «Не удалось найти тип.»
HTTP422 КодBITRIX_ERROR ОписаниеПункт items без поля TITLE, например с title в нижнем регистре. В error.b24Code — TASKS_SDC_03, сообщение «System error»
HTTP422 КодBITRIX_ERROR ОписаниеПункт items — строка, а не объект. В error.b24Code — 0, сообщение «Internal server error.»
HTTP422 КодBITRIX_ERROR ОписаниеПроект не существует или у пользователя нет к нему доступа. В error.b24Code — TASKS_SDC_02

Полный список общих ошибок API — Ошибки.

Известные особенности

  • Участник с "entityId": "department" не сохраняется: запрос отвечает успехом, а data.type.participants в ответе пустой. Сохранённых участников сверяйте по ответу.

Смотрите также