метод REST
scope: task
tasks.api.scrum.task.getFields
Получить поля задачи Скрама
Описание
Метод tasks.api.scrum.task.getFields получает доступные поля задачи Скрама.
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.task.getFields
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.task.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 GetFieldsResult = {
fields: Record<string, FieldItem>
}
try {
const response = await $b24.actions.v2.call.make<GetFieldsResult>({
method: 'tasks.api.scrum.task.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 getFields() {
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.task.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', getFields)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.task.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.task.getFields',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting task fields: ' . $e->getMessage();
}
BX24.callMethod(
'tasks.api.scrum.task.getFields',
{},
function(res)
{
console.log(res);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.task.getFields',
[]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.task.getFields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.api.scrum.task.getFields: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"fields":
{
"entityId":
{
"type": "integer"
},
"storyPoints":
{
"type": "string"
},
"epicId":
{
"type": "integer"
},
"sort":
{
"type": "integer"
},
"createdBy":
{
"type": "integer"
},
"modifiedBy":
{
"type": "integer"
}
}
}
Возвращаемые данные
entityId
integer
Идентификатор бэклога или спринта
storyPoints
string
Стори Поинты (относительная оценка сложности задачи).
Может иметь строковое значение
epicId
integer
Идентификатор эпика
sort
integer
Сортировка
createdBy
integer
Кем создана задача
modifiedBy
integer
Кем изменена задача

