Обновить эпик в Скраме tasks.api.scrum.epic.update
Выберите инструмент для разработки с AI-агентом:
- используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
- используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации
Scope:
taskКто может выполнять метод: любой пользователь, имеющий доступ к Скраму
Метод обновляет эпик в Скраме.
Параметры метода
Обязательные параметры отмечены *
|
Название |
Описание |
|
id* |
Идентификатор эпика. Получить идентификаторы эпиков можно методом |
|
fields* |
Значения полей (подробное описание приведено ниже) для добавления нового эпика в виде структуры:
|
Параметр fields
Обязательные параметры отмечены *
|
Название |
Описание |
|
name* |
Название эпика |
|
description |
Описание эпика |
|
groupId* |
Идентификатор группы (скрама), к которой относится эпик |
|
color |
Цвет эпика |
|
files |
Массив файлов, привязанных к эпику. В Внимание Если передать пустой массив — файлы удалятся |
Примеры кода
Как использовать примеры в документации
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
"id": 1,
"fields": {
"name": "Updated epic name",
"description": "Updated description text",
"color": "#bbecf1",
"files": ["n429", "n243"]
}
},
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.epic.update
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"fields": {
"id": 1,
"fields": {
"name": "Updated epic name",
"description": "Updated description text",
"color": "#bbecf1",
"files": ["n429", "n243"]
}
},
auth=YOUR_ACCESS_TOKEN
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.epic.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
// Shape of the payload returned in result (match the "response handling" section of the page)
type EpicUpdateResult = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
}
try {
const response = await $b24.actions.v2.call.make<EpicUpdateResult>({
method: 'tasks.api.scrum.epic.update',
params: {
id: 1,
fields: {
name: 'Updated epic name',
description: 'Updated description text',
color: '#bbecf1',
files: ['n429', 'n243'],
},
},
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('Updated epic:', result.id, result.name, result.color)
}
} 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 updateEpic() {
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.epic.update',
params: {
id: 1,
fields: {
name: 'Updated epic name',
description: 'Updated description text',
color: '#bbecf1',
files: ['n429', 'n243'],
},
},
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('Updated epic:', result.id, result.name, result.color)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateEpic)
</script>
try {
$epicId = 1;
$name = 'Updated epic name';
$description = 'Updated description text';
$color = '#bbecf1';
$files = ['n429', 'n243'];
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.update',
[
'id' => $epicId,
'fields' => [
'name' => $name,
'description' => $description,
'color' => $color,
'files' => $files
]
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating epic: ' . $e->getMessage();
}
const epicId = 1;
const name = 'Updated epic name';
const description = 'Updated description text';
const color = '#bbecf1';
const files = ['n429', 'n243'];
BX24.callMethod(
'tasks.api.scrum.epic.update',
{
id: epicId,
fields:{
name: name,
description: description,
color: color,
files: files
}
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$epicId = 1;
$name = 'Updated epic name';
$description = 'Updated description text';
$color = '#bbecf1';
$files = ['n429', 'n243'];
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.epic.update',
[
'id' => $epicId,
'fields' => [
'name' => $name,
'description' => $description,
'color' => $color,
'files' => $files
]
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
}
else {
print_r($result['result']);
}
Обработка ответа
HTTP-Статус: 200
{
"id": 1,
"groupId": 143,
"name": "Updated epic name",
"description": "Updated description text",
"createdBy": 1,
"modifiedBy": 1,
"color": "#bbecf1"
}
Возвращаемые данные
|
Название |
Описание |
|
id |
Идентификатор эпика |
|
groupId |
Идентификатор группы (скрама), к которой привязан эпик |
|
name |
Название эпика |
|
description |
Описание эпика |
|
createdBy |
Идентификатор пользователя, создавшего эпик |
|
modifiedBy |
Идентификатор пользователя, который последним изменял эпик |
|
color |
Цвет эпика |
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Epic not updated"
}
|
Название |
Описание |
|
error |
Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания |
|
error_description |
Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде |
Возможные коды ошибок
|
Код |
Описание |
Значение |
|
|
Access denied |
Нет доступа для просмотра данных эпика |
|
|
Epic not found |
Такого эпика не существует |
|
|
Epic not updated |
Не удалось обновить эпик |
|
|
createdBy user not found |
Пользователь в поле «создатель» не найден |
|
|
modifiedBy user not found |
Пользователь в поле «последний изменивший» не найден |
|
|
Could not find value for parameter |
Неверно указано имя параметра или не задан параметр |
|
|
Invalid value {stringValue} to match with parameter {id}. Should be value of type int. |
Неверный тип параметра |
Статусы и коды системных ошибок
HTTP-статус: 20x, 40x, 50x
Описанные ниже ошибки могут возникнуть при вызове любого метода
|
Статус |
Код |
Описание |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24 |
|
|
|
Превышен лимит на интенсивность запросов |
|
|
|
Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут |
|
|
|
Текущий метод не разрешен для вызова с помощью batch |
|
|
|
Превышена максимальная длина параметров, переданных в метод batch |
|
|
|
Неверный access-токен или код вебхука |
|
|
|
Для вызовов методов требуется использовать протокол HTTPS |
|
|
|
REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24 |
|
|
|
REST API доступен только на коммерческих планах |
|
|
|
У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав |
|
|
|
Манифест недоступен |
|
|
|
Запрос требует более высоких привилегий, чем предоставляет токен вебхука |
|
|
|
Предоставленный access-токен доступа истек |
|
|
|
Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям |
|
|
|
Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта |
Продолжите изучение
- Эпики в Скраме: обзор методов
- Добавить эпик в Скрам tasks.api.scrum.epic.add
- Получить поля эпика по его идентификатору tasks.api.scrum.epic.get
- Получить список эпиков tasks.api.scrum.epic.list
- Удалить эпик tasks.api.scrum.epic.delete
- Получить список доступных полей эпика tasks.api.scrum.epic.getFields