ABBYY FineReader Server
  1. {workflow Name}
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.）
        GET
      • 返回一个工作流的配置单（Returns a ticket for a workflow.）
        GET
    • 返回可用的工作流列表（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.）
      • 返回任务状态信息（Returns the state of a job.）
      • 删除任务（Deletes a job.）
    • 返回多个任务的状态（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. {workflow Name}

返回一个工作流的信息（Returns a workflow.）

GET
/api/workflows/{{workflowName}}

请求参数

Query 参数
serverLocation
string 
必需
view
string 
必需
示例值:
Full
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/workflows/{{workflowName}}?serverLocation=&view=Full' \
--header 'Accept: application/json'

返回响应

🟢200The workflow.
application/json
Body
WorkflowState
string 
必需
Name
string 
必需
InputFolder
string 
必需
ExceptionsFolder
string 
必需
ExportParams
object 
必需
SeparationMethod
string 
必需
BarcodeType
string 
必需
BarcodeRegExp
string 
必需
Formats
array [object {2}] 
必需
ResultLocationPath
string 
必需
示例
{
  "WorkflowState": "WS_Suspended",
  "Name": "pariatur et minim",
  "InputFolder": "pariatur anim",
  "ExceptionsFolder": "",
  "ExportParams": {
    "SeparationMethod": "DSM_MergeIntoSingleFile",
    "BarcodeType": "IBT_Postnet",
    "BarcodeRegExp": "id ullamco in",
    "Formats": [
      {
        "FileFormat": "OFF_Text",
        "FileFormatId": "proident"
      },
      {
        "FileFormat": "OFF_J2K",
        "FileFormatId": "laborum aliquip elit"
      }
    ],
    "ResultLocationPath": "laborum esse ullamco qui do"
  }
}
🟠404Workflow not found.
修改于 2024-04-24 10:33:15
上一页
通过配置单创建多文件任务，可支持formdata（Creates a new job from files and (optionally) a ticket, supplied as multipart/form-data.）
下一页
返回一个工作流的配置单（Returns a ticket for a workflow.）
Built with