Çıktılar API’si
Saha raporlarını ve birlikte üretilen çıktı paketlerini HTTP üzerinden alın.
Son güncelleme:
Rapor uçları
Saha çıktıları GET /api/p/{pid}/ciktilar/{tur} uçlarıyla alınır. Okuma yetkisi olan İzleyici dahil kullanıcılar, modül kapsamlarının izin verdiği çıktılara erişebilir. Varsayılan format=json; aşağıdaki raporlarda csv, xlsx ve pdf de seçilebilir.
| Tür | İçerik | Kapsam parametreleri |
|---|---|---|
pano |
Pano / kaset ek çizelgesi | Tekrarlanabilen dugum veya hepsi=1 |
raf |
Raf çizelgesi | Tekrarlanabilen dugum veya hepsi=1 |
malzeme |
Malzeme / metraj listesi | durum |
kapasite-optik |
Kapasite / optik raporu | durum, bolum |
etiketler |
Etiket listesi | Tekrarlanabilen dugum veya hepsi=1 |
Pano, raf, kapasite/optik ve etiketler fiber kapsamı ister. Malzeme çıktısı fiber kapalıyken ortak saha verisiyle alınabilir. Elektrik envanteri uçları henüz genel kullanıma açık modül kapsamında değildir.
Kapsam seçimi
Düğüm seçimi gerektiren uçta dugum parametresi birden fazla kez verilebilir. hepsi=1 seçilirse bütün proje kapsamı kullanılır.
GET /api/p/{pid}/ciktilar/pano?dugum=DOL-123&dugum=EK-456&format=pdf
Kimlikler örnektir; aynı projede erişilebilir düğümlerle değiştirilir. Düğüm verilmez ve hepsi=1 seçilmezse 400 döner.
Malzeme için durum seçenekleri hepsi, yeni, mevcut, kullanim_disi değerleridir. yeni, planlanan ve yapım aşamasındaki nesneleri birlikte kapsar.
Kapasite/optik için devre durumları virgülle ayrılmış aktif, planlanan, pasif değerleridir; varsayılan aktif,planlanan olur. bolum=kapasite,optik varsayılandır; tek bölüm de seçilebilir. Optik bölüm kayıtlı hesapları ve bunların güncellik bilgisini gösterir; çıktı almak yeni optik hesap oluşturmaz.
JSON yanıtı
Rapor JSON’u, sıradan nesne listesi değildir. Başlıca alanları şunlardır:
| Alan | Anlam |
|---|---|
cikti, ad |
Rapor anahtarı ve görünen adı |
veri_ani |
Üretim zamanı, son değişiklik, modüller ve kapsam |
kunye |
Rapora özgü açıklayıcı bilgiler |
notlar, uyarilar |
Sonucun yorumlanmasını etkileyen kayıtlar |
sayilar |
Rapora özgü toplamlar |
bolumler |
Bölüm tanımları ve satırlar |
Her bölüm anahtar, baslik, anahtarlar, sutunlar, turler, notlar, satirlar, kimlikler taşır. satirlar dizisindeki değerleri aynı bölümün anahtarlar sırasına göre eşleyin. Türkçe sütun başlıklarını sabit alan anahtarı olarak kullanmayın.
veri_ani içindeki generated_at, son_degisiklik, moduller, kapsam, sozlesme ve snapshot_tekil alanları çıktının hangi veri anına dayandığını belirtir. Büyük tamsayılar kayıpsız metin olarak dönebilir; bütün sayısal görünen hücreleri zorla JavaScript Number türüne çevirmeyin.
Birlikte çıktı paketi
GET /api/p/{pid}/ciktilar/paket, format=zip ile seçilen raporları tek veri anından üretir. icerik değerleri <rapor>.<biçim> şeklindedir; virgülle veya tekrarlanan sorgu parametresiyle verilir.
GET /api/p/{pid}/ciktilar/paket?icerik=pano.pdf&icerik=malzeme.xlsx&hepsi=1
Boş, tekrarlı veya bilinmeyen seçim 400 ile reddedilir. Paket için malzeme_durum, devre_durum ve bolum parametreleri kullanılabilir. ZIP, seçilen dosyalarla birlikte veri anını ve dosya listesini taşıyan KUNYE.json içerir.
Bu ZIP, proje geri yükleme paketi değildir; rapor dağıtımı içindir. Projeyi taşımak için Proje paketi kullanılır.
Sınırlar ve hata davranışı
| Sınır | Değer |
|---|---|
| Tek istekte seçilen düğüm | 200 |
| Tek çıktıdaki bölüm satırları toplamı | 200.000 |
| Paket toplam satırı | 400.000; aynı verinin farklı biçimleri ayrı sayılır |
| Tek dosya | 25 MiB |
| Paketin açılmış dosya toplamı | 100 MiB |
| Toplanan hücre içeriği | 64 MiB |
| Toplam süre bütçesi | 30 saniye |
| Eşzamanlı çıktı üretimi | Uygulama işçisi başına 2 |
Satır sınırı 400/cikti_sinir; boyut, süre veya dolu üretim kapasitesi 409 döndürebilir. Özellikle cikti_mesgul için daha sonra yeniden deneyin; cikti_sure ve cikti_boyut için düğüm, durum veya bölüm kapsamını daraltın. Paket üretimi de ortak bütçelere tabidir.
Çıktı çağrıları proje kayıtlarını değiştirmez ve request_id almaz. Dosya biçimleri doğrudan dosya gövdesi döndürür; indirme adını Content-Disposition üzerinden okuyun. Hata halinde dosya yerine JSON gelebileceği için gövdeyi kaydetmeden önce HTTP durumunu değerlendirin. Bkz. Hatalar.