Pełna dokumentacja API do zarządzania polami niestandardowymi w Blue - twórz, konfigurować i używaj pól niestandardowych, aby rozszerzyć swoją strukturę danych
Przegląd
Pola niestandardowe pozwalają na rozszerzenie standardowej struktury rekordów Blue o dodatkowe pola danych specyficzne dla potrzeb Twojego biznesu. Stanowią potężny sposób na uchwycenie zorganizowanych danych poza wbudowanymi polami, takimi jak tytuł, opis i termin.
Pola niestandardowe są definiowane na poziomie projektu i mogą być używane we wszystkich rekordach (zadań) w danym projekcie. Każde pole ma określony typ, który określa zasady walidacji, format wejściowy i sposób wyświetlania.
Dostępne operacje
Zarządzanie polami podstawowymi
Operacja |
Opis |
Link |
List Custom Fields |
Zapytanie i filtrowanie pól niestandardowych |
View Details → |
Create Custom Field |
Dodaj nowe pola niestandardowe do projektów |
View Details → |
Delete Custom Field |
Usuń pola niestandardowe z odpowiednim oczyszczeniem |
View Details → |
Wartości pól
Operacja |
Opis |
Link |
Set Field Values |
Ustaw i zaktualizuj wartości pól niestandardowych w rekordach |
View Details → |
Typy pól niestandardowych
Pola tekstowe
Typ |
Opis |
Przykłady użycia |
Link |
TEXT_SINGLE |
Wprowadzenie tekstu w jednej linii |
Names, titles, short descriptions |
View Details → |
TEXT_MULTI |
Obszar tekstowy wieloliniowy |
Długie opisy, notatki, komentarze |
View Details → |
Pola wyboru
Typ |
Opis |
Przykłady użycia |
Link |
SELECT_SINGLE |
Rozwijane menu z pojedynczym wyborem |
Status, priority, category |
View Details → |
SELECT_MULTI |
Rozwijane menu z wieloma wyborami |
Tags, skills, categories |
View Details → |
CHECKBOX |
Pole wyboru typu boolean |
Flags, approvals, confirmations |
View Details → |
Pola numeryczne
Typ |
Opis |
Przykłady użycia |
Link |
NUMBER |
Wprowadzenie numeryczne |
Quantities, scores, measurements |
View Details → |
CURRENCY |
Kwota w walucie |
Budgets, costs, pricing |
View Details → |
PERCENT |
Wartość procentowa |
Completion rates, discounts |
View Details → |
RATING |
Ocena w skali gwiazdkowej |
Performance ratings, satisfaction |
View Details → |
FORMULA |
Pole obliczeniowe oparte na innych polach |
Totals, computations, aggregations |
View Details → |
Pola kontaktowe
Typ |
Opis |
Przykłady użycia |
Link |
EMAIL |
Adres e-mail z walidacją |
Informacje kontaktowe, powiadomienia |
View Details → |
PHONE |
Numer telefonu z międzynarodowym formatowaniem |
Contact details, emergency contacts |
View Details → |
URL |
URL strony internetowej z walidacją |
Links, references, resources |
View Details → |
Pola daty i czasu
Typ |
Opis |
Przykłady użycia |
Link |
DATE |
Wybieracz daty |
Deadlines, milestones, events |
View Details → |
TIME_DURATION |
Pole śledzenia czasu |
Work hours, duration estimates |
View Details → |
Lokalizacja i geografia
Typ |
Opis |
Przykłady użycia |
Link |
LOCATION |
Lokalizacja geograficzna (szerokość/długość geograficzna) |
Addresses, venues, service areas |
View Details → |
COUNTRY |
Wybór kraju |
Regional assignments, localization |
View Details → |
Typ |
Opis |
Przykłady użycia |
Link |
FILE |
Załączenie pliku |
Documents, images, resources |
View Details → |
Pola systemowe
Typ |
Opis |
Przykłady użycia |
Link |
UNIQUE_ID |
Automatycznie generowany unikalny identyfikator |
Ticket numbers, order IDs |
View Details → |
REFERENCE |
Link do rekordów w innym projekcie |
Cross-project relationships |
View Details → |
LOOKUP |
Pobierz dane z powiązanych rekordów |
Aggregate data from related records |
View Details → |
Pola interaktywne
Typ |
Opis |
Przykłady użycia |
Link |
BUTTON |
Pole przycisku akcji |
Triggers, actions, workflows |
View Details → |
CURRENCY_CONVERSION |
Pole konwersji walut |
Multi-currency calculations |
View Details → |
Kluczowe pojęcia
Definicja pola
- Pola niestandardowe są definiowane na poziomie projektu
- Każde pole ma unikalną nazwę i typ
- Pola mogą zawierać zasady walidacji i ograniczenia
- Opcje konfiguracyjne różnią się w zależności od typu pola
Wartości pól
- Wartości są przechowywane w poszczególnych rekordach (zadań)
- Każdy rekord może mieć różne wartości dla tego samego pola
- Puste/nulowe wartości są dozwolone dla pól opcjonalnych
- Wartości są walidowane zgodnie z zasadami typów pól
Model uprawnień
Pola niestandardowe respektują uprawnienia na poziomie projektu:
Rola |
Tworzenie pól |
Edytowanie pól* |
Ustawianie wartości |
Wyświetlanie wartości |
OWNER |
✅ Tak |
✅ Tak |
✅ Tak |
✅ Tak |
ADMIN |
✅ Tak |
✅ Tak |
✅ Tak |
✅ Tak |
MEMBER |
❌ Nie |
❌ Nie |
✅ Tak |
✅ Tak |
CLIENT |
❌ Nie |
❌ Nie |
✅ Ograniczone |
✅ Ograniczone |
*Edytowanie pól odnosi się do modyfikacji ustawień pól (nazwa, typ, opcje, zasady walidacji) - nie do ustawiania wartości pól w rekordach
Uprawnienia ról niestandardowych
- Projekty mogą mieć niestandardowe role z uprawnieniami specyficznymi dla pól
- Pola mogą być oznaczone jako edytowalne/nieedytowalne dla danej roli
- Niestandardowe role mogą ograniczać dostęp do konkretnych pól
Powszechne wzorce
Tworzenie podstawowego pola niestandardowego
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
}
}
}
Ustawianie wartości pól w rekordach
mutation SetFieldValue {
setTodoCustomField(input: {
todoId: "todo_123"
customFieldId: "field_456"
customFieldOptionId: "option_789" # For SELECT_SINGLE
})
}
Zapytania o rekordy z polami niestandardowymi
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
}
}
}
Tworzenie rekordów z wartościami pól niestandardowych
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
}
}
}
Najlepsze praktyki
Projektowanie pól
- Używaj opisowych nazw - Uczyń cele pól jasnymi
- Wybierz odpowiednie typy - Dopasuj typ pola do wymagań danych
- Ustaw zasady walidacji - Użyj wartości min/max, pól wymaganych
- Organizuj logicznie - Grupuj powiązane pola razem
Rozważania dotyczące wydajności
- Ogranicz liczbę pól - Zbyt wiele pól może wpłynąć na wydajność
- Używaj paginacji - Przy zapytaniach o duże zbiory danych
- Indeksuj kluczowe pola - Dla pól używanych w filtrowaniu/sortowaniu
- Unikaj głębokiego zagnieżdżania - Utrzymuj relacje między polami proste
Jakość danych
- Waliduj dane wejściowe - Używaj odpowiednich typów pól z walidacją
- Podawaj wartości domyślne - Ustaw sensowne wartości domyślne tam, gdzie to możliwe
- Używaj spójnych formatów - Standaryzuj wzorce wprowadzania danych
- Regularne oczyszczanie - Usuwaj nieużywane pola i opcje
Doświadczenie użytkownika
- Jasne opisy - Podawaj pomocne opisy pól
- Logiczne porządkowanie - Umieszczaj pola w naturalnym porządku roboczym
- Hierarchia wizualna - Używaj kolorów i formatowania efektywnie
- Postępujące ujawnianie - Pokaż pola, gdy są istotne
Obsługa błędów
Typowe błędy podczas pracy z polami niestandardowymi:
Kod błędu |
Opis |
Rozwiązanie |
CUSTOM_FIELD_NOT_FOUND |
Pole nie istnieje |
Verify field ID and project access |
VALIDATION_ERROR |
Wartość nie pasuje do typu pola |
Check format and validation rules |
UNAUTHORIZED |
Niewystarczające uprawnienia |
Ensure proper role level |
CUSTOM_FIELD_VALUE_PARSE_ERROR |
Nieprawidłowy format wartości |
Review field type requirements |
Powiązane zasoby