tasks.api.scrum.backlog.add
Добавить бэклог в Скрам
Описание
Метод tasks.api.scrum.backlog.add добавляет бэклог в Скрам.
Может понадобиться, чтобы создать бэклог при импорте после создания Скрама.
Параметры
fields
object
обязательный
Объект содержащий записи о группе и пользователе (подробное описание приведено ниже) в виде структуры:
"fields": {
"groupId": значение,
"createdBy": значение,
"modifiedBy": значение,
}Параметр fields
groupId
integer
обязательный
Идентификатор группы, для которой создается бэклог.
Идентификатор группы можно получить при создании новой группы sonet_group.create или при получении списка существующих групп socialnetwork.api.workgroup.list
createdBy
integer
необязательный
Идентификатор пользователя, от кого будет создан бэклог
modifiedBy
integer
необязательный
Идентификатор пользователя, от кого будет модифицирован бэклог
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {"groupId": 1, "createdBy": 1}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.backlog.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields": {"groupId": 1, "createdBy": 1}, "auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.backlog.add
// 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 BacklogAddResult = {
id: number
groupId: number
createdBy: number
modifiedBy: number
}
try {
const response = await $b24.actions.v2.call.make<BacklogAddResult>({
method: 'tasks.api.scrum.backlog.add',
params: {
fields: {
groupId: 125,
createdBy: 6,
},
},
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 created:', result.id, 'for group:', result.groupId)
}
} 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 addBacklog() {
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.add',
params: {
fields: {
groupId: 125,
createdBy: 6,
},
},
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 created:', result.id, 'for group:', result.groupId)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', addBacklog)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.backlog.add(
fields={
"groupId": 125,
"createdBy": 6,
},
).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.add',
[
'fields' => [
'groupId' => 125,
'createdBy' => 6,
],
]
);
$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 adding backlog: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.backlog.add',{
"fields": {
"groupId": 125,
"createdBy": 6,
},
},
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.add',
[
'fields' => [
'groupId' => 1,
'createdBy' => 1,
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.backlog.add", b24.Params{
"fields": b24.Params{
"groupId": 1,
"createdBy": 1,
},
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.backlog.add: %w", err)
}
var item struct {
ID b24.ID `json:"id"`
GroupID b24.ID `json:"groupId"`
CreatedBy int `json:"createdBy"`
ModifiedBy int `json:"modifiedBy"`
}
if err := json.Unmarshal(res.Result, &item); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println(item.ID, item.GroupID)
Ответ
HTTP-статус: 200
{
"result": {
"id": 1,
"groupId": 125,
"createdBy": 6,
"modifiedBy": 0
},
"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 |
Group id not found | Не передан идентификатор группы groupId |
0 |
Backlog already added | Ошибка возникает при попытке создания бэклога, если в группе уже существует активный бэклог |
0 |
Access denied | Отсутствуют соответствующие права доступа |
0 |
createdBy user not found | Переданный идентификатор пользователя невалидный. Например, пользователя с таким идентификатором не существует |
0 |
modifiedBy user not found | Переданный идентификатор пользователя невалидный. Например, пользователя с таким идентификатором не существует |
0 |
Unable to add backlog | Не удалось создать бэклог |
0 |
Unknown error | Другая ошибка |

