POST/paperon/projects/{projectId}/files/{fileId}/extract

API により PaperOn プロジェクトにアップロードされたファイルについて、OCR 処理を実行する。
OCR 認識処理は非同期で行われ、処理の状況は PaperOn ファイルの情報取得 の approvalStatus で確認できる。

  • extraction_processing : OCR 読み取り中の状態。この状態のファイルは、ファイルの取得、部分更新、原本ファイルのダウンロード、読み取り結果の取得はできない。
  • new : 新規。ファイルが登録され、OCR 読み取りが完了した状態。
  • extraction_failed : 失敗。(読み取り失敗や読み取り回数の不足)

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

paperon

HTTP Request

POSThttps://www.worksapis.com/v1.0/paperon/projects/{projectId}/files/{fileId}/extract

Path Parameters

ParameterTypeDescription
projectId string 

プロジェクト ID


required
example : 550e8400-e29b-41d4-a716-446655440000 
fileId string 

ファイル ID


required
example : 550e8400-e29b-41d4-a716-446655440000 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 202

Accepted

PropertyTypeDescription
fileId string 

ファイル ID


required
example : 550e8400-e29b-41d4-a716-446655440000 
approvalStatus string 

ファイルステータス

  • extraction_processing : OCR 読み取り中の状態。この状態のファイルは、ファイルの取得、部分更新、原本ファイルのダウンロード、読み取り結果の取得はできません。
  • new : 新規。ファイルが登録され、OCR 読み取りが完了した状態。
  • extraction_failed : 失敗。(読み取り失敗や読み取り回数の不足)
  • pending : 承認申請。ユーザーが読み取り結果を修正し、承認をリクエストした状態。
  • approved : 承認。
  • rejected : 差し戻し。承認リクエストされたファイルについて再確認が求められている状態。
  • completed : 完了。

required
Allowed values : extraction_processing, new, extraction_failed, pending, approved, rejected, completed 
statusUrl string 

OCR 処理状況を取得できる URL
PaperOn ファイルの情報取得 の approvalStatus を確認する


required
example : https://www.worksapis.com/v1.0/paperon/projects/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000
format : uri 

Response Example

example

1{2  "fileId": "550e8400-e29b-41d4-a716-446655440000",3  "approvalStatus": "extraction_processing",4  "statusUrl": "https://www.worksapis.com/v1.0/paperon/projects/550e8400-e29b-41d4-a716-446655440000/files/550e8400-e29b-41d4-a716-446655440000"5}