Abrufen von Daten über die API
Pfad zur Business Process Reporting-Datenspeicherung
Einstiegspunkte:
/Reporting/BatchState/List
/Reporting/BatchState/File/<filename>
/Reporting/BatchState/View
/Reporting/BatchRouting/List
/Reporting/BatchRouting/File/<filename>
/Reporting/BatchRouting/View
Der vollständige Pfad zur Datenspeicherung ist ein Link, der geändert werden kann.
Beispiel:
http://localhost/Flexicapture12/Server/Reporting/BatchState/View
Für den Zugriff über das ABBYY FlexiCapture-Authentifizierungsmodul wird dem Link Folgendes hinzugefügt: /FCAuth
Ein autorisierter Zugriff ist in den folgenden Fällen zulässig:
- Für autorisierte ABBYY FlexiCapture-Benutzer.
- Bei Verwendung von SAML/JWT-Token.
Beispiel:
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View
Wenn die Instanz nicht der Standard ist, wird der folgende Parameter zum Link hinzugefügt: ?Tenant=<tenant name>.
Beispiel:
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View?Tenant=myTenant
Anfragen erstellen
Es werden nur GET-Anforderungen akzeptiert.
List gibt eine Liste von Dateinamen im JSON-Format zurück.
File gibt eine Datei mit dem angegebenen Namen zurück (die im URL-Format dodiert werden sollte).
View gibt eine Liste von Dateinamen im HTML-Format zurück und fügt Links zu den Dateien mit dem oben beschriebenen BefehlFile ein. Daher ermöglicht Ihnen diese Anfrage, die bereitgestellten Links zu verwenden, um Dateien in Ihrem Browser zu öffnen und Kopien davon auf Ihrem lokalen Computer zu speichern.
Beispiele:
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchState/View
http://localhost/Flexicapture12/Server/FCAuth/Reporting/BatchRouting/View
Berichte zum Business Process Reporting mithilfe von PowerShell-Skripten abrufen
Mit dem folgenden Skript können Instanzenbenutzer mit den Rollen Administrator oder Überwachungsoperator Business Process-überwachungsdaten abrufen.
Berichte werden im CSV-Format in dem Ordner gespeichert, von dem aus das Skript gestartet wurde.
$serviceHost = 'http://localhost' #Host
$user=$null #User
$pass=$null #Password
$tenant=$null #Tenant name
$baseUrl = $serviceHost
if( $user ) {
$baseUrl += '/flexicapture12/server/FCAuth/Reporting/'
} else { $baseUrl += '/flexicapture12/server/Reporting/'
}function createBasicCredentials() #Transforms password to encrypted strings
{
$secpasswd = ConvertTo-SecureString $pass -AsPlainText -Force
return New-Object System.Management.Automation.PSCredential($user, $secpasswd)
}
function getListFromUrl( $url ) #Authenticates using entered credentials
{
if( $tenant ) {
$url = $url + '?Tenant=' + [uri]::EscapeUriString( $tenant );
}
if( $user ) {
$creds = createBasicCredentials -user $user -pass $pass
$response = Invoke-WebRequest -Credential $creds -Uri $url;
} else {
$response = Invoke-WebRequest -UseDefaultCredentials -Uri $url;
}
$fileList = $response.ToString() | ConvertFrom-Json;
return $fileList.reportFiles;
}
function getBatchStateFileList() #Requests a list of BatchState files
{
$url = $baseUrl + 'BatchState/List';
return getListFromUrl -url $url
}
function getBatchRoutingFileList() #Requests a list of BatchRouting files
{
$url = $baseUrl + 'BatchRouting/List';
return getListFromUrl -url $url
}
function downloadFile ( $fileName, $outDir ) #Downloads files
{
$url = $baseUrl + 'BatchState/File/' + [uri]::EscapeUriString( $fileName );
if( $tenant ) {
$url = $url + '?Tenant=' + [uri]::EscapeUriString( $tenant );
}
$outPath = Join-Path -Path $outDir -ChildPath $fileName
if( $user ) {
$creds = createBasicCredentials -user $user -pass $pass
$response = Invoke-WebRequest -Credential $creds -Uri $url;
$response = Invoke-WebRequest -Credential $creds -Uri $url -OutFile $outPath
} else {
$response = Invoke-WebRequest -UseDefaultCredentials -Uri $url -OutFile $outPath
}
}
$files = getBatchStateFileList; #Uploads BatchState files to the current directory
foreach ($file in $files) {
downloadFile -fileName $file -outDir '.\'
}
$files = getBatchRoutingFileList; #Uploads BatchRouting files to the current directory
foreach ($file in $files) {
downloadFile -fileName $file -outDir '.\'
}
12.04.2024 18:16:01