لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/scrum/tasks.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

Task placement in scrum

Read and change a task's scrum row: backlog or sprint, epic binding, story points, sort order. A task is first created via POST /v1/tasks, then placed in scrum.

Scope: task | Base URL: https://vibecode.bitrix24.com/v1 | Auth: X-Api-Key

Get a task's scrum placement

GET /v1/scrum/tasks/:taskId

Returns the task's current scrum entry. Use it before moving a task to learn its placement, or after a change to confirm it was applied.

Parameters

Parameter Type Required Description
ParametertaskId Typenumber Requiredyes DescriptionTask ID (path parameter). Source: GET /v1/tasks

Examples

curl — personal key

Terminal 
curl https://vibecode.bitrix24.com/v1/scrum/tasks/59 \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl https://vibecode.bitrix24.com/v1/scrum/tasks/59 \
  -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/tasks/59', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { data } = await res.json()
console.log('Placement:', data)

JavaScript — OAuth application

javascript 
const res = await fetch('https://vibecode.bitrix24.com/v1/scrum/tasks/59', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()

Response fields

Field Type Description
Fieldsuccess Typeboolean DescriptionAlways true on success
Fielddata Typeobject DescriptionThe task placement in scrum
Fielddata.entityId Typenumber DescriptionID of the backlog or sprint the task is in
Fielddata.epicId Typenumber DescriptionEpic ID. 0 — the task is not linked to an epic. Source: GET /v1/scrum/epics
Fielddata.storyPoints Typestring DescriptionStory points, for example "3". Empty string — not set
Fielddata.sort Typenumber DescriptionPosition in the list
Fielddata.sortFloat Typenumber DescriptionPosition in the list. Takes priority over sort
Fielddata.createdBy Typenumber DescriptionID of the user who created the placement. Source: GET /v1/users
Fielddata.modifiedBy Typenumber DescriptionID of the user who last changed the placement. Source: GET /v1/users
Fielddata.groupId Typenumber DescriptionID of the task's scrum project. List: GET /v1/workgroups

Response example

JSON 
{
  "success": true,
  "data": {
    "entityId": 1,
    "storyPoints": "3",
    "epicId": 11,
    "sort": 255,
    "sortFloat": 512,
    "createdBy": 1,
    "modifiedBy": 1,
    "groupId": 45
  }
}

Error response example

404 — the task is not placed in scrum or does not exist:

JSON 
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "Task not found"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_PARAMS DescriptiontaskId is not a positive integer
HTTP404 CodeENTITY_NOT_FOUND DescriptionThe task was not found or is not placed in scrum
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the task scope
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no configured tokens

Full list of common API errors — Errors.

See also