Ana içeriğe geç

5.1.2. İstemci API (Client)#

Hvl report uygulamasının rest api uçlarını kullanmayı sağlayan yapıdır.

Bağımlılıklar#

Gradle Bağımlılıkları

dependencyManagement {
    imports {
        mavenBom "tr.com.havelsan.framework.report:hvl-report-parent"
    }
}

compile (
        [group: 'tr.com.havelsan.framework.report.cloud', name: 'hvl-report-rtool-cloud-client']
)

Rest Servis Tanımı#

Feign client uçlarını kullanabilmek için configurasyon bean'ine asağıdaki annotasyonlar eklenmelidir.

Rest Client Kullanımı

Service metodlarının detaylarına swagger dokümanından ulaşabilirsiniz.

Rapor Üretme#

Client uygulamasını yukarıdaki gibi çalıştırdıktan sonra, swagger üzerinden Report Server altındaki /report-orders/sync-execution ucundan aşağıdaki body ile tetiklenerek rapor üretme örneğini uygulayabilirsiniz.

{
  "executableReportKey": "string",
  "exportingMediaType": "MS_XLSX",
  "executionParams": [
    {
      "paramKey": "string",
      "paramValues": [
        {}
      ]
    }
  ],
  "executionLocale": {
    "language": "string",
    "displayName": "string",
    "country": "string",
    "variant": "string",
    "script": "string",
    "unicodeLocaleAttributes": [
      "string"
    ],
    "unicodeLocaleKeys": [
      "string"
    ],
    "displayLanguage": "string",
    "displayScript": "string",
    "displayCountry": "string",
    "displayVariant": "string",
    "extensionKeys": [
      "string"
    ],
    "iso3Language": "string",
    "iso3Country": "string"
  },
  "jsonDataSource": "string"
}
Parametre detayları

  • executableReportKey: Çalıştırılacak rapor template tanımının key bilgisini ifade eder.
  • exportingMediaType: Rapor çıktısı tipini ifade eder. Geçerli formatlar ve değerli şu şekildedir: "MS_XLSX", "MS_DOCX", "CSV_UTF_8", "PDF", "ODT", "ODS".
  • executionParams: Rapor tanımında belirlenmiş parametreleri ifade eder. Rapor tanımında sınırlandırılmış ise sadece sadece sınırlı değerler, sınırlandırılmamış ise istenilen değerler, parametreleri ile gönderilebilir.
  • executionLocale: Rapor çıktısının dil ayarları bilgisini ifade eder.
  • jsonDataSource: Rapor çıktısının json veri kaynağı bilgisini ifade eder. Yani rapor, bu veri üzerinden üretilir.

Kod Örneği: