tasks.api.scrum.backlog.delete
Удалить бэклог
Описание
Метод tasks.api.scrum.backlog.delete удаляет бэклог.
В обычной ситуации удалять бэклог не нужно. При удалении бэклога Битрикс24 автоматически создаст его заново при открытии страницы планирования в задачах Скрама.
Метод используется, если бэклог ошибочно добавлен в группу или проект, которые не являются скрамом.
Параметры
id
integer
обязательный
Идентификатор бэклога.
Можно получить методом создания бэклога tasks.api.scrum.backlog.add или методом получения полей бэклога по идентификатору Скрама tasks.api.scrum.backlog.get
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id": 1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.backlog.delete
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id": 1, "auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.backlog.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<unknown[]>({
method: 'tasks.api.scrum.backlog.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('Backlog deleted successfully, result:', 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 deleteBacklog() {
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.backlog.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('Backlog deleted successfully, result:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', deleteBacklog)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.backlog.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.backlog.delete',
[
'id' => 1
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
echo 'Error: ' . $result->error();
} else {
echo 'Success: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error deleting backlog item: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.backlog.delete',
{
"id": 1
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.backlog.delete',
[
'id' => 1,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.backlog.delete", b24.Params{
"id": 1,
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.backlog.delete: %w", err)
}
// Ответ — список; разберите его в структуру под форму ответа ниже.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"result": [],
"time":{
"start":1712137817.343984,
"finish":1712137817.605804,
"duration":0.26182007789611816,
"processing":0.018325090408325195,
"date_start":"2024-04-03T12:50:17+03:00",
"date_finish":"2024-04-03T12:50:17+03:00"
}
}
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Access denied"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Backlog id not found | Не передан идентификатор бэклога id |
0 |
Backlog not found | Ошибка возникает при попытке удаления несуществующего бэклога |
0 |
Access denied | Отсутствуют соответствующие права доступа |
0 |
It is forbidden remove a backlog with items | Нельзя удалить бэклог, если в нем есть задачи |
0 |
Backlog not deleted | Не удалось удалить бэклог |
0 |
Unknown error | Другая ошибка |

