метод REST scope: task

tasks.task.getFields

Получить список полей

Кто может выполнять: любой пользователь

Описание

Метод tasks.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.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.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

// A single field descriptor and the map returned in result.fields
type TaskFieldDescription = {
  title: string | null
  type: string
  required?: boolean
  primary?: boolean
  default?: unknown
  values?: Record<string, string> | string[]
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type TaskFieldsResult = {
  fields: Record<string, TaskFieldDescription>
}

try {
  // tasks.task.getFields takes no parameters
  const response = await $b24.actions.v2.call.make<TaskFieldsResult>({
    method: 'tasks.task.getFields',
    params: {},
    requestId: Text.getUuidRfc4122() // optional unique tracking id for this request
  })

  // The payload is available only on a successful response
  if (!response.isSuccess) {
    console.error(response.getErrorMessages().join('; '))
  } else {
    const fields = response.getData()!.result.fields
    console.info(`Loaded ${Object.keys(fields).length} task 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 loadTaskFields() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      // tasks.task.getFields takes no parameters
      const response = await $b24.actions.v2.call.make({
        method: 'tasks.task.getFields',
        params: {},
        requestId: B24Js.Text.getUuidRfc4122() // optional unique tracking id for this request
      })

      // The payload is available only on a successful response
      if (!response.isSuccess) {
        console.error(response.getErrorMessages().join('; '))
        return
      }

      const fields = response.getData().result.fields
      console.info(`Loaded ${Object.keys(fields).length} task fields`)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', loadTaskFields)
</script>

from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.tasks.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.task.getFields',
            []
        );

    $result = $response
        ->getResponseData()
        ->getResult();

    echo 'Success: ' . print_r($result, true);
    processData($result);

} catch (Throwable $e) {
    error_log($e->getMessage());
    echo 'Error fetching task fields: ' . $e->getMessage();
}

BX24.callMethod(
    'tasks.task.getFields',
    {},
    function(result){
        console.info(result.data());
        console.log(result);
    }
);

require_once('crest.php');

$result = CRest::call(
    'tasks.task.getFields',
    []
);

echo '<PRE>';
print_r($result);
echo '</PRE>';

// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "tasks.task.getFields", nil, b24.WithIdempotent())
if err != nil {
	return fmt.Errorf("tasks.task.getFields: %w", err)
}

// Метод заворачивает ответ в объект с ключом "fields".
raw, ok := b24.Unwrap(res.Result, "fields")
if !ok {
	return fmt.Errorf("в ответе нет ключа fields")
}

fmt.Printf("%s\n", raw)

Ответ

HTTP-статус: 200

{
    "result": {
        "fields": {
            "ID": {
                "title": "ID",
                "type": "integer",
                "primary": true
            },
            "PARENT_ID": {
                "title": "ID базовой задачи",
                "type": "integer",
                "default": 0
            },
            "TITLE": {
                "title": "Название",
                "type": "string",
                "required": true
            },
            "DESCRIPTION": {
                "title": "Описание",
                "type": "string"
            },
            "MARK": {
                "title": "Оценка",
                "type": "enum",
                "values": {
                    "N": "Отрицательная",
                    "P": "Положительная"
                },
                "default": null
            },
            "PRIORITY": {
                "title": "Приоритет",
                "type": "enum",
                "values": {
                    "2": "Высокий",
                    "1": "Средний",
                    "0": "Низкий"
                },
                "default": 1
            },
            "STATUS": {
                "title": "Статус",
                "type": "enum",
                "values": {
                    "2": "Ждёт выполнения",
                    "3": "Выполняется",
                    "4": "Ожидает контроля",
                    "5": "Завершена",
                    "6": "Отложена"
                },
                "default": 2
            },
            "MULTITASK": {
                "title": "Множественная задача",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "NOT_VIEWED": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "REPLICATE": {
                "title": "Повторяемая задача",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "GROUP_ID": {
                "title": "Проект",
                "type": "integer",
                "default": 0
            },
            "STAGE_ID": {
                "title": "Стадия",
                "type": "integer",
                "default": 0
            },
            "SPRINT_ID": {
                "title": "Спринт",
                "type": "integer",
                "default": 0
            },
            "BACKLOG_ID": {
                "title": "Бэклог",
                "type": "integer",
                "default": 0
            },
            "CREATED_BY": {
                "title": "Постановщик",
                "type": "integer",
                "required": true
            },
            "CREATED_DATE": {
                "title": null,
                "type": "datetime"
            },
            "RESPONSIBLE_ID": {
                "title": "Исполнитель",
                "type": "integer",
                "required": true
            },
            "ACCOMPLICES": {
                "title": null,
                "type": "array"
            },
            "AUDITORS": {
                "title": null,
                "type": "array"
            },
            "CHANGED_BY": {
                "title": "Изменил",
                "type": "integer"
            },
            "CHANGED_DATE": {
                "title": "Дата изменения",
                "type": "datetime"
            },
            "STATUS_CHANGED_BY": {
                "title": "Изменил статус",
                "type": "integer"
            },
            "STATUS_CHANGED_DATE": {
                "title": "Дата изменения статуса",
                "type": "datetime"
            },
            "CLOSED_BY": {
                "title": "Закрыл задачу",
                "type": "integer",
                "default": null
            },
            "CLOSED_DATE": {
                "title": "Дата закрытия",
                "type": "datetime",
                "default": null
            },
            "ACTIVITY_DATE": {
                "title": null,
                "type": "datetime",
                "default": null
            },
            "DATE_START": {
                "title": "Дата начала",
                "type": "datetime",
                "default": null
            },
            "DEADLINE": {
                "title": "Крайний срок",
                "type": "datetime",
                "default": null
            },
            "START_DATE_PLAN": {
                "title": "Плановое начало",
                "type": "datetime",
                "default": null
            },
            "END_DATE_PLAN": {
                "title": "Плановое завершение",
                "type": "datetime",
                "default": null
            },
            "GUID": {
                "title": "GUID",
                "type": "string",
                "default": null
            },
            "XML_ID": {
                "title": "XML_ID",
                "type": "string",
                "default": null
            },
            "COMMENTS_COUNT": {
                "title": "Кол-во комментариев",
                "type": "integer",
                "default": 0
            },
            "SERVICE_COMMENTS_COUNT": {
                "title": null,
                "type": "integer",
                "default": 0
            },
            "NEW_COMMENTS_COUNT": {
                "title": null,
                "type": "integer",
                "default": 0
            },
            "ALLOW_CHANGE_DEADLINE": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "ALLOW_TIME_TRACKING": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "TASK_CONTROL": {
                "title": "Принять работу",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "ADD_IN_REPORT": {
                "title": "Добавить в отчет",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "FORKED_BY_TEMPLATE_ID": {
                "title": "Создано из шаблона",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "TIME_ESTIMATE": {
                "title": "Затраченое время",
                "type": "integer"
            },
            "TIME_SPENT_IN_LOGS": {
                "title": "Затраченое время из истории изменений",
                "type": "integer"
            },
            "MATCH_WORK_TIME": {
                "title": "Пропустить выходные дни",
                "type": "integer"
            },
            "FORUM_TOPIC_ID": {
                "title": "FORUM_TOPIC_ID",
                "type": "integer"
            },
            "FORUM_ID": {
                "title": "FORUM_ID",
                "type": "integer"
            },
            "SITE_ID": {
                "title": "SITE_ID",
                "type": "string"
            },
            "SUBORDINATE": {
                "title": "Задача подчиненного",
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": null
            },
            "FAVORITE": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": null
            },
            "EXCHANGE_MODIFIED": {
                "title": "EXCHANGE_MODIFIED",
                "type": "datetime",
                "default": null
            },
            "EXCHANGE_ID": {
                "title": "EXCHANGE_ID",
                "type": "integer",
                "default": null
            },
            "OUTLOOK_VERSION": {
                "title": "OUTLOOK_VERSION",
                "type": "integer",
                "default": null
            },
            "VIEWED_DATE": {
                "title": "Дата последнего просмотра",
                "type": "datetime"
            },
            "SORTING": {
                "title": "Индекс сортировки",
                "type": "double"
            },
            "DURATION_PLAN": {
                "title": "Затрачено (план)",
                "type": "integer"
            },
            "DURATION_FACT": {
                "title": "Затрачено (фактически)",
                "type": "integer"
            },
            "CHECKLIST": {
                "title": null,
                "type": "array"
            },
            "DURATION_TYPE": {
                "title": "DURATION_TYPE",
                "type": "enum",
                "values": [
                    "secs",
                    "mins",
                    "hours",
                    "days",
                    "weeks",
                    "monts",
                    "years"
                ],
                "default": "days"
            },
            "IS_MUTED": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "IS_PINNED": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "IS_PINNED_IN_GROUP": {
                "title": null,
                "type": "enum",
                "values": {
                    "Y": "Да",
                    "N": "Нет"
                },
                "default": "N"
            },
            "FLOW_ID": {
                "title": "Поток",
                "type": "integer",
                "default": 0
            },
            "UF_CRM_TASK": {
                "title": "Элементы CRM",
                "type": "crm"
            },
            "UF_TASK_WEBDAV_FILES": {
                "title": "Загрузить файлы",
                "type": "disk_file"
            },
            "UF_MAIL_MESSAGE": {
                "title": null,
                "type": "mail_message"
            },
            "UF_NEW_TASKS_FIELD": {
                "title": "Новое поле задач",
                "type": "string"
            }
        }
    },
    "time": {
        "start": 1758790899,
        "finish": 1758790899.809331,
        "duration": 0.809330940246582,
        "processing": 0,
        "date_start": "2025-09-25T12:01:39+03:00",
        "date_finish": "2025-09-25T12:01:39+03:00",
        "operating_reset_at": 1758791499,
        "operating": 0
    }
}

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

result object

Объект с описанием полей задачи

time time

Информация о времени выполнения запроса