tasks.api.scrum.kanban.getStages
Получить стадии канбана по идентификатору спринта
Описание
Метод возвращает стадии канбана по идентификатору спринта.
Параметры
sprintId
integer
обязательный
Идентификатор спринта. Получить идентификатор можно при помощи метода tasks.api.scrum.sprint.list
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"sprintId":5}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.kanban.getStages
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"sprintId":5,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.kanban.getStages
// 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 each KanbanStage returned in result[]
type KanbanStage = {
id: string
name: string
sort: string
type: 'NEW' | 'WORK' | 'FINISH'
sprintId: string
color: string
}
try {
const response = await $b24.actions.v2.call.make<KanbanStage[]>({
method: 'tasks.api.scrum.kanban.getStages',
params: {
sprintId: 5,
},
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('Kanban stages:', result.length, 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 getKanbanStages() {
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.getStages',
params: {
sprintId: 5,
},
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('Kanban stages:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getKanbanStages)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.kanban.get_stages(
sprint_id=5,
).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.getStages',
[
'sprintId' => 5,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting stages: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.kanban.getStages',
{
"sprintId": 5,
},
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.getStages',
[
'sprintId' => 5,
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.kanban.getStages", b24.Params{
"sprintId": 5,
})
if err != nil {
return fmt.Errorf("tasks.api.scrum.kanban.getStages: %w", err)
}
var items []struct {
ID b24.ID `json:"id"`
Name string `json:"name"`
Sort string `json:"sort"`
Type string `json:"type"`
SprintID b24.ID `json:"sprintId"`
Color string `json:"color"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID, it.Name)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"id": "58",
"name": "Новые",
"sort": "100",
"type": "NEW",
"sprintId": "5",
"color": "00C4FB"
},
{
"id": "59",
"name": "Выполняются",
"sort": "200",
"type": "WORK",
"sprintId": "5",
"color": "47D1E2"
},
{
"id": "60",
"name": "Сделаны",
"sort": "300",
"type": "FINISH",
"sprintId": "5",
"color": "75D900"
}
],
"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"
}
}
Возвращаемые данные
id
integer
Идентификатор стадии
name
string
Название стадии канбана
type
string
Тип стадии канбана. Возможные значения: NEW, WORK, FINISH
sort
integer
Порядок сортировки
color
string
Цвет стадии канбана
Обработка ошибок
HTTP-статус: 400
{
"error":0,
"error_description":"Sprint id not found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Sprint id not found |
Не заполнено обязательное поле sprintId |
0 |
Sprint not found |
Передан неизвестный идентификатор спринта sprintId |
0 |
Access denied |
Доступ запрещен |
0 |
Неизвестная ошибка |

