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 ticket for a workflow.)

GET
/api/workflows/{{workflowName}}/ticket

请求参数

Query 参数
serverLocation
string 
必需
The IP address or domain name of the machine where ABBYY FineReader Server 14 Server Manager is installed.
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}}/ticket?serverLocation=' \
--header 'Accept: application/json'

返回响应

🟢200The ticket.
application/json
Body
Priority
string 
必需
IsTemporary
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 
必需
ExportParams
object 
必需
SeparationMethod
string 
必需
BarcodeType
string 
必需
BarcodeRegExp
string 
必需
Formats
array [object {2}] 
必需
ResultLocationPath
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]
必需
UserProperty
string 
必需
Attributes
object 
必需
SkipManualIndexing
boolean 
必需
DocumentType
string 
必需
Items
array [object {3}] 
必需
VerificationUserNameRestrictions
array[string]
必需
IndexingUserNameRestrictions
array[string]
必需
示例
{
  "Priority": "P_AboveNormal",
  "IsTemporary": true,
  "Name": "sit deserunt laboris sint",
  "InputFiles": [
    {
      "FileData": {
        "FileContents": "esse eu voluptate",
        "FileName": "adipisicing veniam eu",
        "OpenPassword": "non labore magna",
        "OwnerPassword": "sunt sit sint sed",
        "LocationPath": "mollit eu irure"
      },
      "OutputDocuments": [
        {
          "FileFormat": "OFF_JBIG2",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "pariatur reprehenderit",
          "OutputLocation": "cupidatat nisi esse fugia",
          "Id": "nostrud reprehenderit consequat"
        },
        {
          "FileFormat": "OFF_MSExcel",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "labore reprehenderit",
          "OutputLocation": "labore in laboris Lorem",
          "Id": "pariatur cupidatat non"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Warning",
          "Code": 58838963,
          "UnicodeStr": "incididunt sed sunt sit"
        },
        {
          "Type": "JMT_Warning",
          "Code": -11859581,
          "UnicodeStr": "irure ut quis"
        }
      ],
      "Statistics": {
        "PagesArea": 19705756,
        "TotalCharacters": 23744957,
        "UncertainCharacters": 45990225
      },
      "Attributes": {
        "SkipManualIndexing": true,
        "DocumentType": "elit dolore laboru",
        "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": 32614086,
          "RotationType": "Unknown",
          "SkewAngle": 62332676.205583036,
          "Id": "ipsum dolore s",
          "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": "esse in veniam aliqua",
          "BarcodeText": "proident"
        },
        {
          "Number": 42471812,
          "RotationType": "Unknown",
          "SkewAngle": -49557174.28127917,
          "Id": "veniam 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": "nulla ",
          "BarcodeText": "officia ad est in"
        }
      ],
      "Id": "sed non officia"
    },
    {
      "FileData": {
        "FileContents": "sed laboris tempor ea",
        "FileName": "eiusmod",
        "OpenPassword": "dolore non ad",
        "OwnerPassword": "sunt in",
        "LocationPath": "laborum in occaecat"
      },
      "OutputDocuments": [
        {
          "FileFormat": "OFF_PDFE",
          "Files": [
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            },
            {
              "value": "<Error: Too many levels of nesting to fake this schema>"
            }
          ],
          "FileFormatId": "nisi velit",
          "OutputLocation": "Ut velit",
          "Id": "tempor ad"
        },
        {
          "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": "non aliquip",
          "OutputLocation": "mollit laboris si",
          "Id": "tempor occaecat"
        }
      ],
      "Messages": [
        {
          "Type": "JMT_Error",
          "Code": -55510729,
          "UnicodeStr": "qui in mollit cillum pariatur"
        },
        {
          "Type": "JMT_Information",
          "Code": -61239682,
          "UnicodeStr": "consequat voluptate commodo"
        }
      ],
      "Statistics": {
        "PagesArea": -63031202,
        "TotalCharacters": 69919697,
        "UncertainCharacters": -26797434
      },
      "Attributes": {
        "SkipManualIndexing": false,
        "DocumentType": "est elit tempor",
        "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": 18433418,
          "RotationType": "Unknown",
          "SkewAngle": 75092632.42955795,
          "Id": "amet mollit",
          "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": "l",
          "BarcodeText": "irure esse proident incididunt non"
        },
        {
          "Number": -43903166,
          "RotationType": "NoRotation",
          "SkewAngle": 86980764.56755573,
          "Id": "ad exercitation in quis aliqua",
          "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": "sit eu aut",
          "BarcodeText": "nisi exercitation do ut"
        }
      ],
      "Id": "ex"
    }
  ],
  "ExportParams": {
    "SeparationMethod": "DSM_ByBlankPages",
    "BarcodeType": "IBT_Code39",
    "BarcodeRegExp": "do minim nostrud",
    "Formats": [
      {
        "FileFormat": "OFF_PPTX",
        "FileFormatId": "dolor nostrud"
      },
      {
        "FileFormat": "OFF_MSExcel",
        "FileFormatId": "mollit ullamco aliquip"
      }
    ],
    "ResultLocationPath": "esse Excepteur sint commodo"
  },
  "PreprocessingParams": {
    "Deskew": false,
    "RemoveTexture": false,
    "RemoveGarbage": false,
    "CorrectResolution": false,
    "StraightenLines": false,
    "SplitDualPages": false,
    "ConvertToBWFormat": false,
    "RotationType": "RT_Counterclockwise",
    "PdfMode": "PM_Auto",
    "DontModifyDocumentsWithDigitalSignature": true,
    "DiscardJobWithDocumentsWithDigitalSignature": false,
    "KeepAnnotationsInPdf": true
  },
  "RecognitionParams": {
    "LookForBarcodes": false,
    "TextTypes": "TT_OCR_B",
    "RecognitionQuality": "RQS_Balanced",
    "RecognitionMode": "RM_FullPage",
    "TextExtractionMode": false,
    "ProhibitHiddenTextDetection": false,
    "ProhibitTableDetection": true,
    "ProhibitPictureDetection": false,
    "Languages": [
      "nostr",
      "sint in dolore ad"
    ]
  },
  "UserProperty": "eu",
  "Attributes": {
    "SkipManualIndexing": false,
    "DocumentType": "esse in culpa ea Duis",
    "Items": [
      {
        "AttributeType": "AT_RegularExpression",
        "Name": "esse si",
        "BoundingRect": {
          "Left": 16293604,
          "Top": 78166832,
          "Right": 15348175,
          "Bottom": 40132767
        }
      },
      {
        "AttributeType": "AT_Enumeration",
        "Name": "dolore ut mollit",
        "BoundingRect": {
          "Left": -87520853,
          "Top": 55068502,
          "Right": 67926715,
          "Bottom": -94946997
        }
      }
    ]
  },
  "VerificationUserNameRestrictions": [
    "non esse eiusmod nisi consequat",
    "esse ut"
  ],
  "IndexingUserNameRestrictions": [
    "proident nisi",
    "in sint id cillum"
  ]
}
修改于 2024-04-24 10:33:36
上一页
返回一个工作流的信息(Returns a workflow.)
下一页
返回可用的工作流列表(Returns a list of available workflows)
Built with