Formları listele

curl --request GET \
  --url https://app.azalt.co/api/v1/forms \
  --header 'Authorization: Bearer <token>'

[
  {
    "formId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "isPublic": true,
    "updatedAt": "<string>",
    "tags": [
      "<string>"
    ],
    "totalElements": 123,
    "totalPossibleDataPoints": 123,
    "totalExpectedDataPoints": 123,
    "totalActivityCount": 123,
    "formSiteCount": 123,
    "formSites": [
      {
        "formSiteId": "<string>",
        "siteId": "<string>",
        "siteName": "<string>",
        "year": 123,
        "submissionCount": 123,
        "dataCount": 123,
        "filledElements": 123,
        "activityCount": 123,
        "progress": 123
      }
    ],
    "overallProgress": 123,
    "totalSubmissions": 123,
    "totalDataCount": 123,
    "years": [
      123
    ],
    "sites": [
      "<string>"
    ],
    "yearsText": "<string>",
    "sitesText": "<string>",
    "siteSearchText": "<string>",
    "yearsMoreCount": 123,
    "sitesMoreCount": 123,
    "assignments": [
      {
        "id": "<string>",
        "organizationUserId": "<string>",
        "createdAt": "<string>",
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "image": "<string>",
        "role": "<string>",
        "accessibleSiteIds": [
          "<string>"
        ]
      }
    ],
    "metadata": "<unknown>",
    "settings": null
  }
]

Form

Formları listele

Kullanıcının organizasyon ve tesis yetkileri kapsamında erişebildiği tüm formları listeler.

Opsiyonel filtreler:

siteId: Belirli bir tesis için kullanılabilir formları döndürür
year: Belirli bir yıl için yapılandırılmış formları sınırlar
status: Form durumuna göre filtreler (aktif, taslak, arşiv)

Yanıt şunları içerir:

Form özetleri ve temel meta veriler
Öğelerin sayısı ve tiplerine dair genel bakış
Tesis dağıtımları ve yayın durumu
Oluşturulma/güncellenme zaman damgaları
Genel erişim ve parola ayarları
Gönderim istatistikleri ve tamamlama oranları

Form kategorileri:

Çevresel veri toplama (enerji, su, atık, emisyon)
Uyum raporlamaları ve sertifikasyon
ESG/sürdürülebilirlik anketleri
Operasyonel metrikler (tesis performansı, kaynak tüketimi)

Kullanım senaryoları:

Yönetişim panoları ve yönetim arayüzleri
Veri girişi iş akışlarında form seçimi
Raporlama ve analitik hazırlıkları
Denetim izi ve uyum dokümantasyonu

GET

forms

Formları listele

curl --request GET \
  --url https://app.azalt.co/api/v1/forms \
  --header 'Authorization: Bearer <token>'

[
  {
    "formId": "<string>",
    "name": "<string>",
    "description": "<string>",
    "isPublic": true,
    "updatedAt": "<string>",
    "tags": [
      "<string>"
    ],
    "totalElements": 123,
    "totalPossibleDataPoints": 123,
    "totalExpectedDataPoints": 123,
    "totalActivityCount": 123,
    "formSiteCount": 123,
    "formSites": [
      {
        "formSiteId": "<string>",
        "siteId": "<string>",
        "siteName": "<string>",
        "year": 123,
        "submissionCount": 123,
        "dataCount": 123,
        "filledElements": 123,
        "activityCount": 123,
        "progress": 123
      }
    ],
    "overallProgress": 123,
    "totalSubmissions": 123,
    "totalDataCount": 123,
    "years": [
      123
    ],
    "sites": [
      "<string>"
    ],
    "yearsText": "<string>",
    "sitesText": "<string>",
    "siteSearchText": "<string>",
    "yearsMoreCount": 123,
    "sitesMoreCount": 123,
    "assignments": [
      {
        "id": "<string>",
        "organizationUserId": "<string>",
        "createdAt": "<string>",
        "userId": "<string>",
        "name": "<string>",
        "email": "<string>",
        "image": "<string>",
        "role": "<string>",
        "accessibleSiteIds": [
          "<string>"
        ]
      }
    ],
    "metadata": "<unknown>",
    "settings": null
  }
]

Yetkilendirmeler

Authorization

string

header

gerekli

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Yanıt

Successful response

formId

string

gerekli

name

string

gerekli

description

string | null

gerekli

isPublic

boolean

gerekli

updatedAt

string | null

gerekli