Получить поля эпика по его идентификатору tasks.api.scrum.epic.get

Выберите инструмент для разработки с AI-агентом:

используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: task

Кто может выполнять метод: любой пользователь, имеющий доступ к Скраму

Метод получает значения полей эпика по его идентификатору id.

Параметры метода

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор эпика.

Получить идентификаторы эпиков можно методом tasks.api.scrum.epic.list

withFiles
boolean

Вернуть ли файлы эпика в поле files. По умолчанию true.

Чтобы получить эпик без файлов, передайте false или 0

Внимание

Строки "false" и "N" в withFiles метод считает значением true и возвращает файлы. Передавайте булево false в JSON-запросе или 0

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

JS (TS)

JS (UMD)

Python

PHP

BX24.js

PHP CRest

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

{
    "result": {
        "id": 2,
        "groupId": 2,
        "name": "Регистрация пользователей",
        "description": "Форма входа, регистрация и восстановление пароля",
        "createdBy": 1,
        "modifiedBy": 1,
        "color": "#69dafc",
        "files": {
            "ID": "60",
            "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": [
                6
            ],
            "ENTITY_VALUE_ID": 2,
            "VALUE_EXISTS": true,
            "VALUE_RAW": "a:1:{i:0;i:6;}",
            "CUSTOM_DATA": {
                "PHOTO_TEMPLATE": ""
            },
            "EDIT_FORM_LABEL": "UF_SCRUM_EPIC_FILES",
            "TAG": "DOCUMENT ID"
        }
    },
    "time": {
        "start": 1790263942,
        "finish": 1790263942.418237,
        "duration": 0.4182369709014893,
        "processing": 0,
        "date_start": "2026-09-24T18:32:22+03:00",
        "date_finish": "2026-09-24T18:32:22+03:00",
        "operating_reset_at": 1790264542,
        "operating": 0
    }
}

Возвращаемые данные

Название `тип`	Описание
result `object`	Данные эпика (подробное описание)
time `time`	Информация о времени выполнения запроса

Объект result

Название `тип`	Описание
id `integer`	Идентификатор эпика
groupId `integer`	Идентификатор Скрама, к которому относится эпик
name `string`	Название эпика
description `string`	Описание эпика
createdBy `integer`	Идентификатор пользователя, создавшего эпик
modifiedBy `integer`	Идентификатор пользователя, который последним изменил эпик. Если эпик не меняли — `0`
color `string`	Цвет эпика
files `object`	Файлы эпика в виде пользовательского поля `UF_SCRUM_EPIC_FILES` (подробное описание)

Объект files

Нужные данные о файлах лежат в поле VALUE. Остальные поля объекта — служебное описание пользовательского поля.

Название `тип`	Описание
VALUE `array`	Идентификаторы файлов, прикрепленных к эпику. Это идентификаторы привязок, а не файлов Диска: получить имя файла, ссылку на скачивание и идентификатор файла Диска `OBJECT_ID` можно методом disk.attachedObject.get. Если файлов нет — пустой массив
VALUE_EXISTS `boolean`	Приходит со значением `true`, если к эпику прикреплены файлы. Если файлов нет, этого поля в ответе нет
FIELD_NAME `string`	Код пользовательского поля, всегда `UF_SCRUM_EPIC_FILES`
USER_TYPE_ID `string`	Тип пользовательского поля, всегда `disk_file`
ENTITY_VALUE_ID `integer`	Идентификатор эпика
VALUE_RAW `string`	Значение `VALUE` в сериализованном виде PHP. Если файлов нет, этого поля в ответе нет

Остальные поля описывают настройки самого пользовательского поля UF_SCRUM_EPIC_FILES. Они одинаковы у всех эпиков и не зависят от прикрепленных файлов:

