Referensi API lengkap untuk mengelola bidang kustom di Blue - buat, konfigurasikan, dan gunakan bidang kustom untuk memperluas struktur data Anda
Ikhtisar
Bidang kustom memungkinkan Anda untuk memperluas struktur catatan standar Blue dengan bidang data tambahan yang spesifik untuk kebutuhan bisnis Anda. Mereka menyediakan cara yang kuat untuk menangkap data terstruktur di luar bidang bawaan seperti judul, deskripsi, dan tanggal jatuh tempo.
Bidang kustom didefinisikan di tingkat proyek dan dapat digunakan di seluruh catatan (todos) dalam proyek tersebut. Setiap bidang memiliki tipe tertentu yang menentukan aturan validasi, format input, dan perilaku tampilan.
Operasi yang Tersedia
Manajemen Bidang Inti
Operasi |
Deskripsi |
Tautan |
List Custom Fields |
Kuery dan filter bidang kustom |
View Details → |
Create Custom Field |
Tambahkan bidang kustom baru ke proyek |
View Details → |
Delete Custom Field |
Hapus bidang kustom dengan pembersihan yang tepat |
View Details → |
Nilai Bidang
Operasi |
Deskripsi |
Tautan |
Set Field Values |
Atur dan perbarui nilai bidang kustom pada catatan |
View Details → |
Tipe Bidang Kustom
Bidang Teks
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
TEXT_SINGLE |
Input teks satu baris |
Names, titles, short descriptions |
View Details → |
TEXT_MULTI |
Area teks multi-baris |
Deskripsi panjang, catatan, komentar |
View Details → |
Bidang Pilihan
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
SELECT_SINGLE |
Dropdown pilihan tunggal |
Status, priority, category |
View Details → |
SELECT_MULTI |
Dropdown pilihan ganda |
Tags, skills, categories |
View Details → |
CHECKBOX |
Bidang checkbox boolean |
Flags, approvals, confirmations |
View Details → |
Bidang Numerik
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
NUMBER |
Input numerik |
Quantities, scores, measurements |
View Details → |
CURRENCY |
Jumlah mata uang |
Budgets, costs, pricing |
View Details → |
PERCENT |
Nilai persentase |
Completion rates, discounts |
View Details → |
RATING |
Penilaian bintang dengan skala kustom |
Performance ratings, satisfaction |
View Details → |
FORMULA |
Bidang terhitung berdasarkan bidang lain |
Totals, computations, aggregations |
View Details → |
Bidang Kontak
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
EMAIL |
Alamat email dengan validasi |
Informasi kontak, notifikasi |
View Details → |
PHONE |
Nomor telepon dengan format internasional |
Contact details, emergency contacts |
View Details → |
URL |
URL web dengan validasi |
Links, references, resources |
View Details → |
Bidang Tanggal dan Waktu
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
DATE |
Pemilih tanggal |
Deadlines, milestones, events |
View Details → |
TIME_DURATION |
Bidang pelacakan waktu |
Work hours, duration estimates |
View Details → |
Lokasi dan Geografi
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
LOCATION |
Lokasi geografis (lat/lng) |
Addresses, venues, service areas |
View Details → |
COUNTRY |
Pemilih negara |
Regional assignments, localization |
View Details → |
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
FILE |
Lampiran file |
Documents, images, resources |
View Details → |
Bidang Sistem
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
UNIQUE_ID |
Pengidentifikasi unik yang dihasilkan secara otomatis |
Ticket numbers, order IDs |
View Details → |
REFERENCE |
Tautan ke catatan di proyek lain |
Cross-project relationships |
View Details → |
LOOKUP |
Ambil data dari catatan yang dirujuk |
Aggregate data from related records |
View Details → |
Bidang Interaktif
Tipe |
Deskripsi |
Kasus Penggunaan |
Tautan |
BUTTON |
Bidang tombol yang dapat diambil tindakan |
Triggers, actions, workflows |
View Details → |
CURRENCY_CONVERSION |
Bidang konversi mata uang |
Multi-currency calculations |
View Details → |
Konsep Kunci
Definisi Bidang
- Bidang kustom didefinisikan di tingkat proyek
- Setiap bidang memiliki nama dan tipe yang unik
- Bidang dapat mencakup aturan dan batasan validasi
- Opsi konfigurasi bervariasi berdasarkan tipe bidang
Nilai Bidang
- Nilai disimpan pada catatan individu (todos)
- Setiap catatan dapat memiliki nilai yang berbeda untuk bidang yang sama
- Nilai kosong/null diperbolehkan untuk bidang opsional
- Nilai divalidasi sesuai dengan aturan tipe bidang
Model Izin
Bidang kustom menghormati izin tingkat proyek:
Peran |
Buat Bidang |
Edit Bidang* |
Atur Nilai |
Lihat Nilai |
OWNER |
✅ Ya |
✅ Ya |
✅ Ya |
✅ Ya |
ADMIN |
✅ Ya |
✅ Ya |
✅ Ya |
✅ Ya |
MEMBER |
❌ Tidak |
❌ Tidak |
✅ Ya |
✅ Ya |
CLIENT |
❌ Tidak |
❌ Tidak |
✅ Terbatas |
✅ Terbatas |
*Edit Bidang mengacu pada modifikasi pengaturan bidang (nama, tipe, opsi, aturan validasi) - bukan mengatur nilai bidang pada catatan
Izin Peran Kustom
- Proyek dapat memiliki peran kustom dengan izin spesifik bidang
- Bidang dapat ditandai sebagai dapat diedit/tidak dapat diedit per peran
- Peran kustom dapat membatasi akses ke bidang tertentu
Pola Umum
Membuat Bidang Kustom Dasar
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
}
}
}
Mengatur Nilai Bidang pada Catatan
mutation SetFieldValue {
setTodoCustomField(input: {
todoId: "todo_123"
customFieldId: "field_456"
customFieldOptionId: "option_789" # For SELECT_SINGLE
})
}
Mengquery Catatan dengan Bidang Kustom
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
}
}
}
Membuat Catatan dengan Nilai Bidang Kustom
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
}
}
}
Praktik Terbaik
Desain Bidang
- Gunakan nama deskriptif - Buat tujuan bidang jelas
- Pilih tipe yang sesuai - Sesuaikan tipe bidang dengan kebutuhan data
- Atur aturan validasi - Gunakan nilai min/maks, bidang yang diperlukan
- Organisir secara logis - Kelompokkan bidang terkait bersama
Pertimbangan Kinerja
- Batasi jumlah bidang - Terlalu banyak bidang dapat mempengaruhi kinerja
- Gunakan paginasi - Saat mengquery dataset besar
- Indeks bidang kunci - Untuk bidang yang digunakan dalam penyaringan/pengurutan
- Hindari nesting yang dalam - Jaga hubungan bidang tetap sederhana
Kualitas Data
- Validasi input - Gunakan tipe bidang yang sesuai dengan validasi
- Berikan default - Atur nilai default yang masuk akal di tempat yang sesuai
- Gunakan format yang konsisten - Standarisasi pola entri data
- Pembersihan rutin - Hapus bidang dan opsi yang tidak digunakan
Pengalaman Pengguna
- Deskripsi yang jelas - Berikan deskripsi bidang yang membantu
- Urutan logis - Tempatkan bidang dalam urutan alur kerja yang alami
- Hierarki visual - Gunakan warna dan format dengan efektif
- Pengungkapan progresif - Tampilkan bidang saat relevan
Penanganan Kesalahan
Kesalahan umum saat bekerja dengan bidang kustom:
Kode Kesalahan |
Deskripsi |
Solusi |
CUSTOM_FIELD_NOT_FOUND |
Bidang tidak ada |
Verify field ID and project access |
VALIDATION_ERROR |
Nilai tidak cocok dengan tipe bidang |
Check format and validation rules |
UNAUTHORIZED |
Izin tidak mencukupi |
Ensure proper role level |
CUSTOM_FIELD_VALUE_PARSE_ERROR |
Format nilai tidak valid |
Review field type requirements |
Sumber Daya Terkait