Export API

Uyarı: Bu kararlı olmayan bir rota. Gelecekteki sürümlerde değişiklikler olabilir.

Bir sorgunun sonuçlarını belirtilen formatta indirilebilir bir dosya olarak dışa aktarır.

Sorgu query parametresi, Sorgu belgesinde açıklanan formata uygunlaştırılmış bir stringleştirilmiş JSON değeridir.

Seçenekler query parametresi, aşağıdaki formattan birine sahip olabilir:

• CSV dışa aktarımı için:
  
  • format:  (string) "csv" değerine sahip olmalıdır.
    
  • fileName: (optional, string) uzantısız dosya adı
  • Aşağıdaki iki alandan en az biri sağlanmalıdır:
    • model: (optional, string) Kabul edilen değerler şunlardır "Case", "Alert", "User", "Organisation", "Procedure" ve "Task"
    • fields: (optional, array of strings) Dışa aktarılan verilere eklenecek ekstra alanlar
  • delimiter: (optional, character)
  • quoteChar: (optional, character)
  • escapeChar: (optional, character)
• JSON dışa aktarımı için:
  
  • format: (string)  "json" değerine sahip olmalıdır
    
  • fileName: (optional, string) Dosya adı, uzantısı olmadan
    

Yanıtlar