tasks.api.scrum.kanban.updateStage
Обновить стадию канбана Скрама
Описание
Метод изменяет стадию канбана Скрама.
Параметры
stageId
integer
обязательный
Идентификатор стадии. Получить идентификатор можно при помощи метода tasks.api.scrum.kanban.getStages
fields
object
обязательный
Поля, соответствующие доступному списку полей tasks.api.scrum.kanban.getFields (подробное описание приведено ниже)
Параметр fields
sprintId
integer
необязательный
Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list
name
string
необязательный
Название стадии канбана
type
string
необязательный
Тип стадии канбана. Возможные значения: NEW, WORK, FINISH
sort
integer
необязательный
Порядок сортировки. Значение поля должно быть кратно 100
color
string
необязательный
Цвет стадии канбана
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"stageId":65,"fields":{"name":"Обновленная стадия","type":"WORK","color":"00C4FB","sort":100}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.updateStage
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"stageId":65,"fields":{"name":"Обновленная стадия","type":"WORK","color":"00C4FB","sort":100},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.updateStage
// 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.kanban.updateStage',
params: {
stageId: 65,
fields: {
name: 'Updated stage',
type: 'WORK',
color: '00C4FB',
sort: 100,
},
},
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('Stage updated:', 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 updateKanbanStage() {
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.kanban.updateStage',
params: {
stageId: 65,
fields: {
name: 'Updated stage',
type: 'WORK',
color: '00C4FB',
sort: 100,
},
},
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('Stage updated:', result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', updateKanbanStage)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.kanban.update_stage(
stage_id=65,
fields={
"name": "Updated stage",
"type": "WORK",
"color": "00C4FB",
"sort": 100,
},
).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.kanban.updateStage',
[
'stageId' => 65,
'fields' => [
'name' => 'Обновленная стадия',
'type' => 'WORK',
'color' => '00C4FB',
'sort' => 100,
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error updating stage: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.kanban.updateStage',
{
"stageId": 65,
"fields": {
"name": "Обновленная стадия",
"type": "WORK",
"color": "00C4FB",
"sort": 100,
},
},
function(result) {
if (result.error()) {
console.error(result.error());
} else {
console.info(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.kanban.updateStage',
[
'stageId' => 65,
'fields' => [
'name' => 'Обновленная стадия',
'type' => 'WORK',
'sort' => 100,
'color' => '00C4FB',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.kanban.updateStage", b24.Params{
"stageId": 65,
"fields": b24.Params{
"name": "Обновленная стадия",
"type": "WORK",
"color": "00C4FB",
"sort": 100,
},
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.kanban.updateStage: %w", err)
}
var ok bool
if err := json.Unmarshal(res.Result, &ok); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
fmt.Println("выполнено:", ok)
Ответ
HTTP-статус: 200
{
"result": true,
"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":"Incorrect sprintId value"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Stage id not found |
Не заполнено обязательное поле stageId |
0 |
Stage not found |
Передан неизвестный идентификатор стадии stageId |
0 |
Incorrect sprintId value |
Передан неизвестный идентификатор спринта или нет доступа к спринту |
0 |
Access denied |
Доступ запрещен |
0 |
Неизвестная ошибка |

