POST/paperon/projects/{projectId}/files

PaperOn にファイルをアップロードするためのアップロード URL を生成する。

注意
PaperOn へのファイルアップロードは、必ず以下の 2 つの手順を順番に完了する必要がある。
手順が完了しない場合、ファイルは未完了の状態でシステムに残る。

  1. ファイルアップロード / ダウンロード を参考に、取得した uploadUrl にファイルを送信する。
  2. アップロードの完了後、fileId を使用して PaperOn ファイルの OCR 処理 を呼び出す。

Authorization

oauth2

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

Scope

paperon

HTTP Request

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

Path Parameters

ParameterTypeDescription
projectId string 

プロジェクト ID


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

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

ContentType


required
default : application/json
example : application/json 

Request Body

ファイルアップロード URL 取得リクエスト

PropertyTypeDescription
fileName string 

アップロードするファイル名。
ファイル形式は拡張子により識別される。
JPG、JPEG、PDF、PNG、TIFF に対応する。


required
example : invoice.pdf 
fileSize integer 

ファイルサイズ (Bytes)
最大で 20MBytes まで対応


required
minimum : 1
maximum : 20971520
example : 204800 

Request Example

example

1{2  "fileName": "invoice.pdf",3  "fileSize": 2048004}

Response

HTTP 200

OK

PropertyTypeDescription
fileId string 

ファイル ID。
OCR 処理の開始やファイル情報の取得に使用する。


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

ファイルアップロード URL


required
format : uri 

Response Example

example

1{2  "fileId": "550e8400-e29b-41d4-a716-446655440000",3  "uploadUrl": "https://storage.worksmobile.com/k1/paperon/r/..."4}