メインコンテンツへスキップ
個別の API 呼び出し（トランザクションの作成、ファイルのアップロード、トランザクションの開始）を使用してドキュメントを処理する一般的なシナリオは、次の手順で構成されます。
  1. 利用可能なすべての Skill の一覧を取得する
  2. 空のトランザクションを作成する
  3. トランザクションで処理するファイル一式を追加する
  4. トランザクションを開始する
  5. トランザクションのステータスを監視する
  6. ソースファイルと結果ファイルをダウンロードする
サーバーへの各リクエストには、認証情報（アクセストークンなど）を含める必要があります。詳細は Authentication を参照してください。

​
利用可能なすべての Skill の一覧を取得する

そのためには、skills リソースに GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/skills
次のコマンドを実行します： Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/skills" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/skills' \
-H 'Authorization: Bearer token'
その結果、アプリケーション インスタンスに追加されたすべての Skill の情報が返されます。

​
空のトランザクションを作成する

transactions リソースに次の POST リクエストを送信します。 
POST https://your-server/api/publicapi/v1/transactions
次のコマンドを実行します： Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"skillId\": \"00000000-0000-0000-0000-000000000001\"
}"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "skillId": "00000000-0000-0000-0000-000000000001"
}'
リクエストの本文に、前の API 呼び出しで返された skillId Parameter を指定します。これにより、作成されたトランザクションの id を含むレスポンスが返されます。

​
トランザクションで処理するファイルセットの追加

重要: 1 つのトランザクションに含められるファイルの最大数は 1000 件です。 ファイルセットの追加方法は次の 2 通りです:

​
トランザクションにファイルを直接追加する

その場合は、POST リクエストを transactions/<transaction-id>/files リソースに送信します。 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/files
リクエストの本文に処理対象のファイルを送信します。ファイルのカスタマイズに使用できる Parameter の詳細は、API Reference を参照してください。次のコマンドを実行します： Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/files" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/files' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'
その結果、追加されたファイルとその識別子の一覧を含むレスポンスが返ってきます。この呼び出しを複数回繰り返すことで、必要な数だけファイルを追加できます。 ファイルのアップロードに関する追加オプション:

​
ドキュメントにファイルを追加する

まず、POST リクエストを transactions/<transaction-id>/documents リソースに送信して、ドキュメントを作成します。 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: application/json" \
-d "{
  \"documents\": [
    {
    }
  ]
}"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: application/json' \
-d '{
  "documents": [
    {
    }
  ]
}'
その結果、Document 識別子を含むレスポンスが返されます。 次に、transactions/<transaction-id>/documents/<document-id>/sourceFiles リソースに POST リクエストを送信して、Document にファイルを追加します。 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles
Windows の場合: 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles" \
-H "accept: */*" \
-H "Authorization: Bearer token" \
-H "Content-Type: multipart/form-data" \
-F "Model={
   \"files\": [
     {
     }
   ]
}" \
-F "Files=@testImage.tif;type=image/tiff"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id/sourceFiles' \
-H 'accept: */*' \
-H 'Authorization: Bearer token' \
-H 'Content-Type: multipart/form-data' \
-F 'Model={
   "files": [
     {
     }
   ]
}' \
-F 'Files=@testImage.tif;type=image/tiff'

​
トランザクションの開始

指定した Skill とファイルでトランザクションを開始するには、transactions/<transaction-id>/start リソースに次の POST リクエストを送信します。 
POST https://your-server/api/publicapi/v1/transactions/transaction-id/start
Windows の場合： 
curl -X POST "https://your-server/api/publicapi/v1/transactions/transaction-id/start" \
-H "accept: */*" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X POST 'https://your-server/api/publicapi/v1/transactions/transaction-id/start' \
-H 'accept: */*' \
-H 'Authorization: Bearer token'

​
トランザクションのステータスを監視する

短いタイムアウトを設定したループでトランザクションのステータス監視を開始するには（1秒より高頻度の確認は推奨しません）、リクエストURIにトランザクション識別子を含めて transactions/<transaction_id> リソースへ GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id
Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id' \
-H 'Authorization: Bearer token'
その結果、トランザクションのステータスを含むレスポンスが返されます。トランザクション処理のステータスは次のいずれかです。
  • New。トランザクションは作成されていますが、まだ処理キューに入っていません。
  • Queued。トランザクションは処理のためにキューに入っています。
  • InProgress。トランザクションは処理中です。
  • Processed。トランザクションは正常に処理完了しました。
  • ProcessedWithWarnings。トランザクションは処理されましたが、警告が発生しました。
  • NotProcessed。エラーのため、トランザクションは処理されませんでした。
  • Deleted。トランザクションはユーザーによって、または保持ポリシーにより自動的に削除されました。
トランザクションのステータスが Processed または ProcessedWithWarnings の場合、手順 6 に進みます。

​
ソースファイルのダウンロード

ドキュメントの識別子を含む一覧を取得するには、transactions/<transaction-id>/documents リソースに GET リクエストを送信し、トランザクションの識別子を指定します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents
Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents" \
-H "Authorization: Bearer token"
Linux の場合： 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents' \
-H 'Authorization: Bearer token'
その結果、このトランザクション内で作成されたドキュメントの一覧が返されます。レスポンスにはこれらのドキュメントの識別子も含まれており、特定のドキュメントの詳細情報を取得する際に必要になる場合があります。 特定のドキュメントに追加されたファイルの一覧を取得するには、transactions/<transaction-id>/documents/<document-id> リソースに GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id
Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id" \
-H "Authorization: Bearer token"
Linux の場合: 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/documents/document-id' \
-H 'Authorization: Bearer token'
その結果、Document に関する情報が返されます。レスポンスには、Document に追加されたファイルの識別子も含まれます。 ソースファイルをダウンロードするには、transactions/<transaction-id>/files/<file-id>/download リソースに GET リクエストを送信します。 
GET https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download
Windows の場合: 
curl -X GET "https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download" \
-H "Authorization: Bearer token"
Linux の場合： 
curl -X GET 'https://your-server/api/publicapi/v1/transactions/transaction-id/files/file-id/download' \
-H 'Authorization: Bearer token'