Genel formu getir

curl --request GET \
  --url https://app.azalt.co/api/v1/forms/public/{formSiteId}

{
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "description": "<string>",
  "isPublic": true,
  "year": 123,
  "siteId": "<string>",
  "elements": [
    "<unknown>"
  ],
  "hideFuturePeriods": true,
  "metadata": "<unknown>",
  "settings": null
}

Form

Genel formu getir

Kimlik doğrulaması olmadan dış veri toplamak için form yapılandırmasını döndürür.

Parametreler:

formSiteId: Form ve tesis kombinasyonunu temsil eden benzersiz kimlik
password: Form parola korumalıysa opsiyonel parola

Yanıt şunları içerir:

Formun tamamı (başlık, açıklama, talimatlar)
Tüm öğelerin tipleri, doğrulama kuralları ve seçenekleri
Öğeler arasındaki koşullu görünürlük mantıkları
Gönderim ayarları ve gereksinimler

Kullanım senaryoları:

Tedarikçilerden veya paydaşlardan çevresel veri toplamak
Kimlik doğrulaması gerektirmeyen sürdürülebilirlik anketleri
Çoklu organizasyondan uyum raporlaması
Dış tesislerden veri toplamak

Güvenlik özellikleri:

Opsiyonel parola koruması
İstismar önleme için hız sınırlandırma
Organizasyon seviyesinde erişim kontrolleri

GET

forms

public

{formSiteId}

Genel formu getir

curl --request GET \
  --url https://app.azalt.co/api/v1/forms/public/{formSiteId}

{
  "id": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "description": "<string>",
  "isPublic": true,
  "year": 123,
  "siteId": "<string>",
  "elements": [
    "<unknown>"
  ],
  "hideFuturePeriods": true,
  "metadata": "<unknown>",
  "settings": null
}

Yol Parametreleri

formSiteId

string

gerekli

Yanıt

Successful response

string

gerekli

name

string

gerekli

organizationId

string | null

gerekli

description

string | null

gerekli

isPublic

boolean

gerekli

year

number

gerekli

siteId

string

gerekli

elements

any[]

gerekli

hideFuturePeriods

boolean

gerekli

metadata

any

settings

unknown

Recalculate public form submission scores Genel formu gönder