Полная справочная информация по API для управления пользовательскими полями в Blue - создавайте, настраивайте и используйте пользовательские поля для расширения вашей структуры данных

Copy page in markdown for LLMs

Обзор

Пользовательские поля позволяют вам расширить стандартную структуру записей Blue дополнительными полями данных, специфичными для ваших бизнес-потребностей. Они предоставляют мощный способ захвата структурированных данных, выходящих за рамки встроенных полей, таких как заголовок, описание и срок выполнения.

Пользовательские поля определяются на уровне проекта и могут использоваться во всех записях (делах) внутри этого проекта. Каждое поле имеет определенный тип, который определяет его правила валидации, формат ввода и поведение отображения.

Доступные операции

Управление основными полями

Операция Описание Ссылка
List Custom Fields Запрос и фильтрация пользовательских полей View Details →
Create Custom Field Добавление новых пользовательских полей в проекты View Details →
Delete Custom Field Удаление пользовательских полей с надлежащей очисткой View Details →

Значения полей

Операция Описание Ссылка
Set Field Values Установка и обновление значений пользовательских полей в записях View Details →

Типы пользовательских полей

Текстовые поля

Тип Описание Сценарии использования Ссылка
TEXT_SINGLE Ввод текста в одну строку Names, titles, short descriptions View Details →
TEXT_MULTI Многострочное текстовое поле Длинные описания, заметки, комментарии View Details →

Поля выбора

Тип Описание Сценарии использования Ссылка
SELECT_SINGLE Выпадающий список с одиночным выбором Status, priority, category View Details →
SELECT_MULTI Выпадающий список с множественным выбором Tags, skills, categories View Details →
CHECKBOX Поле с булевым флажком Flags, approvals, confirmations View Details →

Числовые поля

Тип Описание Сценарии использования Ссылка
NUMBER Числовой ввод Quantities, scores, measurements View Details →
CURRENCY Сумма в валюте Budgets, costs, pricing View Details →
PERCENT Процентное значение Completion rates, discounts View Details →
RATING Оценка по шкале звезд Performance ratings, satisfaction View Details →
FORMULA Вычисляемое поле на основе других полей Totals, computations, aggregations View Details →

Поля контактов

Тип Описание Сценарии использования Ссылка
EMAIL Адрес электронной почты с валидацией Контактная информация, уведомления View Details →
PHONE Номер телефона с международным форматом Contact details, emergency contacts View Details →
URL Веб-URL с валидацией Links, references, resources View Details →

Поля даты и времени

Тип Описание Сценарии использования Ссылка
DATE Выбор даты Deadlines, milestones, events View Details →
TIME_DURATION Поле для отслеживания времени Work hours, duration estimates View Details →

Местоположение и география

Тип Описание Сценарии использования Ссылка
LOCATION Географическое местоположение (широта/долгота) Addresses, venues, service areas View Details →
COUNTRY Выбор страны Regional assignments, localization View Details →

Файлы и медиа

Тип Описание Сценарии использования Ссылка
FILE Вложение файла Documents, images, resources View Details →

Системные поля

Тип Описание Сценарии использования Ссылка
UNIQUE_ID Автоматически сгенерированный уникальный идентификатор Ticket numbers, order IDs View Details →
REFERENCE Ссылка на записи в другом проекте Cross-project relationships View Details →
LOOKUP Извлечение данных из ссылочных записей Aggregate data from related records View Details →

Интерактивные поля

Тип Описание Сценарии использования Ссылка
BUTTON Поле с кнопкой действия Triggers, actions, workflows View Details →
CURRENCY_CONVERSION Поле для конверсии валюты Multi-currency calculations View Details →

Ключевые концепции

Определение поля

  • Пользовательские поля определяются на уровне проекта
  • Каждое поле имеет уникальное имя и тип
  • Поля могут включать правила и ограничения валидации
  • Опции конфигурации варьируются в зависимости от типа поля

Значения полей

  • Значения хранятся в отдельных записях (делах)
  • Каждая запись может иметь разные значения для одного и того же поля
  • Пустые/нулевые значения допускаются для необязательных полей
  • Значения проверяются в соответствии с правилами типа поля

Модель разрешений

Пользовательские поля учитывают разрешения на уровне проекта:

