Изменить спринт tasks.api.scrum.sprint.update

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

Метод tasks.api.scrum.sprint.update изменяет спринт.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор спринта

fields*
object

Объект с данными спринта

Параметр fields

Название
тип

Описание

groupId
integer

Идентификатор группы (Скрама), к которой относится спринт.

Идентификатор можно получить методом tasks.api.scrum.sprint.get для уже существующего спринта

name
string

Название спринта

sort
integer

Сортировка

dateStart
string

Дата начала спринта. Доступные форматы: ISO 8601, timestamp

dateEnd
string

Дата окончания спринта. Доступные форматы: ISO 8601, timestamp

status
string

Статус спринта. Доступные значения: active, planned, completed

Примеры кода

Как использовать примеры в документации

curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2,
"fields": {
    "name": "Sprint 2",
    "groupId": 1,
    "dateStart": "2021-11-22T00:00:00+02:00",
    "dateEnd": "2021-11-29T00:00:00+02:00"
}
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.update
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"id": 2,
"fields": {
    "name": "Sprint 2",
    "groupId": 1,
    "dateStart": "2021-11-22T00:00:00+02:00",
    "dateEnd": "2021-11-29T00:00:00+02:00"
}
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.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, ISODate } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of the payload returned in result (match the "response handling" section of the page)
type SprintResult = {
  id: number
  groupId: number
  entityType: string
  name: string
  goal: string
  sort: number
  createdBy: number
  modifiedBy: number
  dateStart: ISODate | null
  dateEnd: ISODate | null
  status: string
}

try {
  const response = await $b24.actions.v2.call.make<SprintResult>({
    method: 'tasks.api.scrum.sprint.update',
    params: {
      id: 2,
      fields: {
        name: 'Sprint 2',
        groupId: 1,
        dateStart: '2021-11-22T00:00:00+02:00',
        dateEnd: '2021-11-29T00:00:00+02:00',
      },
    },
    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 sprint:', result.id, result.name, result.status)
  }
} 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 updateSprint() {
    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.sprint.update',
        params: {
          id: 2,
          fields: {
            name: 'Sprint 2',
            groupId: 1,
            dateStart: '2021-11-22T00:00:00+02:00',
            dateEnd: '2021-11-29T00:00:00+02:00',
          },
        },
        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 sprint:', result.id, result.name, result.status)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', updateSprint)
</script>
try {
    $response = $b24Service
        ->core
        ->call(
            'tasks.api.scrum.sprint.update',
            [
                'id' => $sprintId,
                'fields' => [
                    'name'      => $name,
                    'groupId'   => $groupId,
                    'dateStart' => $dateStart,
                    'dateEnd'   => $dateEnd,
                ],
            ]
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    // Нужная вам логика обработки данных
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error updating sprint: ' . $e->getMessage();
}
const sprintId = 2;
const groupId = 1;
const name = 'Sprint 2';
const dateStart = '2021-11-22T00:00:00+02:00';
const dateEnd = '2021-11-29T00:00:00+02:00';
BX24.callMethod(
    'tasks.api.scrum.sprint.update',
    {
        id: sprintId,
        fields: {
            name: name,
            groupId: groupId,
            dateStart: dateStart,
            dateEnd: dateEnd,
        }
    },
    function(res)
    {
        console.log(res);
    }
);
require_once('crest.php'); // подключение CRest PHP SDK

// выполнение запроса к REST API
$result = CRest::call(
    'tasks.api.scrum.sprint.update',
    [
        'id' => 2,
        'fields' => [
            'name' => 'Sprint 2',
            'groupId' => 1,
            'dateStart' => '2021-11-22T00:00:00+02:00',
            'dateEnd' => '2021-11-29T00:00:00+02:00'
        ]
    ]
);

// Обработка ответа от Битрикс24
if (isset($result['error'])) {
    echo 'Error: '.$result['error_description'];
} else {
    print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.sprint.update", b24.Params{
	"id": 2,
	"fields": b24.Params{
		"name":      "Sprint 2",
		"groupId":   1,
		"dateStart": "2021-11-22T00:00:00+02:00",
		"dateEnd":   "2021-11-29T00:00:00+02:00",
	},
})
if err != nil {
	return fmt.Errorf("tasks.api.scrum.sprint.update: %w", err)
}

var item struct {
	ID         b24.ID `json:"id"`
	GroupID    b24.ID `json:"groupId"`
	EntityType string `json:"entityType"`
	Name       string `json:"name"`
	Goal       string `json:"goal"`
	Sort       int    `json:"sort"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.GroupID)

Обработка ответа

HTTP-статус: 200

{
    "result":
    {
        "id": 2,
        "groupId": 1,
        "entityType": "sprint",
        "name": "Sprint 2",
        "goal": "",
        "sort": 1,
        "createdBy": 1,
        "modifiedBy": 1,
        "dateStart": "2021-11-22T00:00:00+02:00",
        "dateEnd": "2021-11-29T00:00:00+02:00",
        "status": "planned"
    }
}

Возвращаемые данные

Название
тип

Описание

result
object

Объект, содержащий данные о спринте

id
integer

Идентификатор спринта

groupId
integer

Идентификатор группы (Скрама), к которой относится спринт

entityType
string

Тип сущности (в данном случае sprint)

name
string

Название спринта

goal
string

Цель спринта. Устанавливается только в интерфейсе при запуске спринта

sort
integer

Сортировка

createdBy
integer

Идентификатор пользователя, создавшего спринт

modifiedBy
integer

Идентификатор пользователя, изменившего спринт

dateStart
string

Дата начала спринта в формате ISO 8601

dateEnd
string

Дата окончания спринта в формате ISO 8601

status
string

Статус спринта

Обработка ошибок

HTTP-статус: 400

{
    "error": 0,
    "error_description": "Sprint not found"
}

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Cообщение об ошибке

Описание

0

Access denied

Нет доступа к Скраму

0

Sprint not created

Не удалось создать спринт

0

Incorrect dateStart format

Неверный формат времени начала спринта

0

Incorrect dateEnd format

Неверный формат времени окончания спринта

0

createdBy user not found

Пользователь в поле «создатель» не найден

0

modifiedBy user not found

Пользователь в поле «последний изменивший» не найден

0

Unable to add two active sprint

В группе не может быть двух спринтов со статусом «активен»

0

Incorrect sprint status

Статус не состоит в списке доступных для установки статусов спринта

100

Could not find value for parameter {fields}

Неверно указано имя параметра или не задан параметр

100

Invalid value {stringValue} to match with parameter {fields}. Should be value of type array

Неверный тип параметра

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение