tasks.api.scrum.sprint.get
Получить поля спринта по его идентификатору
Описание
Метод tasks.api.scrum.sprint.get возвращает значения полей спринта по его идентификатору.
Параметры
sprintId
integer
обязательный
Идентификатор спринта.
Идентификатор можно получить методом tasks.api.scrum.sprint.list
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.get
curl -X POST \
-H "Content-Type: application/json" \
-d '{
"id": 2,
"auth": "YOUR_ACCESS_TOKEN"
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.get
// 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, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type SprintGetResult = {
id: number
groupId: number
entityType: string
name: string
goal: string
sort: number
createdBy: number
modifiedBy: number
dateStart: ISODate | null
dateEnd: ISODate | null
status: string
}
try {
const response = await $b24.actions.v2.call.make<SprintGetResult>({
method: 'tasks.api.scrum.sprint.get',
params: {
id: 2,
},
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(result.id, result.name, result.status)
}
} 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 getSprintById() {
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.get',
params: {
id: 2,
},
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(result.id, result.name, result.status)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSprintById)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.sprint.get(
bitrix_id=2,
).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 {
$sprintId = 2;
$response = $b24Service
->core
->call(
'tasks.api.scrum.sprint.get',
[
'id' => $sprintId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Нужная вам логика обработки данных
processData($result);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sprint data: ' . $e->getMessage();
}
const sprintId = 2;
BX24.callMethod(
'tasks.api.scrum.sprint.get',
{
id: sprintId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
$sprintId = 2;
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.sprint.get',
[
'id' => $sprintId
]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
Ответ
HTTP-статус: 200
{
"result":
{
"id": 2,
"groupId": 143,
"entityType": "sprint",
"name": "Спринт 1",
"goal": "",
"sort": 1,
"createdBy": 1,
"modifiedBy": 1,
"dateStart": "2024-07-19T15:03:01+00:00",
"dateEnd": "2024-08-02T15:03:01+00:00",
"status": "planned"
}
}
Возвращаемые данные
result
object
Объект, содержащий данные о спринте
id
integer
Идентификатор спринта
groupId
integer
Идентификатор группы (Скрама), к которой относится спринт
entityType
string
Тип сущности (в данном случае sprint)
name
string
Название спринта
goal
string
Цель спринта. Устанавливается только в интерфейсе при запуске спринта
sort
integer
Сортировка
createdBy
integer
Идентификатор пользователя, создавшего спринт
modifiedBy
integer
Идентификатор пользователя, изменившего спринт
dateStart
string
Дата начала спринта в формате ISO 8601
dateEnd
string
Дата окончания спринта в формате ISO 8601
status
string
Статус спринта
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Sprint not found"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Access denied |
Нет доступа для просмотра данных спринта |
0 |
Sprint not found |
Такого спринта не существует |
100 |
Could not find value for parameter {id} |
Неверно указано имя параметра или не задан параметр |
100 |
Invalid value {stringValue} to match with parameter {id}. Should be value of type int |
Неверный тип параметра |

