Çalışma alanı özellikleri

Çalışma alanı özelliği, sizin tanımladığınız bir alandır. Her kişi profilinde, gelen kutusunda ve API’de görünür. Bir özellik eklemek için migration veya sürüm gerekmez. Bir özelliğin iki adı vardır. Etiket, ekip arkadaşınızın okuduğu addır, örneğin Package. API adı, bir betiğin gönderdiği anahtardır, örneğin package. Etiket her zaman değişebilir. API adı değişemez, bu yüzden değiştirilen bir etiket senkronizasyonunuzu asla bozmaz.

Türler

Tür	Saklanma biçimi	Kabul edilen girdi
`text`	metin	4096 karaktere kadar her metin
`number`	sayı	`42`, `"42"`, `"3,5"`
`boolean`	mantıksal	`true`, `"yes"`, `"evet"`, `false`, `"no"`, `"hayır"`
`date`	metin, `YYYY-MM-DD`	`"2027-06-20"` veya JavaScript’in çözümleyebildiği bir tarih
`select`	metin	seçeneklerden biri, büyük küçük harf farkı olmadan
`url`	metin	`http` veya `https` adresi
`email`	metin	e-posta adresi, küçük harfe çevrilerek saklanır
`phone`	metin	telefon numarası

Kai hem JSON türünü hem de metin yazımını kabul eder, çünkü CSV dışa aktarımları ve elektronik tablolar tür bilgisini kaybeder. Kai yanlış anlamı kabul etmez: tanımsız bir select seçeneği, saklanan bir yazım hatası değil, bir hatadır.

Özellik oluşturma

curl -X POST https://kaisupport.com/api/v1/attributes \
  -H "Authorization: Bearer $KAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "key": "exam_year",
    "label": "Exam year",
    "type": "number",
    "description": "The year of the exam that this student prepares for."
  }'

API adı bir harfle başlar. Küçük harf, rakam ve alt çizgi içerir, en fazla 48 karakter olur.

Tanımsız anahtarlar hatadır

Kai, çalışma alanının tanımlamadığı bir özellik anahtarını reddeder ve anahtarın adını verir:

{
  "error": {
    "type": "invalid_attributes",
    "message": "Some attributes could not be stored.",
    "details": [{ "key": "cohort", "message": "no such workspace attribute" }]
  }
}

Kai anahtarı yok saymaz, reddeder. Önemsediğiniz tek alanı sessizce atan 3000 kişilik bir aktarım, aylarca kimsenin fark etmediği bir arızadır.

Türler değişemez

Var olan bir özelliğin türü sabittir. Farklı bir tür saklamak için özelliği arşivleyin ve yeni bir API adıyla başka bir özellik oluşturun. Tür değişikliği, kayıtlı her değeri kendi tanımına göre okunamaz hale getirir ve hiçbir dönüştürme bu değerlerin tümü için doğru olmaz.

Silme değil, arşivleme

DELETE /attributes/{key} özelliği arşivler:

özellik artık Kai içinde sunulmaz;
Kai bu özelliğe yeni yazma işlemlerini reddeder;
kişilerde zaten bulunan her değer korunur ve profilde görünmeye devam eder.

Özelliği yeniden yazılabilir yapmak için ?restore=true gönderin.

Buradan başlayın

Kavramlar

Nasıl yapılır

Çalışma alanı özellikleri

Türler

Özellik oluşturma

Tanımsız anahtarlar hatadır

Türler değişemez

Silme değil, arşivleme

​Türler

​Özellik oluşturma

​Tanımsız anahtarlar hatadır

​Türler değişemez

​Silme değil, arşivleme

Türler

Özellik oluşturma

Tanımsız anahtarlar hatadır

Türler değişemez

Silme değil, arşivleme