Блог Горошко Андрея Bitrix24,PHP Получить поля эпика по его идентификатору tasks.api.scrum.epic.get

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

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить поля эпика по его идентификатору tasks.api.scrum.epic.get», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

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

  • структура параметра files относится к модулю Диск, поэтому здесь не описана. Нужно сделать ссылку, когда появится описание структуры в документации

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

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

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

Название
тип
Описание
id*
integer
Идентификатор эпика.

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

Примеры кода

  • cURL (Webhook)
    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_webbhook_here**/tasks.api.scrum.epic.get
  • cURL (OAuth)
    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
  • JS
    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);
    }
  • PHP
    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();
    }
  • BX24.js
    const epicId = 1;
    BX24.callMethod(
        'tasks.api.scrum.epic.get',
        {
            id: epicId,
        },
        function(res)
        {
            console.log(res);
        }
    );
  • PHP CRest
    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"
}

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

КодОписаниеЗначение
0Access deniedНет доступа для просмотра данных эпика
0Epic not foundТакого эпика не существует
100Could not find value for parameter {id}Неверно указано имя параметра или не задан параметр
100Invalid value {stringValue} to match with parameter {id}. Should be value of type int.Неверный тип параметра
  • [](./index)
  • [](./tasks-api-scrum-epic-add)
  • [](./tasks-api-scrum-epic-update)
  • [](./tasks-api-scrum-epic-list)
  • [](./tasks-api-scrum-epic-delete)
  • [](./tasks-api-scrum-epic-get-fields)

💡 Экспертное мнение и рекомендации

Советы эксперта по интеграции:

  • Всегда используйте кэширование при частых запросах к tasks.api.scrum.epic.get, чтобы разгрузить базу данных.
  • Соблюдайте стандарты PSR при написании обработчиков для «Получить поля эпика по его идентификатору tasks.api.scrum.epic.get».
  • Регулярно проводите аудит производительности системы с помощью встроенного монитора 1С-Битрикс.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Как использовать Csite::Update() в 1С-Битрикс: пример кодаКак использовать Csite::Update() в 1С-Битрикс: пример кода

Каждый PHP-разработчик, работающий с экосистемой Bitrix Framework, должен глубоко понимать работу её ключевых компонентов. В этой статье мы проведем подробный аудит темы «Как использовать Csite::Update() в 1С-Битрикс: пример кода», проанализируем

Событие при изменении реквизита onCrmRequisiteUpdateСобытие при изменении реквизита onCrmRequisiteUpdate

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Событие при изменении реквизита onCrmRequisiteUpdate». Вы узнаете экспертные методики работы с событие изменении

Внедрение и настройка Битрикс24 CRM под ключ для отдела продажВнедрение и настройка Битрикс24 CRM под ключ для отдела продаж

Профессиональная настройка и внедрение Битрикс24 CRM позволяет систематизировать работу отдела продаж, исключить потерю лидов и автоматизировать ключевые бизнес-процессы компании. Услуга «Внедрение и настройка Битрикс24 CRM под ключ для отдела продаж»