Ambil daftar field kustom yang dipaginasi untuk sebuah proyek atau di beberapa proyek dengan opsi penyaringan dan pengurutan


Daftar Semua Field Kustom

Field kustom memungkinkan Anda untuk memperluas struktur catatan standar Blue dengan field data tambahan yang spesifik untuk kebutuhan bisnis Anda. Endpoint ini mengambil field kustom yang tersedia di proyek Anda, dengan penyaringan berdasarkan tipe field dan dukungan paginasi.

Contoh Dasar

query ListCustomFields {
  customFields(
    filter: { projectId: "project_123" }
    sort: position_ASC
    take: 20
  ) {
    items {
      id
      uid
      name
      type
      position
    }
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

Contoh Lanjutan

query ListCustomFieldsAdvanced {
  customFields(
    filter: {
      projectId: "project_123"
      types: [TEXT_SINGLE, NUMBER, SELECT_SINGLE]
    }
    sort: name_ASC
    skip: 20
    take: 50
  ) {
    items {
      id
      uid
      name
      type
      position
      description
      
      # Type-specific fields
      min              # For NUMBER, RATING, PERCENT
      max              # For NUMBER, RATING, PERCENT
      currency         # For CURRENCY type
      prefix           # For UNIQUE_ID type
      isDueDate        # For DATE type
      formula          # For FORMULA type
      
      # Validation settings
      editable
      metadata
      
      # For SELECT types
      customFieldOptions {
        id
        title
        color
        position
      }
    }
    pageInfo {
      totalItems
      hasNextPage
      hasPreviousPage
    }
  }
}

Parameter Input

CustomFieldFilterInput

Parameter Tipe Diperlukan Deskripsi
projectId String Tidak Saring berdasarkan ID proyek tertentu
types [CustomFieldType!] Tidak Saring berdasarkan tipe field kustom

Nilai Pengurutan CustomField

Nilai Deskripsi
name_ASC Urutkan berdasarkan nama naik (A-Z)
name_DESC Urutkan berdasarkan nama turun (Z-A)
createdAt_ASC Urutkan berdasarkan tanggal pembuatan (terlama terlebih dahulu)
createdAt_DESC Urutkan berdasarkan tanggal pembuatan (terbaru terlebih dahulu)
position_ASC Urutkan berdasarkan posisi (default)
position_DESC Urutkan berdasarkan posisi turun

Nilai Tipe CustomField

Nilai Deskripsi
TEXT_SINGLE Input teks satu baris
TEXT_MULTI Area teks multi-baris
SELECT_SINGLE Dropdown pemilihan tunggal
SELECT_MULTI Dropdown pemilihan ganda
CHECKBOX Field checkbox boolean
RATING Rating bintang (1-5 atau rentang kustom)
PHONE Nomor telepon dengan validasi
NUMBER Input numerik
CURRENCY Jumlah mata uang
PERCENT Nilai persentase
EMAIL Alamat email dengan validasi
URL URL web dengan validasi
UNIQUE_ID Pengidentifikasi unik yang dihasilkan otomatis
LOCATION Lokasi geografis (lat/lng)
FILE Lampiran file
DATE Pemilih tanggal
COUNTRY Pemilih negara
FORMULA Field yang dihitung berdasarkan field lain
REFERENCE Tautan ke catatan di proyek lain
LOOKUP Ambil data dari catatan yang dirujuk
TIME_DURATION Field pelacakan waktu
BUTTON Field tombol yang dapat diambil tindakan
CURRENCY_CONVERSION Field konversi mata uang

Parameter Paginasi

Parameter Tipe Diperlukan Deskripsi
skip Int Tidak Jumlah item yang akan dilewati (default: 0)
take Int Tidak Jumlah item yang akan dikembalikan (default: 20, max: 500)

Field Respons

CustomField

Field Tipe Deskripsi
id String! Pengidentifikasi unik
uid String! ID ramah pengguna yang unik
name String! Nama tampilan dari field
type CustomFieldType! Tipe dari field kustom
position Float! Posisi urutan pengurutan
description String Deskripsi field opsional
min Float Nilai minimum (NUMBER, RATING, PERCENT)
max Float Nilai maksimum (NUMBER, RATING, PERCENT)
currency String Kode mata uang (tipe CURRENCY)
prefix String Awalan untuk generasi UNIQUE_ID
isDueDate Boolean Apakah field TANGGAL mewakili tanggal jatuh tempo
formula JSON Konfigurasi formula (tipe FORMULA)
editable Boolean Apakah pengguna saat ini dapat mengedit field ini
metadata JSON Konfigurasi field tambahan
customFieldOptions [CustomFieldOption!] Opsi yang tersedia untuk tipe SELECT

CustomFieldOption

Field Tipe Deskripsi
id String! Pengidentifikasi unik
title String! Teks tampilan untuk opsi
color String! Kode warna hex
position Float! Posisi urutan pengurutan

PageInfo

Field Tipe Deskripsi
totalItems Int Total jumlah field kustom
hasNextPage Boolean! Apakah masih ada halaman lain
hasPreviousPage Boolean! Apakah ada halaman sebelumnya
endCursor String Kursor untuk paginasi (tidak lagi digunakan - gunakan paginasi berbasis offset)

Izin yang Diperlukan

Field kustom dapat diakses berdasarkan peran proyek Anda. Jika Anda memiliki peran kustom dengan akses field yang dibatasi, hanya field yang ditandai sebagai dapat diedit untuk peran Anda yang akan dikembalikan.

Peran Dapat Daftar Field Kustom
OWNER ✅ Ya (semua field)
ADMIN ✅ Ya (semua field)
MEMBER ✅ Ya (berdasarkan izin peran)
CLIENT ✅ Ya (berdasarkan izin peran)

Respons Kesalahan

Proyek Tidak Ditemukan

{
  "errors": [{
    "message": "Project not found.",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

Tipe Field Tidak Valid

{
  "errors": [{
    "message": "Variable \"$filter\" got invalid value \"INVALID_TYPE\" at \"filter.types[0]\"; Value \"INVALID_TYPE\" does not exist in \"CustomFieldType\" enum.",
    "extensions": {
      "code": "GRAPHQL_VALIDATION_FAILED"
    }
  }]
}

Catatan Penting

  • Field kustom terikat pada proyek - Anda harus menentukan sebuah projectId dalam penyaringan
  • Parameter take dibatasi pada 500 item per permintaan untuk kinerja
  • Field dikembalikan berdasarkan izin pengguna - peran kustom mungkin memiliki akses yang dibatasi
  • Urutan pengurutan default adalah berdasarkan position naik, yang mencerminkan urutan yang ditampilkan di UI
  • Kuery ini mendukung penyaringan proyek tunggal - untuk kuery multi-proyek, gunakan antarmuka CustomFieldQueries bersarang
  • Beberapa tipe field (seperti FORMULA dan REFERENCE) mungkin menyertakan struktur data bersarang tambahan
  • Field editable menunjukkan apakah pengguna saat ini dapat memodifikasi nilai untuk field kustom ini

Endpoint Terkait

Asisten AI

Respon dihasilkan menggunakan AI dan mungkin mengandung kesalahan.

Bagaimana saya bisa membantu Anda?

Tanyakan apa saja tentang Blue atau dokumentasi ini.

Masukkan untuk mengirim • Shift+Masukkan untuk baris baru • ⌘I untuk membuka