tasks.api.scrum.task.update
Создать или обновить задачу Скрама
Описание
Метод создает или обновляет задачу Скрама. Вы сможете:
- создать задачу в Скраме
- перенести задачу из другого проекта
- перенести ее между бэклогом и спринтами
- изменить стори поинты
- привязать эпик
Задачу нужно создать методом tasks.task.add или обновить методом tasks.task.update. Привязка задачи к скраму указывается в параметре идентификатора группы GROUP_ID.
Получить идентификатор группы можно методом создания новой группы или методом получения списка групп. Группа является скрамом, если у нее заполнено поле SCRUM_MASTER_ID.
Параметры
id
integer
обязательный
Идентификатор задачи
fields
object
обязательный
Объект содержащий записи о задаче скрама (подробное описание приведено ниже) в виде структуры:
fields: {
entityId: 'значение'
storyPoints: 'значение',
epicId: 'значение',
sort: 'значение'
}Параметр fields
entityId
integer
необязательный
Идентификатор бэклога или спринта.
Если значение не указано, *Битрикс24* автоматически добавит задачу в бэклог Скрама, если он существует
storyPoints
string
необязательный
Стори Поинты — относительная оценка сложности задачи.
Может иметь строковое значение
epicId
integer
необязательный
Идентификатор эпика
sort
integer
необязательный
Сортировка
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.task.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"fields":{"epicId":1,"storyPoints":"8","entityId":2},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.task.update
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
try {
const response = await $b24.actions.v2.call.make<boolean>({
method: 'tasks.api.scrum.task.update',
params: {
id: 1,
fields: {
epicId: 1,
storyPoints: '8',
entityId: 2,
},
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Scrum task updated:', result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function updateScrumTask() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'tasks.api.scrum.task.update',
params: {
id: 1,
fields: {
epicId: 1,
storyPoints: '8',
entityId: 2,
},
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Scrum task updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateScrumTask)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.task.update(
bitrix_id=1,
fields={
"epicId": 1,
"storyPoints": "8",
"entityId": 2,
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'tasks.api.scrum.task.update',
[
'id' => 1,
'fields' => [
'epicId' => 1,
'storyPoints' => '8',
'entityId' => 2
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating scrum task: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.task.update',
{
id: 1,
fields:
{
epicId: 1,
storyPoints: '8',
entityId: 2
}
},
function(res)
{
console.log(res);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.task.update',
[
'id' => 1,
'fields' => [
'epicId' => 1,
'storyPoints' => '8',
'entityId' => 2
]
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.task.update", b24.Params{
"id": 1,
"fields": b24.Params{
"epicId": 1,
"storyPoints": "8",
"entityId": 2,
},
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.task.update: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"status" : "success",
"data" : true,
"errors" : []
}
Возвращаемые данные
status
string
Статус ответа.
Возможные значения:
- success
- error
data
boolean
Возвращает:
- true — в случае успеха
- null — в случае ошибки
errors
array
Массив ошибок
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Task not found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Epic not found | Эпик не найден |
0 |
Task not found | Задача не найдена |
0 |
Access denied | Доступ запрещен |
0 |
Item not created | Задача не добавлена в скрам |

