For AI agents: markdown of this page — /docs-content-en/scrum/dod/necessary.md documentation index — /llms.txt
Check whether a task needs DoD
GET /v1/scrum/groups/:groupId/tasks/:taskId/dod/necessary
Checks whether a task in a scrum project needs a Definition of Done (DoD) checklist, given the project ID and the task ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
ParametergroupId (path) |
Typenumber | Requiredyes | DescriptionScrum project ID. List: GET /v1/workgroups |
ParametertaskId (path) |
Typenumber | Requiredyes | DescriptionTask ID. Project tasks: GET /v1/tasks?filter[groupId]=45 |
Examples
curl — personal key
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/tasks/2143/dod/necessary" \
-H "X-Api-Key: YOUR_API_KEY"
curl — OAuth application
curl "https://vibecode.bitrix24.com/v1/scrum/groups/45/tasks/2143/dod/necessary" \
-H "X-Api-Key: YOUR_APP_KEY" \
-H "Authorization: Bearer USER_SESSION_TOKEN"
JavaScript — personal key
const res = await fetch('https://vibecode.bitrix24.com/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 checklist required' : 'DoD checklist not required')
JavaScript — OAuth application
const res = await fetch('https://vibecode.bitrix24.com/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 checklist required' : 'DoD checklist not required')
Response fields
| Field | Type | Description |
|---|---|---|
Fieldsuccess |
Typeboolean | DescriptionAlways true on success |
Fielddata |
Typeboolean | Descriptiontrue — the task needs a DoD checklist, false — it does not |
Response example
{
"success": true,
"data": true
}
Error response example
400 — taskId is not a positive integer:
{
"success": false,
"error": {
"code": "INVALID_PARAMS",
"message": "groupId and taskId must be positive integers"
}
}
Errors
| HTTP | Code | Description |
|---|---|---|
| HTTP400 | CodeINVALID_PARAMS |
DescriptiongroupId or taskId is not a positive integer |
| 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 |
DescriptionBitrix24 refused the check |
Full list of common API errors — Errors.
Known specifics
- A
falseresponse does not confirm that the task and the project exist. A nonexistent task, a nonexistent project, and a project the user has no access to all returndata: false, not an error. Check the task beforehand withGET /v1/scrum/tasks/:taskId.