> ## Documentation Index
> Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Berichte mit der Web-API herunterladen

> ABBYY FlexiCapture-Berichte zu Operator-Arbeitslasten, Verarbeitungsleistung und Lizenzverbrauch als CSV über den Web-API-GetCsv-GET-Request herunterladen.

Sie können die Web-API verwenden, um Berichte zu Operator-Arbeitslasten, verarbeiteten Dokumenten, Dokumenten bestimmter Clients und anderen Kriterien herunterzuladen. Die Parameter der API-Methode und die resultierende CSV-Datei sind identisch mit denen, die beim Erstellen von Berichten in der Administration and Monitoring Console erzeugt werden. Weitere Informationen finden Sie unter [Reports](/de/flexi-capture/web-stations/monitoring-console/reports).

Um Reports herunterzuladen, verwenden Sie einen GET-Request mit der folgenden URI:

```http theme={null}
GET http://localhost/FlexiCapture12/Monitoring/Report/GetCsv?reportType=<reportType>&filterParametersJson=<filterParametersJson>
```

<div id="request-parameters">
  ## Request-Parameter
</div>

Übergeben Sie `reportType` und `filterParametersJson` im Query-String.

<div id="report-types">
  ### Berichtstypen
</div>

`reportType` akzeptiert die folgenden Werte:

| Wert | Bericht                                    |
| ---- | ------------------------------------------ |
| `1`  | Allgemeiner Operatorenbericht              |
| `3`  | Bericht zur Verarbeitungsleistung          |
| `9`  | Bericht zur Standortleistung               |
| `10` | Bericht zum Lizenzverbrauch nach Mandanten |
| `11` | Bericht zum Lizenzverbrauch nach Projekten |

<div id="report-parameters">
  ### Berichtsparameter
</div>

`filterParametersJson` akzeptiert die Parameter, mit denen der Bericht generiert wird. Welche Parameter verfügbar sind, hängt vom Berichtstyp ab. Weitere Informationen finden Sie unter den Parametern für die einzelnen Berichtstypen:

* [Parameter für den Allgemeinen Operatorenbericht](/de/flexi-capture/api/reports/api-reports-operator)
* [Parameter für den Bericht zur Verarbeitungsleistung](/de/flexi-capture/api/reports/api-reports-processing)
* [Parameter für den Bericht zur Standortleistung](/de/flexi-capture/api/reports/api-reports-performance)
* [Parameter für den Bericht zum Lizenzverbrauch nach Mandanten](/de/flexi-capture/api/reports/api-reports-consumptionbytenants)
* [Parameter für den Bericht zum Lizenzverbrauch nach Projekten](/de/flexi-capture/api/reports/api-reports-consumptionbyprojects)

<div id="example-script">
  ## Beispielskript
</div>

Das folgende PowerShell-Skript zeigt, wie Sie mit dieser API einen Bericht herunterladen.

```powershell theme={null}
# Authentifizierungsparameter
$endpoint = "https://preprod01.flexicapture.com"
$tenant = "tenantName"
$user = "FCUserName"
$pass = "password"
$filePath = "c:\temp\report.csv"
# Berichtsparameter
$reportType = 3
$jsonparameters = @"
[
    {
        "Name": "dateFrom",
        "Value": "2022-08-31T21:00:00.000Z"
    },
    {
        "Name": "dateTo",
        "Value": "2022-09-01T21:00:00.000Z"
    },
    {
        "Name": "projects",
        "Value": [
            5,
            6,
            7,
            9,
            10,
            11,
            12,
            13,
            14,
            15,
            16,
            17,
            19,
            20,
            28,
            81,
            221
        ]
    },
    {
        "Name": "aggregateByBatchTypes",
        "Value": true
    },
    {
        "Name": "groupByType",
        "Value": 1
    },
    {
        "Name": "grouping",
        "Value": "ProcessingStageName"
    },
    {
        "Name": "columns",
        "Value": [
            "ProjectId",
            "BatchTypeName",
            "ProcessedBatchs",
            "ProcessedDocs"
        ]
    }
]
"@
###################################################
clear
$ErrorActionPreference="stop"
#AuthTicket für die Autorisierung über die FlexiCapture SOAP API abrufen
$tenantSuffix=""
$tenantInUrl = ""
if (($tenant -ne $null) -or ($tenant -eq "")) {
    $tenantSuffix= "?Tenant="+$tenant
    $tenantInUrl = "/$tenant"
}
$URL = $endpoint+'/FlexiCapture12/Server/FCAuth/API/Soap'+$tenantSuffix
$SOAPRequest = @"
<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <soap:Body>
    <FindUser xmlns="urn:http://www.abbyy.com/FlexiCapture">
      <userLogin>$user</userLogin>
    </FindUser>
  </soap:Body>
</soap:Envelope>
"@
$pair = "$($user):$($pass)"
$encodedCreds = [System.Convert]::ToBase64String([System.Text.Encoding]::ASCII.GetBytes($pair))
$basicAuthValue = "Basic $encodedCreds"
$Headers = @{
    'SOAPAction' = '"#FindUser"'
    'Content-Type' = 'text/xml; charset=utf-8'
    'Authorization' = "$basicAuthValue"
}
$response = Invoke-WebRequest -Uri $URL `
    -Headers $Headers `
    -Body $SOAPRequest `
    -Method 'POST'
$authTicket = $response.Headers['AuthTicket']
#Authentifizierungs-Cookie erstellen
$session = [Microsoft.PowerShell.Commands.WebRequestSession]::new()
$cookie = [System.Net.Cookie]::new('FlexiCaptureTmpPrn', "Ticket=$authTicket")
$session.Cookies.Add($endpoint, $cookie)
# Bericht über die API anfordern und speichern
$uriGet = $endpoint+ "/FlexiCapture12/Monitoring$tenantInUrl/Report/GetCSV?reportType=$reportType&filterParametersJson="
$uriGet += [uri]::EscapeDataString($jsonparameters)
$header = @{
    "Accept" = "*/*"
    "Accept-Encoding" = "gzip, deflate, br"
}
$response = Invoke-RestMethod -Uri $uriGet -Method 'GET' -Headers $header -WebSession $session -OutFile $filePath
```
