For AI agents: markdown of this page — /docs-content-en/scrum/dod.md documentation index — /llms.txt

Scrum Definition of Done

These named routes expose Scrum DoD methods. They require an API key with the task scope; writes also require a key without READONLY mode. The native Bitrix24 result is returned in data.

Settings

GET /v1/scrum/groups/:groupId/dod/settings calls tasks.scrum.DoD.getSettings. The optional query parameter is saveRequest (Y or N; Bitrix24 defaults to Y). The result contains types and activeTypeId. A taskId query is refused because a nonzero value makes the Bitrix24 controller skip access validation for the specified group.

GET /v1/scrum/groups/:groupId/tasks/:taskId/dod/necessary calls tasks.scrum.DoD.isNecessary and returns a boolean.

POST /v1/scrum/groups/:groupId/dod/types/:typeId/settings calls tasks.scrum.DoD.saveSettings. Send { "requiredOption": "Y", "items": [], "participants": [] }; both arrays are required. Empty arrays can clear saved items and participants. The native result contains type or is null.

POST /v1/scrum/tasks/:taskId/dod/:typeId calls tasks.scrum.DoD.saveList. Send a JSON object with a required items array; an empty array clears the saved list. The native result is a string or null.

Both POST examples in the API reference read JSON from a placeholder file. Prepare that file with the complete current items and, for settings, participants before calling: Bitrix24 replaces the saved values with these arrays. The file does not exist at the shown path by default.

tasks.scrum.DoD.getList is not exposed. Its Bitrix24 controller returns a component, and the successful REST response shape has not been observed on an accessible test group. An accessible group and task with configured DoD are needed to define that contract.

Metrics

See sprint metrics.