API alan adları sözlüğü
Kimlik, sayfalama, düzenleme ve hata alanlarının türünü ve anlamını öğrenin.
Son güncelleme:
Alan adlarını koruyun
API’deki Türkçe alan adları kalıcıdır; alan adları sürüm boyunca değişmez. Aşağıdaki adlar JSON anahtarlarıdır. Arayüzde görülen bir başlığı çevirerek veya yazımını değiştirerek istek alanı üretmeyin. Aynı adlı alanın farklı konumlarda farklı anlamı olabileceğinden nesne yolunu da kontrol edin.
Kimlik ve kapsam
| Alan | Tür | Anlamı |
|---|---|---|
user.id |
Tam sayı | Anahtar sahibinin kullanıcı kimliği. |
user.org_id |
Tam sayı | Kullanıcının bağlı olduğu kurum. |
anahtar.id |
Tam sayı | Kullanılan anahtar kaydının kimliği; sır değildir. |
anahtar.ad |
Metin | Anahtarı ayırt etmek için verilen ad. |
kapsam |
Metin dizisi | oku veya oku ve yaz; kullanıcı yetkisini genişletmez. |
proje_ids |
Tam sayı dizisi veya null |
Seçili projeler; null güncel kullanıcı erişimiyle sınırlı genel kapsam. Boş dizi proje erişimi vermez. |
bitis_at |
Tarih-saat veya null |
Anahtarın varsa bitiş anı. |
erisim |
Metin | Projenin kurum veya üyelik erişim seçimi. |
Okuma ve sayfalama
| Alan | Tür | Anlamı |
|---|---|---|
features |
Dizi | GeoJSON nesneleri. |
features[].id |
Metin | Sunucunun verdiği nesne kimliği. |
geometry |
Nesne | GeoJSON geometrisi; v1’de WGS 84. |
properties |
Nesne | Nesnenin tür ve sürüm bilgileriyle öznitelikleri. |
properties.type |
Metin | Nesne türünün teknik anahtarı. |
properties.v |
Tam sayı | Harita nesnesinin kayıt sürümü. |
items |
Dizi | Teknik kayıt veya değişiklik sayfasının satırları. |
next |
Metin, tam sayı veya null |
Sonraki istekte after olacak kimlik; tür uç sözleşmesine bağlıdır. |
cursor |
Tam sayı | Nesne okumasından önce alınan proje değişiklik kimliği. |
counts |
Nesne | Proje ayrıntısında türlere göre n adet ve len uzunluk dökümü. |
gizli |
Mantıksal | Değişiklik satırının ayrıntıları güncel modül kapsamında gösterilemiyorsa true. |
Değişiklik satırındaki before ve after önceki ve sonraki kayıt gövdeleridir. Sorgudaki after ise sayfalama imlecidir; aynı ad bu iki yerde farklı anlama gelir. gizli: true olduğunda kayıt gövdeleri bulunmaz.
Yazma ve işlem sonucu
| Alan | Tür | Anlamı |
|---|---|---|
request_id |
Metin | Aynı işi tekrar göndermeyi ayırt eden istemci işlem kimliği. |
ops |
Dizi | Sırayla uygulanacak düzenlemeler. |
op |
Metin | create, update veya delete. |
entity |
Metin | İşlemin varlık sınıfı; örneğin feature. |
version |
Tam sayı | Güncelleme veya silmede son okunan kayıt sürümü. |
ok |
Mantıksal | Başarılı düzenleme sonucunda true. HTTP durumunu ayrıca kontrol edin. |
batch |
Metin | Sunucunun verdiği işlem grubu kimliği. |
ids |
Dizi | İşlem sonuçlarının kimlikleri. |
tmp |
Nesne | İstemcinin geçici kimliklerini kalıcı kimliklerle eşler. |
replayed |
Mantıksal | Kayıtlı sonucun aynı işlem için tekrar döndüğünü belirtir; ilk yanıtta bulunmayabilir. |
uyarilar |
Dizi | Başarıyla yazılan kayıtla ilgili değerlendirilmesi gereken uyarılar. |
Hata alanları
| Alan | Tür | Anlamı |
|---|---|---|
detail |
Metin veya dizi | İnsan tarafından okunabilir hata açıklaması ya da doğrulama ayrıntıları. |
kod |
Metin | Makineyle işlenebilir hata sınıfı; bütün genel reddetmelerin özel kodu yoktur. |
alan |
Metin, sayı veya null |
Hatayla ilişkili alan veya işlem konumu; uçtaki reddetmeye bağlıdır. |
Bir uyarilar dizisini hata zarfıyla karıştırmayın; başarılı düzenlemede de bulunabilir. Uçlara özgü ek alanlar için v1 API referansını, retler için hata kodlarını kullanın.
