Server controller (FineReader Server 14 Update 8 and later)
GET /api/server/licenses
Gets a list of the licenses available on the server.
- GET /api/server/licenses /* get full information about the licenses */
- GET /api/server/licenses?view=Summary /* get brief information about the licenses */
Sample response for the last request:
[
{
"Id": "{92312F5A-9A80-498A-B1FF-E6F12F920A58}",
"Type": "Software",
"State": "Current",
"CanExpire": false,
"ExpirationDate": "1601-01-01T00:00:00Z",
"PageCounter": {
"IsUnlimited": true,
"RenewalPeriod": "Never",
"PagesPerPeriod": 0,
"AvailablePages": 0
},
"GothicPageCounter": {
"IsUnlimited": false,
"RenewalPeriod": "Never",
"PagesPerPeriod": 10000,
"AvailablePages": 10000
}
}
]
Counterpart SOAP method: ServerManager.GetLicenses.
GET /api/server/licenses/{licenseId}
Gets information about the license with the specified licenseId:
- GET /api/server/licenses/{92312F5A-9A80-498A-B1FF-E6F12F920A58} /* get full information about the licenses */
- GET /api/server/licenses/{92312F5A-9A80-498A-B1FF-E6F12F920A58}?view=Summary /* get brief information about the licenses */
To get information about the current license, use current for the licenseId.
- GET /api/server/licenses/current
There is no counterpart SOAP method.
GET /api/server/queue
Gets information about a job queue on the server.
- GET /api/server/queue
Returns the total number of jobs and information about the job queues in all the workflows.
- Gets information about all the jobs, not just about the jobs submitted via the API.
- Displays all the workflows, not just the workflows available for processing via the API.
Sample response:
{
"TotalJobCount": 10,
"TotalMaxJobCount": 50,
"WorkflowJobQueues": [
{
"WorkflowName": "Workflow",
"WorkflowInputType": "HotFolder_SharedFolder",
"WorkflowPriority": "P_Normal",
"WorkflowState": "WS_Processing",
"JobCount": 10,
"MaxJobCount": 50
}
]
}
Counterpart SOAP method: ServerManager.GetJobQueue.
GET /api/server/queue/{workflowName}
Gets information about the job queue in a workflow named workflowName.
- GET /api/server/queue/DemoWorkflow
There is no counterpart SOAP method.
GET /api/server/languages (FineReader Server 14 R2 and later)
Returns a list of the recognition languages available on the server with the specified location.
- GET /api/server/languages /* list the recognition languages in the UI language of the server */
- GET /api/server/languages?locale=de-DE /* list the recognition languages in German */
The locale (for example, an IETF BCP 47 language tag — "en-US," "de-DE," "ru-RU," etc.) determines the UI language used to return the recognition language names. This is an optional parameter — you can either pass null or an empty string, in which case the server locale will be used.
An array of Language objects representing the recognition languages available on the server with specified location (serverLocation). The DisplayName property of these objects contains the names if the recognition languages for the specified locale.
Sample response:
[
// ...
{
"IsDisabled": false,
"Category": "CoreLanguage",
"InternalName": "English",
"DisplayName": "Englisch"
},
// ...
{
"IsDisabled": false,
"Category": "CoreLanguage",
"InternalName": "German",
"DisplayName": "Deutsch"
},
// ...
]
Counterpart SOAP method: ServerManager.GetLanguages.
GET /api/server/languages/{workflowName} (FineReader Server 14 R2 and later)
Returns a list of the recognition languages available on the server with the specified location. In addition to the default languages, the list will also contain the user-specified languages that have been set up in the workflow.
- GET /api/server/languages/DemoWorkflow /* list the recognition languages for DemoWorkflow in the UI language of the server */
- GET /api/server/languages/DemoWorkflow?locale=de-DE /* list the recognition languages for DemoWorkflow in German */
Uses the same parameters as GET /api/server/languages.
Counterpart SOAP method: ServerManager.GetWorkflowLanguages.
GET /api/server/statistics (FineReader Server 14 R2 U1)
Returns server statistics for the server with the specified location.
- GET /api/server/statistics /* statistics for the server and all the workflow */
- GET /api/server/statistics?view=Summary /* statistics for the server only */
Samples responses for the first request:
{
"FromDate": "2020-06-16T00:00:00Z",
"TotalProcessedPageCount": 1634,
"TotalProcessedGothicPageCount": 184,
"WorkflowStatistics": [
{
"WorkflowName": "DemoWorkflow",
...
"ProcessedPageCount": 143,
"ProcessedGothicPageCount": 10,
},
...
]
}
Counterpart SOAP method: ServerManager.GetServerStatistics.
GET /api/server/statistics/{workflowName} (FineReader Server 14 R2 U1)
Returns statistics for the specified workflow on the server with the specified location.
- GET /api/server/statistics/DemoWorkflow
Sample response:
{
"WorkflowName": "DemoWorkflow",
...
"FromDate": "2020-06-22T00:00:00Z",
"ProcessedPageCount": 143,
"ProcessedGothicPageCount": 10,
"DuplicateGroupCount": 15,
"DuplicateFileStatistics": {...},
"LargeFileConstraint": 1073741824,
"LargeFileStatistics": {...},
"OutdatedFileConstraint": "2018-06-22T00:00:00Z",
"OutdatedFileStatistics": {...}
}
Counterpart SOAP method: ServerManager.GetWorkflowStatistics.
GET /api/server/stations (FineReader Server 14 R2 U1)
Returns a list of Processing Stations and their states.
- GET /api/server/stations
Sample response:
[
{
"Id": "{22725154-CD01-4967-A600-DF67D52E7A83}",
"Name": "127.0.0.1",
"Location": "127.0.0.1",
"Role": "Preprocessing, Processing",
"State": "Activated",
"IsDisabled": false,
"HasSchedule": false,
"IsWithinSchedule": true,
"CoreCount": 4,
"ProcessCount": 5
}
]
Counterpart SOAP method: ServerManager.GetProcessingStations.
GET /api/server/stations/{stationId} (FineReader Server 14 R2 U1)
Returns the Processing Station with the specified ID on the server with the specified location.
- GET /api/server/stations/{22725154-CD01-4967-A600-DF67D52E7A83}
There is no counterpart SOAP method.
GET /api/server/jobLog (FineReader Server 14 R2 U2 and later)
Returns the job log records that fit match filter settings on the server with the specified location.
Method call samples
- All parameters are optional.
- All parameters can be combined together into a single request.
- All records returned from requests are ordered from most recent to least recent.
General parameters:
- GET /api/server/jobLog /* returns job log records */
- GET /api/server/jobLog?locale=de /* same, except the records are returned in German */
- GET /api/server/jobLog?top=10&skip=20 /* omit the first 20 records and return the next 10 */
Filter parameters:
- GET /api/server/jobLog?state=failed /* records for failed jobs */
- GET /api/server/jobLog?workflowName=DemoWorkflow /* records for DemoWorkflow jobs */
- GET /api/server/jobLog?sinceDate=2020-07-28T10:00:00.000Z&untilDate=2020-07-28T11:00:00.000Z /* records for jobs that were finished between 10:00 AM and 11:00 AM 2020-07-28 (UTC) */
- GET /api/server/jobLog?sinceId=86209&untilId=86211 /* records whose IDs fall within the following interval: [86209, 86211] (please note that these are job log record IDs, NOT the job IDs) */
Returning all records that match a specific filter
Counterpart SOAP method: ServerManager.GetJobLog.
26.03.2024 13:49:49