Jobs controller
GET /api/jobs/{jobId}
Gets the status of the job with the specified jobId.
- GET /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}
Sample response:
{
"State": "JS_Complete",
"Progress": 100,
"Id": "{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}"
}
Counterpart SOAP method: WebService.GetJobStateInfo.
GET /api/jobs/{jobId}/result
Gets the result of the successfully completed ask with the specified jobId.
- GET /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}/result /* get the object representing the job result */
- GET /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}/result?exclude=FileContents /* get the object representing the job result but do not get the contents of the files */
- GET /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}/result?locale=de-DE /* get the object representing the job result with strings in German */ (FineReader Server 14 R2 and later)
Note. This method can only be called for jobs having the JS_Complete status.
Counterpart SOAP method: WebService.GetJobResultEx.
GET /api/jobs/{jobId}/result/outputDocuments/{outputDocumentId}/files/{fileIndex}
This endpoint lets you download individual files from processed jobs in application/octet-stream format in order to avoid passing large files as Base64 strings.
Before using this endpoint, execute a request that finds out the IDs of the output documents:
GET /api/jobs/{jobId}/result?exclude=FileContents
Sample request for downloading the first file of the output document with ID = 2:
GET /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}/result/outputDocuments/2/fileIndex/0
There is no counterpart SOAP method.
GET /api/jobs/{jobId}/result/outputDocuments/{outputDocumentId}/files (FineReader Server 14 R2 and later)
This endpoint lets you download all the files of an output document in a single ZIP archive.
GET /api/jobs/{jobId}/result/outputDocuments/2/files
There is no counterpart SOAP method.
GET /api/jobs/{jobId}/result/files (FineReader Server 14 R2 and later)
This endpoint lets you download all the files of all the output documents in a single ZIP archive.
- GET /api/jobs/{jobId}/result/files
- GET /api/jobs/{jobId}/result/files?exclude=NotConverted,Failed /* exclude files of failed documents and files of documents moved to the output folder without conversion */
There is no counterpart SOAP method.
DELETE /api/jobs/{jobId}
Deletes the job with the specified jobId from the server (together with the processing results):
- DELETE /api/jobs/{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}
This method can be used to cancel a job or to free up resources when you no longer need the processing results.
Important! For optimum performance, execute this request after processing and getting the job results.
Counterpart SOAP method: WebService.DeleteJob.
GET /api/jobs?jobId={jobId} (FineReader Server 14 R2 and later)
Lets you get the current state and percent completed for the specified jobs by their IDs.
jobId - job IDs, separated by commas
- GET /api/jobs?jobId={9D1AA073-166F-4ECE-AA8E-2DB9E03907A6},{952B9269-C910-4BE3-BBAA-B1889B38E188}
Sample response:
[
{
"State": "JS_Complete",
"Progress": 100,
"Id": "{9D1AA073-166F-4ECE-AA8E-2DB9E03907A6}"
},
{
"State": "JS_NoSuchJob",
"Progress": 0,
"Id": "{952B9269-C910-4BE3-BBAA-B1889B38E188}"
},
]
Counterpart SOAP method: WebService.GetJobStateInfos.
DELETE /api/jobs?jobId={jobId} (FineReader Server 14 R2 and later)
This method completely deletes the specified jobs.
jobId - job IDs, separated by commas
- DELETE /api/jobs?jobId={9D1AA073-166F-4ECE-AA8E-2DB9E03907A6},{952B9269-C910-4BE3-BBAA-B1889B38E188}
Counterpart SOAP method: WebService.DeleteJobs.
26.03.2024 13:49:49