The new, modern way to OCR your documents.
Status: Preview |
Tier: Standard |
Version: 1.0 |
Name |
Summary |
Download a job |
|
Complete a job |
|
Get all jobs |
|
CreateJobWithFile (string filename, [Optional]string metadata, string filedata) |
Create a job with a file |
Create a job without a file |
|
Retrieve a job |
|
UpdateJobWithFile (string filename, string jobId, [Optional]string metadata, string filedata) |
Update an existing job with a file |
Delete a job |
|
Retrieve a license |
Name |
Summary |
Name |
Summary |
|
|
|
Summary: Download a job
Description: Downloads an available job's processed file.
Syntax:
ElasticOCR.DownloadJob (string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
jobId |
string(uuid) (Job Id) |
Unique Id of an ElasticOCR job |
True |
Returns:
Type:string(binary)
Summary: File Content
Description: The content of the file
Summary: Complete a job
Description: Marks a job as complete after successful retrieval of the processed file.
Syntax:
ElasticOCR.CompleteJob (string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
jobId |
string(uuid) (Job Id) |
Unique Id of an ElasticOCR job |
True |
Returns:
Type:JobResponse
Summary: Get all jobs
Description: Retrieve all jobs and their current statuses. By default, a maximum of 1,000 jobs are returned.
Syntax:
ElasticOCR.GetJobs ()
Returns:
Type:array of (JobResponse)
Summary: Create a job with a file
Description: Create an ElasticOCR job for a supplied binary file.
Syntax:
ElasticOCR.CreateJobWithFile (string filename, [Optional]string metadata, string filedata)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
filename |
string (Filename) |
Filename of the file supplied for an ElasticOCR job |
True |
|
metadata |
string (Metadata) |
Job specific metadata to be stored with the ElasticOCR job |
False |
|
filedata |
string(binary)
|
|
True |
Returns:
Type:JobResponse
Summary: Create a job without a file
Description: Create an ElasticOCR job without supplying a file; supply a file later using [PUT] /v{version}/jobs/{jobId}.
Syntax:
ElasticOCR.CreateJobWithoutFile ([Optional]string metadata)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
metadata |
string (Metadata) |
Job specific metadata to be stored with the ElasticOCR job |
False |
Returns:
Type:JobResponse
Summary: Retrieve a job
Description: Retrieve a specific job.
Syntax:
ElasticOCR.GetJob (string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
jobId |
string(uuid) (Job Id) |
Unique Id of an ElasticOCR job |
True |
Returns:
Type:JobResponse
Summary: Update an existing job with a file
Description: Add a file to an existing ElasticOCR job. Only jobs with a status of Pending may be updated.
Syntax:
ElasticOCR.UpdateJobWithFile (string filename, string jobId, [Optional]string metadata, string filedata)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
filename |
string (Filename) |
Filename of the file supplied for an ElasticOCR job |
True |
|
jobId |
string(uuid) (Job Id) |
Unique Id of an ElasticOCR job |
True |
|
metadata |
string (Metadata) |
Job specific metadata to be stored with the ElasticOCR job |
False |
|
filedata |
string(binary)
|
|
True |
Returns:
Type:JobResponse
Summary: Delete a job
Description: Delete an ElasticOCR job before it begins processing. Only jobs with a status of Pending or Uploaded may be deleted.
Syntax:
ElasticOCR.DeleteJob (string jobId)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
jobId |
string(uuid) (Job Id) |
Unique Id of an ElasticOCR job |
True |
Returns:
Summary: Retrieve a license
Description: Validate a license and identify the associated processing region.
Syntax:
ElasticOCR.GetLicense ()
Returns:
Type:LicenseResponse
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string(uuid) Job Id |
The unique Id of the ElasticOCR job. |
licenseId |
string(uuid) License Id |
The License Id associated with the ElasticOCR job. |
appId |
string(uuid) App Id |
The App Id associated with the ElasticOCR job. |
processingRegion |
string Processing Region |
The processing region associated with the ElasticOCR job. |
status |
string Status |
The current status of the ElasticOCR job. |
filename |
string Filename |
The name of the file associated with the ElasticOCR job. |
createdDate |
string(date-time) Created Date |
The date & time the ElasticOCR job was created. |
availableDate |
string(date-time) Available Date |
The date & time the ElasticOCR job became available for retrieval. |
downloadUrl |
string Download URL |
The unique URL to retrieve the processed document. |
downloadUrlExpires |
string(date-time) Download URL Expires |
The date & time that the temporary download URL expires. |
completedDate |
string(date-time) Completed Date |
The date & time the ElasticOCR job was completed. |
metadata |
Metadata |
Custom JSON metadata supplied for the job. |
Summary: Metadata
Description: Custom JSON metadata supplied for the job.
Properties:
Name |
Type |
Summary |
Summary:
Description:
Properties:
Name |
Type |
Summary |
id |
string(uuid) License Id |
The License Id of the associated ElasticOCR subscription. |
appId |
string(uuid) App Id |
The Id of a valid app within the ElasticOCR subscription. |
type |
string Type |
The license type configured for the associated ElasticOCR subscription. Values: [Development, Trial, Tier1, Tier2, Tier3] |
processingRegion |
string Processing Region |
The country prefix configured for the associated ElasticOCR subscription. |
enabled |
boolean Enabled |
The enabled state of the associated ElasticOCR app. |