Passer au contenu principal
Vous pouvez utiliser le Web API pour télécharger des rapports sur les charges de travail des opérateurs, les documents traités, les documents provenant de clients spécifiques et d’autres critères. Les paramètres des méthodes de l’API sont identiques à ceux utilisés pour créer des rapports via l’interface graphique de l’Administration and Monitoring Console. Le fichier CSV résultant est également identique au fichier CSV créé à l’aide de l’interface graphique de l’Administration and Monitoring Console. Pour plus d’informations sur les différentes données collectées par les rapports, consultez la section Reports dans l’aide de l’Administration and Monitoring Console. Pour télécharger des rapports, utilisez une requête GET et transmettez l’URI suivante : http://localhost/FlexiCapture12/Monitoring/Report/GetCsv?reportType=<reportType>&filterParametersJson=<filterParametersJson>. Dans cette URI, reportType et filterParametersJson peuvent prendre les valeurs suivantes :

Nom

Type de rapport. Valeurs possibles :

  • 1 - rapport général sur les opérateurs
  • 3 - rapport sur les performances de traitement
  • 9 - rapport sur les performances du site
  • 10 - rapport sur la consommation de License par tenant
  • 11 - rapport sur la consommation de License par projet

Paramètres utilisés pour générer les rapports. Les paramètres dépendent du type de rapport. Consultez les informations détaillées sur les paramètres de chaque rapport :

Vous trouverez un exemple d’utilisation de cette API dans le script. Téléchargez le script ici ou utilisez le code du script fourni ci-dessous. 
# Paramètres d'authentification

$endpoint = "https://preprod01.flexicapture.com"

$tenant = "tenantName"

$user = "FCUserName"

$pass = "password"

$filePath = "c:\temp\report.csv"

# Paramètres du rapport

$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"

#Obtention de l'authTicket pour l'autorisation depuis l'API SOAP FlexiCapture

$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']

#Création du cookie d'authentification

$session = [Microsoft.PowerShell.Commands.WebRequestSession]::new()

$cookie = [System.Net.Cookie]::new('FlexiCaptureTmpPrn', "Ticket=$authTicket")

$session.Cookies.Add($endpoint, $cookie)

# Demander le rapport via l'API et l'enregistrer

$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