Название `тип`	Описание
ID `string`	Идентификатор пользовательского поля
ENTITY_ID `string`	Объект, к которому относится поле, всегда `TASKS_SCRUM_EPIC`
XML_ID `string` \| `null`	Внешний код поля. У поля файлов эпика — `null`
SORT `string`	Порядок сортировки поля
MULTIPLE `string`	Множественное ли поле, всегда `Y`
MANDATORY `string`	Обязательное ли поле, всегда `N`
SHOW_FILTER, SHOW_IN_LIST, EDIT_IN_LIST, IS_SEARCHABLE `string`	Настройки показа поля в интерфейсе, `Y` или `N`
SETTINGS `object`	Настройки поля: `IBLOCK_ID`, `SECTION_ID`, `UF_TO_SAVE_ALLOW_EDIT`
USER_TYPE `object`	Описание типа поля: `USER_TYPE_ID`, `CLASS_NAME`, `DESCRIPTION`, `BASE_TYPE`, `TAG`
CUSTOM_DATA `object`	Дополнительные данные типа поля
EDIT_FORM_LABEL `string`	Подпись поля в форме редактирования
TAG `string`	Метка типа поля, `DOCUMENT ID`

Обработка ошибок

HTTP-статус: 400

{
    "error": "0",
    "error_description": "Access denied"
}

Название `тип`	Описание
error `string`	Строковый код ошибки. Состоит из цифр, латинских букв и знака подчеркивания. Может прийти пустым — тогда причину показывает только `error_description`
error_description `string`	Текст ошибки для разработчика. Не показывайте его конечному пользователю без обработки

Возможные коды ошибок

Статус	Код	Описание	Значение
`400`	`0`	Epic not found	Эпика с таким `id` не существует
`400`	`0`	Access denied	У пользователя нет доступа к задачам группы, к которой относится эпик
`400`	`100`	Could not find value for parameter	Не передан параметр `id`
`400`	`100`	Invalid value {stringValue} to match with parameter {id}. Should be value of type int.	В `id` передано не число

Статусы и коды системных ошибок

HTTP-статус: 4xx, 5xx

Описанные ниже ошибки возвращает сам REST API, а не логика конкретного метода. Они могут прийти в ответ на любой метод.

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Сервер вернул неожиданный ответ. Повторите вызов, а если ошибка сохраняется, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`429`	`OPERATION_TIME_LIMIT` Method is blocked due to operation time limit	Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически, когда накопленное время выполнения метода перестает превышать лимит
`401`	`NO_AUTH_FOUND` Wrong authorization data	В запросе нет авторизационных данных: не передан ни access-токен, ни код вебхука
`401`	`INVALID_REQUEST` Https required	Методы вызываются только по протоколу HTTPS
`401`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка. Чтобы ее снять, обратитесь в техническую поддержку Битрикс24
`401`	`ACCESS_DENIED` REST is available only on commercial plans	REST API доступен только на коммерческих тарифах. У вебхука текст ошибки другой — `REST is available only by subscription`
`401`	`INVALID_CREDENTIALS` Invalid request credentials	Не найден активный вебхук с указанным идентификатором пользователя и секретным кодом
`404`	`ERROR_METHOD_NOT_FOUND` Method not found!	Метод с таким именем не найден. Имя написано с ошибкой, метода нет в REST API или он недоступен без нужного скоупа
`401`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более широких прав, чем есть у токена: у вебхука это выданные ему права, у приложения — скоуп. У приложения текст ошибки заканчивается на `provided by the access token`
`401`	`expired_token` The access token provided has expired	Срок действия access-токена истек
`401`	`user_access_error` The user does not have access to the application	Приложение установлено, но администратор Битрикс24 открыл доступ к нему только конкретным пользователям
`403`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть ее на коробочной установке, отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Была ли статья полезна?

Обновить эпик в Скраме

Получить список эпиков

Получить поля эпика по его идентификатору tasks.api.scrum.epic.get

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект resultОбъект result

Объект filesОбъект files

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение