метод REST
scope: task
tasks.api.scrum.sprint.delete
Удалить спринт
Описание
Метод tasks.api.scrum.sprint.delete удаляет спринт.
При удалении спринта с задачами задачи будут перемещены в бэклог.
Параметры
id
integer
обязательный
Идентификатор спринта
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 1
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: YOUR_ACCESS_TOKEN" \
-d '{
"id": 1
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.delete
// 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.sprint.delete',
params: {
id: 1,
},
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('Sprint deleted:', 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 deleteSprint() {
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.delete',
params: {
id: 1,
},
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('Sprint deleted:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteSprint)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.sprint.delete(
bitrix_id=1,
).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.sprint.delete',
[
'id' => $sprintId
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting sprint: ' . $e->getMessage();
}
const sprintId = 1;
BX24.callMethod(
'tasks.api.scrum.sprint.delete',
{
id: sprintId
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.sprint.delete',
[
'id' => 1,
]
);
// Обработка ответа от Битрикс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.delete", b24.Params{
"id": 1,
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.sprint.delete: %w", err)
}
// Ответ — список; разберите его в структуру под форму ответа ниже.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result" : []
}
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Sprint not found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Access denied |
Нет доступа к Скраму |
0 |
Sprint not found |
Такого спринта не существует |
0 |
It is forbidden remove a sprint with items |
Нельзя удалить спринт, в котором есть задачи |
0 |
Sprint items have not been moved to backlog |
Не удалось переместить задачи из спринта в бэклог |
100 |
Could not find value for parameter {id} |
Неверно указано имя параметра или не задан параметр |
100 |
Invalid value {stringValue} to match with parameter {id}. Should be value of type int |
Неверный тип параметра |

