Download OpenAPI specification:Download
ログインしてsessionIdを取得する
| Accept-Language | string {jp/en} |
| userId | string |
| password | string |
{- "userId": "user@ariseinnovation.co.jp",
- "password": "password"
}{- "data": {
- "userId": "user@ariseinnovation.co.jp",
- "sessionId": "A1B2C3D4F5G6",
- "role": "0"
}, - "message": "OK"
}PDFファイルをアップロード、AIReadを実行する AIRead-API-TokenかsessionIdのどちらかが必須 AIRead-API-Tokenは、AIRead on Cloudの画面から環境設定→API Tokenで生成する
リクエストBodyの上限は全体で133MB（100MB程度のファイルまでアップロード可能）
| user_id required | string OCRを実行させるユーザID名 |
| edition required | string 定義の種類："Item" = ルール指定、"Manual" = 座標指定、"Sorting" = 画像仕分け、"Prebuilt" = 事前構築済みモデル |
| form_id | string AIReadの定義ID名（Edition=Manualの場合は必須、Edition=Itemでform_idがnullの場合はキーワード仕分けをする、Edition=Sortingの場合は未指定、Edition=Prebuiltの場合は"Invoice"、"Receipt"のいずれかを指定） |
| form_group_name | string 仕分けグループ(Edition=Item 及び Manualで省略した場合は最初に登録したグループを使用、Edition=Sortingの場合は未指定) |
| sorting_id | string 画像仕分けの仕分け定義のID(Edition=Sortingの場合は必須、Edition=Item 及び Manualの場合は未指定) |
| teams_id | string OCR結果をダウンロードするチームのID |
required | Array of objects OCRを行う画像ファイルの情報 |
{- "form_group_name": "GroupItem",
- "edition": "Item",
- "user_id": "user@ariseinnovation.co.jp",
- "teams_id": "1",
- "inputFiles": [
- {
- "inputFileName": "Invoice_sample_1page.pdf",
- "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBdWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
}, - {
- "inputFileName": "test_sample_1.page.pdf",
- "file": "TWFuIGlzIGRpc3Rpbmd1aXNoZWQsIG5vdCBvbmx5IGJ5IGhpcyByZWFzb24sIGJ1dCBieSB0aGlzIHNpbmd1bGFyIHBdWVkIGFuZCBpbmRlZmF0aWdhYmxlIGdlbmVyYXRpb24gb2Yga25vd2xlZGdlLCBleGNlZWRzIHRoZSBzaG9ydCB2ZWhlbWVuY2Ugb2YgYW55IGNhcm5hbCBwbGVhc3VyZS4="
}
]
}{- "data": [
- {
- "jobid": "2000",
- "filename": "sample.pdf"
}
], - "message": "OK"
}jobidで指定した帳票の読取結果を取得する AIRead-API-TokenかsessionIdのどちらかが必須 ・AIRead-API-Tokenの場合、読取実行をしたユーザとテナントIDが一致していれば取得可能 ・sessionIdの場合、読取実行をしたユーザIDと一致してれば取得可能
| jobid required | string 読取実行を識別するためのID、/rest/execute-aireadのレスポンスに含まれるjobid |
{- "data": [
- {
- "id": "12345",
- "jobid": "1111",
- "inputfile_name": "sample.pdf",
- "page_no": "1",
- "tenant_id": "10",
- "user_id": "user@ariseinnovation.co.jp",
- "status": "2",
- "form_edition": "Manual",
- "form_code": "50",
- "form_id": "Ariseinnovation",
- "form_group_code": "3",
- "form_group_name": "Invoice",
- "created_at": "2021-04-14 14:28:07 +9:00",
- "updated_at": "2021-04-14 14:29:11 +9:00",
- "items": [
- {
- "itemName": "unitprice",
- "page": "0",
- "gid": "5",
- "rid": "5",
- "value": "1000",
- "conf": "97",
- "x": "1816",
- "y": "1285",
- "h": "28",
- "w": "142",
- "tableName": "detail",
- "keyword": "単価"
}
]
}
], - "page_total": "1"
}検索条件で指定した帳票の読取結果の一覧を取得する AIRead-API-TokenかsessionIdのどちらかが必須 ・AIRead-API-Tokenの場合、読取実行時に指定したチームとテナントに所属するチームが一致していれば取得可能 ・sessionIdの場合、読取実行時に指定したチームとユーザが所属するチームが一致してれば取得可能
| inputfile_name | string [検索条件]ファイル名で検索（部分一致） |
| status_processing | string Default: "0" [検索条件]ステータス「処理中」を検索対象とするか（0：非対象、1：対象） |
| status_error | string Default: "0" [検索条件]ステータス「読取エラー」を検索対象とするか（0：非対象、1：対象） |
| status_finished | string Default: "0" [検索条件]ステータス「読取完了」を検索対象とするか（0：非対象、1：対象） |
| status_updated | string Default: "0" [検索条件]ステータス「更新済」を検索対象とするか（0：非対象、1：対象） |
| status_downloaded | string Default: "0" [検索条件]ステータス「ダウンロード済」を検索対象とするか（0：非対象、1：対象） |
| created_from_time | string <date> Example: created_from_time=2021-04-01 [検索条件]登録日時の開始日 |
| created_to_time | string <date> Example: created_to_time=2021-04-30 [検索条件]登録日時の終了日 |
| form_group_name | string [検索条件]フォームグループ名 |
| form_id | string [検索条件]フォームID |
| teams_id | string [検索条件]チームID |
| page | integer Default: "1" 帳票データの件数をsizeで分割したページ番号 |
| size | integer <= 1000 Default: "100" 一度に取得する帳票データの件数 |
{- "data": {
- "paging": {
- "total_page": 10,
- "total_record": 95,
- "page": 1,
- "size": 10
}, - "elements": [
- {
- "id": "12345",
- "jobid": "1111",
- "inputfile_name": "sample.pdf",
- "page_no": "1",
- "status": "2",
- "form_edition": "Manual",
- "form_code": "50",
- "form_id": "Ariseinnovation",
- "form_group_code": "3",
- "form_group_name": "Invoice",
- "teams_id": "1",
- "created_at": "2021-04-14 14:28:07 +9:00",
- "updated_at": "2021-04-14 14:29:11 +9:00"
}
]
}, - "message": "OK"
}検索条件で指定した帳票定義の一覧を取得する AIRead-API-TokenかsessionIdのどちらかが必須 sessionIdの場合、ユーザが所属するテナントの帳票定義を取得可能
| form_edition | string [検索条件]定義のEdition(Item/Manual) |
| form_group_name | string [検索条件]フォームグループ名 |
| form_id | string [検索条件]フォームID |
| config_name | string [検索条件]定義名 |
{- "data": {
- "tenant_id": "10",
- "forms": [
- {
- "form_edition": "Manual",
- "form_group_code": "3",
- "form_group_name": "Invoice",
- "form_code": "50",
- "form_id": "Ariseinnovation",
- "config_name": "Ariseinnovation",
- "user_id": "user@ariseinnovation.co.jp",
- "created_at": "2021-04-14 14:28:07 +9:00",
- "updated_at": "2021-04-14 14:29:11 +9:00"
}
]
}, - "message": "OK"
}jobidで指定したアップロード帳票のPDFを圧縮したZIPファイルを取得する jobidはカンマ区切りで複数指定も可能 AIRead-API-TokenかsessionIdのどちらかが必須 ・AIRead-API-Tokenの場合、読取実行時に指定したチームとテナントに所属するチームが一致していれば取得可能 ・sessionIdの場合、読取実行時に指定したチームとユーザが所属するチームが一致してれば取得可能
| job_id_list | string 取得する帳票のjobid (カンマ区切りで複数指定) |
{- "message": "Jsonフォーマットエラー"
}