Роль Создание полей Редактирование полей* Установка значений Просмотр значений
OWNER ✅ Да ✅ Да ✅ Да ✅ Да
ADMIN ✅ Да ✅ Да ✅ Да ✅ Да
MEMBER ❌ Нет ❌ Нет ✅ Да ✅ Да
CLIENT ❌ Нет ❌ Нет ✅ Ограничено ✅ Ограничено

*Редактирование полей относится к изменению настроек поля (имя, тип, опции, правила валидации) - не к установке значений полей в записях

Разрешения для пользовательских ролей

  • Проекты могут иметь пользовательские роли с разрешениями, специфичными для полей
  • Поля могут быть помечены как редактируемые/не редактируемые для каждой роли
  • Пользовательские роли могут ограничивать доступ к конкретным полям

Общие шаблоны

Создание базового пользовательского поля

mutation CreateCustomField {
  createCustomField(input: {
    name: "Priority Level"
    type: SELECT_SINGLE
    description: "Task priority level"
    customFieldOptions: [
      { title: "Low", color: "#28a745" }
      { title: "Medium", color: "#ffc107" }
      { title: "High", color: "#fd7e14" }
      { title: "Critical", color: "#dc3545" }
    ]
  }) {
    id
    name
    type
    customFieldOptions {
      id
      title
      color
    }
  }
}

Установка значений полей в записях

mutation SetFieldValue {
  setTodoCustomField(input: {
    todoId: "todo_123"
    customFieldId: "field_456"
    customFieldOptionId: "option_789"  # For SELECT_SINGLE
  })
}

Запрос записей с пользовательскими полями

query GetTodosWithCustomFields {
  todos(projectId: "project_123") {
    id
    title
    customFields {
      id
      customField {
        name
        type
      }
      # Type-specific value fields
      text           # TEXT_SINGLE, TEXT_MULTI, EMAIL, etc.
      number         # NUMBER, CURRENCY, PERCENT, RATING
      selectedOption # SELECT_SINGLE
      selectedOptions # SELECT_MULTI
      checked        # CHECKBOX
      date           # DATE
    }
  }
}

Создание записей с значениями пользовательских полей

mutation CreateTodoWithCustomFields {
  createTodo(input: {
    title: "New task"
    todoListId: "list_123"
    customFields: [
      { customFieldId: "priority_field", value: "high_priority_option" }
      { customFieldId: "budget_field", value: "5000" }
      { customFieldId: "notes_field", value: "Additional context here" }
    ]
  }) {
    id
    title
    customFields {
      customField { name }
      value
    }
  }
}

Лучшие практики

Дизайн полей

  1. Используйте описательные названия - Сделайте цели полей ясными
  2. Выбирайте подходящие типы - Соответствуйте тип поля требованиям к данным
  3. Устанавливайте правила валидации - Используйте минимальные/максимальные значения, обязательные поля
  4. Организуйте логически - Группируйте связанные поля вместе

Учет производительности

  1. Ограничьте количество полей - Слишком много полей может повлиять на производительность
  2. Используйте пагинацию - При запросе больших наборов данных
  3. Индексируйте ключевые поля - Для полей, используемых в фильтрации/сортировке
  4. Избегайте глубокого вложения - Держите отношения между полями простыми

Качество данных

  1. Проверяйте ввод - Используйте подходящие типы полей с валидацией
  2. Предоставляйте значения по умолчанию - Устанавливайте разумные значения по умолчанию, где это уместно
  3. Используйте единообразные форматы - Стандартизируйте шаблоны ввода данных
  4. Регулярная очистка - Удаляйте неиспользуемые поля и опции

Пользовательский опыт

  1. Ясные описания - Предоставляйте полезные описания полей
  2. Логичный порядок - Расположите поля в естественном порядке рабочего процесса
  3. Визуальная иерархия - Эффективно используйте цвета и форматирование
  4. Постепенное раскрытие - Показывайте поля, когда это актуально

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

Распространенные ошибки при работе с пользовательскими полями:

Код ошибки Описание Решение
CUSTOM_FIELD_NOT_FOUND Поле не существует Verify field ID and project access
VALIDATION_ERROR Значение не соответствует типу поля Check format and validation rules
UNAUTHORIZED Недостаточно разрешений Ensure proper role level
CUSTOM_FIELD_VALUE_PARSE_ERROR Неверный формат значения Review field type requirements

Связанные ресурсы

AI Ассистент

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

Как я могу вам помочь?

Спросите меня о чем угодно, связанном с Blue или этой документацией.

Введите для отправки • Shift+Enter для новой строки • ⌘I для открытия