Para agentes de IA: markdown de esta página — /docs-content-en/scrum/dod.md índice de la documentación — /llms.txt

Los artículos de la documentación están disponibles actualmente en inglés.

Definition of Done in Scrum

Definition of Done (DoD) is a checklist of conditions a scrum project task must meet to count as done. The endpoints read a project's DoD types, check whether a task needs the checklist, and save checklist items for a type and for a task.

Bitrix24 API: tasks.scrum.DoD.* Scope: task

Get DoD settings

GET /v1/scrum/groups/:groupId/dod/settings

Returns the Definition of Done types of a scrum project: the name, order, whether the checklist is required, and the participants of each type.

Parameters

Parameter Type Required Default Description
ParametergroupId (path) Typenumber Requiredyes Default— DescriptionScrum project ID. List: GET /v1/workgroups
ParametersaveRequest (query) Typestring Requiredno DefaultY DescriptionAccepts Y or N. On the projects checked, the response is the same for both values

Examples

curl — personal key

Terminal
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/dod/settings" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/dod/settings" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript
const res = await fetch('https://vibecode.bitrix24.com/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 application

javascript
const res = await fetch('https://vibecode.bitrix24.com/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)
}

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata.types Typearray DescriptionThe project's DoD types. A non-scrum workgroup the user belongs to returns success with an empty array
Fielddata.types[].id Typenumber DescriptionType ID. Accepted by saving the type's settings and saving a task's DoD list
Fielddata.types[].entityId Typenumber DescriptionID of the scrum project backlog the type belongs to
Fielddata.types[].name Typestring DescriptionType name
Fielddata.types[].sort Typenumber DescriptionPosition of the type in the list
Fielddata.types[].dodRequired Typestring DescriptionY — the DoD checklist is required for tasks of this type, N — it is not
Fielddata.types[].participants Typearray DescriptionType participants in the format { "id": 1, "entityId": "user" }
Fielddata.activeTypeId Typenumber Description0 when reading project settings

Response example

JSON
{
  "success": true,
  "data": {
    "types": [
      {
        "id": 1,
        "entityId": 1,
        "name": "Product task",
        "sort": 1,
        "dodRequired": "Y",
        "participants": []
      },
      {
        "id": 3,
        "entityId": 1,
        "name": "Technical task",
        "sort": 2,
        "dodRequired": "N",
        "participants": []
      }
    ],
    "activeTypeId": 0
  }
}

Error response example

422 — the project does not exist or the user has no access to it:

JSON
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "You don't have access.",
    "b24Code": "TASKS_SDC_02"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiongroupId is not a positive integer
HTTP400 CodeINVALID_PARAMS DescriptionsaveRequest is not Y or N
HTTP400 CodeINVALID_PARAMS DescriptionThe query contains a parameter other than saveRequest, such as taskId
HTTP401 CodeMISSING_API_KEY DescriptionX-Api-Key is missing
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP422 CodeBITRIX_ERROR DescriptionThe project does not exist or the user has no access to it. error.b24Code is TASKS_SDC_02

Full list of common API errors — Errors.

See also