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

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

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

Scope: task

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

Метод получает значения полей эпика по его идентификатору 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
        
try
        {
        	const epicId = 1;
        	const response = await $b24.callMethod(
        		'tasks.api.scrum.epic.get',
        		{
        			id: epicId,
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log(result);
        }
        catch( error )
        {
        	console.error('Error:', 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>';

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

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"
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

0

Access denied

Нет доступа для просмотра данных эпика

0

Epic not found

Такого эпика не существует

100

Could not find value for parameter

Неверно указано имя параметра или не задан параметр

100

Invalid value {stringValue} to match with parameter {id}. Should be value of type int.

Неверный тип параметра

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

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

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

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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

Предыдущая
Обновить эпик в Скраме
Следующая
Получить список эпиков