tasks.api.scrum.sprint.getFields
Получить список доступных полей спринта
Описание
Метод tasks.api.scrum.sprint.getFields возвращает доступные поля спринта.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-d '{
}' \
https://your-domain.bitrix24.com/rest/_USER_ID_/_CODE_/tasks.api.scrum.sprint.getFields
curl -X POST \
-H "Content-Type: application/json" \
-d '{
auth=YOUR_ACCESS_TOKEN
}' \
https://your-domain.bitrix24.com/rest/tasks.api.scrum.sprint.getFields
// 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
type FieldItem = {
type: string
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type SprintGetFieldsResult = {
fields: Record<string, FieldItem>
}
try {
const response = await $b24.actions.v2.call.make<SprintGetFieldsResult>({
method: 'tasks.api.scrum.sprint.getFields',
params: {},
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(Object.keys(result.fields), result.fields)
}
} 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 getSprintFields() {
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.getFields',
params: {},
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(Object.keys(result.fields), result.fields)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getSprintFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.sprint.get_fields().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.sprint.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting sprint fields: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.sprint.getFields',
{},
function(res)
{
console.log(res);
}
);
require_once('crest.php'); // подключение CRest PHP SDK
// выполнение запроса к REST API
$result = CRest::call(
'tasks.api.scrum.sprint.getFields',
[]
);
// Обработка ответа от Битрикс24
if ($result['error']) {
echo 'Error: '.$result['error_description'];
} else {
print_r($result['result']);
}
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.sprint.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.api.scrum.sprint.getFields: %w", err)
}
// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
return fmt.Errorf("в ответе нет ключа fields")
}
fmt.Printf("%s\n", raw)
Ответ
HTTP-статус: 200
{
"result":
{
"fields":
{
"groupId":
{
"type": "integer"
},
"name":
{
"type": "string"
},
"sort":
{
"type": "integer"
},
"createdBy":
{
"type": "integer"
},
"modifiedBy":
{
"type": "integer"
},
"dateStart":
{
"type": "string"
},
"dateEnd":
{
"type": "string"
},
"status":
{
"type": "string"
}
}
}
}
Возвращаемые данные
groupId
integer
Идентификатор группы (Скрама), к которой относится спринт
name
string
Название спринта
sort
integer
Сортировка
createdBy
integer
Идентификатор пользователя, создавшего спринт
modifiedBy
integer
Идентификатор пользователя, изменившего спринт
dateStart
string
Дата начала спринта в формате ISO 8601
dateEnd
string
Дата окончания спринта в формате ISO 8601
status
string
Статус спринта

