ABBYY FineReader Server
  1. result
ABBYY FineReader Server
  • Wefile (信天邮科技)
  • 工作流(workflows)
    • {workflow Name}
      • 输入(input)
        • 创建一个单文件的任务(Creates a new job from the specified file.)
        • 创建一个多文件任务(Creates a new job from the specified files.)
        • 通过配置单创建任务(Creates a new job from the specified ticket.)
        • 通过配置单创建多文件任务,可支持formdata(Creates a new job from files and (optionally) a ticket, supplied as multipart/form-data.)
      • 返回一个工作流的信息(Returns a workflow.)
      • 返回一个工作流的配置单(Returns a ticket for a workflow.)
    • 返回可用的工作流列表(Returns a list of available workflows)
      GET
  • 任务(jobs)
    • {job Id}
      • result
        • files
          • 通过zip文件返回文件内容(Returns the contents of all output files of the job as a ZIP archive.)
          • 把输出文件通过zip文件发送到email(Sends the contents of all output files of the job as a ZIP archive by e-mail.)
        • output Documents/{output Document Id}/files
          • {file Index}
            • 返回输出文件中的单个文件的内容(Returns the contents of one output file of the output document.)
            • 发送输出文件中单个文件到指定email(Sends the contents of one output file of the output document by e-mail.
          • 返回zip中所有文件的内容(Returns the contents of all output files of the output document as a ZIP archive.)
          • 把zip包中的所有文件内容通过email发送(Sends the contents of all output files of the output document as a ZIP archive by e-mail.)
        • 返回任务输出结果(Returns the result of a job.)
          GET
      • 返回任务状态信息(Returns the state of a job.)
        GET
      • 删除任务(Deletes a job.)
        DELETE
    • 返回多个任务的状态(Returns the states of multiple jobs.)
      GET
    • 删除多个任务(Deletes multiple jobs.)
      DELETE
  • 服务器(server)
    • 许可(licenses)
      • 返回license列表(Returns a list of available licenses.)
      • 返回当前license(Returns the current license.)
      • 返回单个license信息(Returns a license.)
    • 队列(queue)
      • 返回服务器工作队列信息(Returns a server job queue.)
      • 返回工作流中的任务队列(Returns a workflow job queue.)
    • 语言(languages)
      • 返回可识别语言列表(Returns a list of available recognition languages for all workflows).
      • 返回某个工作流中可识别的语言列表(Returns a list of available recognition languages for a specified workflow.)
    • 统计分析(statistics)
      • 返回服务器任务统计(Returns a server statistics.)
      • 返回工作流的任务统计(Returns a workflow statistics.)
    • 工作站(stations)
      • 返回单个工作站列表(Returns a list of processing stations.)
      • 返回单个处理工作站信息(Returns a processing station.)
    • 返回部分服务器任务日志(Returns a portion of the server job log.)
      GET
    • 返回服务器任务的统计信息(Returns the statistics of the server jobs.)
      GET
  • 输出格式(output Formats)
    • 返回可输出文件列表(Returns a list of available output formats with default settings.)
      GET
    • 返回单个输出文件格式信息(Returns an output format with default settings.)
      GET
  1. result

返回任务输出结果(Returns the result of a job.)

GET
/api/jobs/{{jobID}}/result

请求参数

Header 参数
Accept
string 
必需
示例值:
application/json

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://frstrial.wefile.com/FineReaderServer14//api/jobs/{{jobID}}/result' \
--header 'Accept: application/json'

返回响应

🟢200The result of a job.
application/json
Body
Priority
string 
必需
IsFailed
boolean 
必需
Name
string 
必需
InputFiles
array [object {7}] 
必需
FileData
object 
必需
OutputDocuments
array [object {5}] 
必需
Messages
array [object {3}] 
必需
Statistics
object 
必需
Attributes
object 
必需
Pages
array [object {8}] 
必需
Id
string 
必需
JobDocuments
array [object {9}] 
必需
IsFailed
boolean 
必需
OutputDocuments
array [object {5}] 
必需
Messages
array [object {3}] 
必需
Statistics
object 
必需
Attributes
object 
必需
CustomText
string 
必需
BarcodeText
string 
必需
PagePositions
array [object {2}] 
必需
Name
string 
必需
PreprocessingParams
object 
必需
Deskew
boolean 
必需
RemoveTexture
boolean 
必需
RemoveGarbage
boolean 
必需
CorrectResolution
boolean 
必需
StraightenLines
boolean 
必需
SplitDualPages
boolean 
必需
ConvertToBWFormat
boolean 
必需
RotationType
string 
必需
PdfMode
string 
必需
DontModifyDocumentsWithDigitalSignature
boolean 
必需
DiscardJobWithDocumentsWithDigitalSignature
boolean 
必需
KeepAnnotationsInPdf
boolean 
必需
RecognitionParams
object 
必需
LookForBarcodes
boolean 
必需
TextTypes
string 
必需
RecognitionQuality
string 
必需
RecognitionMode
string 
必需
TextExtractionMode
boolean 
必需
ProhibitHiddenTextDetection
boolean 
必需
ProhibitTableDetection
boolean 
必需
ProhibitPictureDetection
boolean 
必需
Languages
array[string]
必需
ExportParams
object 
必需
SeparationMethod
string 
必需
BarcodeType
string 
必需
BarcodeRegExp
string 
必需
Formats
array [object {2}] 
必需
ResultLocationPath
string 
必需
UserProperty
string 
必需
Messages
array [object {3}] 
必需
Type
string 
必需
Code
integer 
必需
UnicodeStr
string 
必需
Statistics
object 
必需
PagesArea
integer 
必需
TotalCharacters
integer 
必需
UncertainCharacters
integer 
必需
VerificationUserName
string 
必需
IndexingUserName
string 
必需
VerificationUserNameRestrictions
array[string]
必需
IndexingUserNameRestrictions
array[string]
必需
Id
string 
必需
示例
{
  "Priority": "P_Low",
  "IsFailed": true,
  "Name": "commodo incididunt",
  "InputFiles": [
    {
      "FileData": {
        "FileContents": "magna adipisicing eiusmod quis",
        "FileName": "ullamco aliqua",
        "OpenPassword": "consequat occaecat ut ipsum",
        "OwnerPassword": "in nisi nulla",
        "LocationPath": "sunt dolor"
      },
      "OutputDocuments": [
        {
          "FileFormat": "OFF_XLSX",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "culpa in elit",
          "OutputLocation": "officia",
          "Id": "Excepteur"
        },
        {
          "FileFormat": "OFF_RTF",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "ut aliquip aute dolore ullamco",
          "OutputLocation": "culpa deserunt",
          "Id": "irure anim deserunt officia"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Error",
          "Code": -20292565,
          "UnicodeStr": "in quis"
        },
        {
          "Type": "JMT_Error",
          "Code": 30307878,
          "UnicodeStr": "consectetur laborum dolore al"
        }
      ],
      "Statistics": {
        "PagesArea": -95557416,
        "TotalCharacters": -50178393,
        "UncertainCharacters": 64085342
      },
      "Attributes": {
        "SkipManualIndexing": true,
        "DocumentType": "mollit est",
        "Items": [
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      "Pages": [
        {
          "Number": -84797822,
          "RotationType": "Clockwise",
          "SkewAngle": -64087384.13173229,
          "Id": "culpa elit voluptate",
          "Messages": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "Statistics": {
            "PagesArea": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "TotalCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "UncertainCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "CustomText": "consequat",
          "BarcodeText": "sunt exercitation"
        },
        {
          "Number": 20024023,
          "RotationType": "Unknown",
          "SkewAngle": -10600877.421591684,
          "Id": "dolor ullamco in",
          "Messages": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "Statistics": {
            "PagesArea": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "TotalCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "UncertainCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "CustomText": "laboris commodo Lorem eu veniam",
          "BarcodeText": "e"
        }
      ],
      "Id": "deserunt"
    },
    {
      "FileData": {
        "FileContents": "enim irure",
        "FileName": "quis id dolore non",
        "OpenPassword": "minim",
        "OwnerPassword": "eu culpa Lorem",
        "LocationPath": "esse Ut aliquip irure"
      },
      "OutputDocuments": [
        {
          "FileFormat": "OFF_PDFA",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "aliquip qui",
          "OutputLocation": "cupidatat in ",
          "Id": "reprehenderit quis nisi id elit"
        },
        {
          "FileFormat": "OFF_NoConversion",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "esse mollit elit",
          "OutputLocation": "commodo",
          "Id": "esse et nisi"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Warning",
          "Code": 68243218,
          "UnicodeStr": "consectetur tempor sed cillum irure"
        },
        {
          "Type": "JMT_Information",
          "Code": -93692443,
          "UnicodeStr": "ea consequat adipisicing"
        }
      ],
      "Statistics": {
        "PagesArea": 796335,
        "TotalCharacters": 27997547,
        "UncertainCharacters": 93195390
      },
      "Attributes": {
        "SkipManualIndexing": false,
        "DocumentType": "voluptate",
        "Items": [
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      "Pages": [
        {
          "Number": -9518217,
          "RotationType": "Counterclockwise",
          "SkewAngle": -73295860.80034383,
          "Id": "occaecat cupidatat Excepteur sint nisi",
          "Messages": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "Statistics": {
            "PagesArea": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "TotalCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "UncertainCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "CustomText": "enim mollit",
          "BarcodeText": "et irure laboris"
        },
        {
          "Number": 5287405,
          "RotationType": "Counterclockwise",
          "SkewAngle": 37202429.922908485,
          "Id": "eu magna",
          "Messages": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "Statistics": {
            "PagesArea": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "TotalCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "UncertainCharacters": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          "CustomText": "Duis mollit ut labore",
          "BarcodeText": "fugiat officia Duis"
        }
      ],
      "Id": "sint Lorem incididunt pariatur esse"
    }
  ],
  "JobDocuments": [
    {
      "IsFailed": true,
      "OutputDocuments": [
        {
          "FileFormat": "OFF_XML",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "eiusmod commodo dolore laboris reprehenderit",
          "OutputLocation": "amet irure nisi dolore sunt",
          "Id": "cillum do"
        },
        {
          "FileFormat": "OFF_PNG",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "consequat veniam reprehenderit",
          "OutputLocation": "eu in",
          "Id": "irure est"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Information",
          "Code": -11073936,
          "UnicodeStr": "nulla pariatur in dolore consectetur"
        },
        {
          "Type": "JMT_Error",
          "Code": -14960811,
          "UnicodeStr": "non et"
        }
      ],
      "Statistics": {
        "PagesArea": -84359071,
        "TotalCharacters": -51801992,
        "UncertainCharacters": 57775957
      },
      "Attributes": {
        "SkipManualIndexing": true,
        "DocumentType": "sunt",
        "Items": [
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      "CustomText": "consequat sunt incididunt",
      "BarcodeText": "non eu qui quis",
      "PagePositions": [
        {
          "FileId": "nulla pariatur quis cillum",
          "PageId": "ea quis ullamco"
        },
        {
          "FileId": "culpa in ipsum aute elit",
          "PageId": "elit in est adipisicing"
        }
      ],
      "Name": "amet minim in sed"
    },
    {
      "IsFailed": true,
      "OutputDocuments": [
        {
          "FileFormat": "OFF_MSWord",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "Duis laboris in magna",
          "OutputLocation": "elit ut",
          "Id": "aliquip"
        },
        {
          "FileFormat": "OFF_PDF",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "tempor dolor",
          "OutputLocation": "officia in",
          "Id": "nostrud nisi sit esse"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Information",
          "Code": 55321275,
          "UnicodeStr": "adipisicing incididunt tempor nostrud"
        },
        {
          "Type": "JMT_Information",
          "Code": -51809291,
          "UnicodeStr": "non"
        }
      ],
      "Statistics": {
        "PagesArea": 13360164,
        "TotalCharacters": -87040433,
        "UncertainCharacters": 26793701
      },
      "Attributes": {
        "SkipManualIndexing": false,
        "DocumentType": "minim",
        "Items": [
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          },
          {
            "AttributeType": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "Name": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            "BoundingRect": {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          }
        ]
      },
      "CustomText": "la",
      "BarcodeText": "culpa velit Excepteu",
      "PagePositions": [
        {
          "FileId": "Lorem",
          "PageId": "commodo voluptate aliqua"
        },
        {
          "FileId": "veniam sed aliquip in",
          "PageId": "qui Duis ullamco"
        }
      ],
      "Name": "Duis deserunt"
    }
  ],
  "PreprocessingParams": {
    "Deskew": false,
    "RemoveTexture": false,
    "RemoveGarbage": true,
    "CorrectResolution": false,
    "StraightenLines": false,
    "SplitDualPages": false,
    "ConvertToBWFormat": true,
    "RotationType": "RT_Clockwise",
    "PdfMode": "PM_Auto",
    "DontModifyDocumentsWithDigitalSignature": false,
    "DiscardJobWithDocumentsWithDigitalSignature": false,
    "KeepAnnotationsInPdf": true
  },
  "RecognitionParams": {
    "LookForBarcodes": false,
    "TextTypes": "TT_Gothic",
    "RecognitionQuality": "RQS_Balanced",
    "RecognitionMode": "RM_BarcodesOnly",
    "TextExtractionMode": true,
    "ProhibitHiddenTextDetection": false,
    "ProhibitTableDetection": true,
    "ProhibitPictureDetection": false,
    "Languages": [
      "amet id Lorem incididunt",
      "adipisicing fugiat"
    ]
  },
  "ExportParams": {
    "SeparationMethod": "DSM_ByBarcode",
    "BarcodeType": "IBT_Patch",
    "BarcodeRegExp": "ad aliquip officia Excepteur qui",
    "Formats": [
      {
        "FileFormat": "OFF_PNG",
        "FileFormatId": "Exc"
      },
      {
        "FileFormat": "OFF_MSExcel",
        "FileFormatId": "consequat aute"
      }
    ],
    "ResultLocationPath": "quis eiusmod"
  },
  "UserProperty": "velit minim occaecat",
  "Messages": [
    {
      "Type": "JMT_Information",
      "Code": -74639224,
      "UnicodeStr": "adipisicing ad dolore"
    },
    {
      "Type": "JMT_Error",
      "Code": -50906664,
      "UnicodeStr": "aute dolor consectetur in"
    }
  ],
  "Statistics": {
    "PagesArea": 12051459,
    "TotalCharacters": -53230823,
    "UncertainCharacters": 25482563
  },
  "VerificationUserName": "Ut in",
  "IndexingUserName": "cupidatat et amet est",
  "VerificationUserNameRestrictions": [
    "incididunt cillum pariat",
    "aliquip ut Lorem cillum ea"
  ],
  "IndexingUserNameRestrictions": [
    "est consectetur amet",
    "elit"
  ],
  "Id": "veniam"
}
🟠400Invalid job ID supplied.
🟠404Job not found.
修改于 2024-04-24 10:41:02
上一页
把zip包中的所有文件内容通过email发送(Sends the contents of all output files of the output document as a ZIP archive by e-mail.)
下一页
返回任务状态信息(Returns the state of a job.)
Built with