tasks.api.scrum.epic.get
Получить поля эпика по его идентификатору
Описание
Метод получает значения полей эпика по его идентификатору id.
Параметры
id
integer
обязательный
Идентификатор эпика.
Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/tasks.api.scrum.epic.get
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":1,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/tasks.api.scrum.epic.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 } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of the payload returned in result (match the "response handling" section of the page)
type EpicGetResult = {
id: number
groupId: number
name: string
description: string
createdBy: number
modifiedBy: number
color: string
files: Record<string, unknown>
}
try {
const response = await $b24.actions.v2.call.make<EpicGetResult>({
method: 'tasks.api.scrum.epic.get',
params: {
id: 1,
},
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.color)
}
} 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 getEpic() {
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.epic.get',
params: {
id: 1,
},
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.color)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getEpic)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.tasks.api.scrum.epic.get(
bitrix_id=1,
).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 {
$epicId = 1;
$response = $b24Service
->core
->call(
'tasks.api.scrum.epic.get',
[
'id' => $epicId,
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting epic: ' . $e->getMessage();
}
const epicId = 1;
BX24.callMethod(
'tasks.api.scrum.epic.get',
{
id: epicId,
},
function(res)
{
console.log(res);
}
);
require_once('crest.php');
$result = CRest::call(
'tasks.api.scrum.epic.get',
[
'id' => 1
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.api.scrum.epic.get", b24.Params{
"id": 1,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("tasks.api.scrum.epic.get: %w", err)
}
// Ответ приходит как json.RawMessage — разберите его
// в структуру под форму ответа, показанную ниже на этой странице.
fmt.Printf("%s\n", res.Result)
Ответ
HTTP-статус: 200
{
"id": 1,
"groupId": 143,
"name": "эпик",
"description": "",
"createdBy": 1,
"modifiedBy": 0,
"color": "#69dafc",
"files": {
"ID": "136",
"ENTITY_ID": "TASKS_SCRUM_EPIC",
"FIELD_NAME": "UF_SCRUM_EPIC_FILES",
"USER_TYPE_ID": "disk_file",
"XML_ID": null,
"SORT": "100",
"MULTIPLE": "Y",
"MANDATORY": "N",
"SHOW_FILTER": "N",
"SHOW_IN_LIST": "N",
"EDIT_IN_LIST": "N",
"IS_SEARCHABLE": "N",
"SETTINGS": {
"IBLOCK_ID": null,
"SECTION_ID": null,
"UF_TO_SAVE_ALLOW_EDIT": false
},
"USER_TYPE": {
"USER_TYPE_ID": "disk_file",
"CLASS_NAME": "Bitrix\\Disk\\Uf\\FileUserType",
"DESCRIPTION": "Файл (Диск)",
"BASE_TYPE": "int",
"TAG": [
"DISK FILE ID",
"DOCUMENT ID"
]
},
"VALUE": [],
"ENTITY_VALUE_ID": 1,
"CUSTOM_DATA": {
"PHOTO_TEMPLATE": ""
},
"EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES",
"TAG": "DOCUMENT ID"
}
}
Возвращаемые данные
id
integer
Идентификатор эпика
groupId
integer
Идентификатор группы (скрама), к которой привязан эпик
name
string
Название эпика
description
string
Описание эпика
createdBy
integer
Идентификатор пользователя, создавшего эпик
modifiedBy
integer
Идентификатор пользователя, который последним изменял эпик
color
string
Цвет эпика в формате HEX
files
object
Объект с данными обо всех файлах, прикрепленных к эпику
Обработка ошибок
HTTP-статус: 400
{
"error": 0,
"error_description": "Access denied"
}
| Код | Описание | Значение |
|---|---|---|
0 |
Access denied | Нет доступа для просмотра данных эпика |
0 |
Epic 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. | Неверный тип параметра |

